Async Tasks

PreviousAPI Registration NextBusinessRule

get

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

GET /ux/common/async_tasks/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "status": "text",
  "last_heartbeat_tooltip": "text",
  "last_heartbeat_time": "text",
  "async_task_status": "text",
  "conv_task_name": "text",
  "task_id": "text",
  "organization": "text",
  "task_name": "text",
  "worker_name": "text",
  "worker_ip": "text",
  "worker_hostname": "text",
  "description": "text",
  "queue_name": "text",
  "last_heart_beat": "2025-06-07T13:56:14.337Z",
  "is_enabled": true,
  "task_path": "text",
  "task_trigger_data": "text",
  "is_deleted": true
}

delete

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

delete

DELETE /ux/common/async_tasks/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

GET /ux/common/async_tasks/disable_task/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "status": "text",
  "last_heartbeat_tooltip": "text",
  "last_heartbeat_time": "text",
  "async_task_status": "text",
  "conv_task_name": "text",
  "task_id": "text",
  "organization": "text",
  "task_name": "text",
  "worker_name": "text",
  "worker_ip": "text",
  "worker_hostname": "text",
  "description": "text",
  "queue_name": "text",
  "last_heart_beat": "2025-06-07T13:56:14.337Z",
  "is_enabled": true,
  "task_path": "text",
  "task_trigger_data": "text",
  "is_deleted": true
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

GET /ux/common/async_tasks/enable_task/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "status": "text",
  "last_heartbeat_tooltip": "text",
  "last_heartbeat_time": "text",
  "async_task_status": "text",
  "conv_task_name": "text",
  "task_id": "text",
  "organization": "text",
  "task_name": "text",
  "worker_name": "text",
  "worker_ip": "text",
  "worker_hostname": "text",
  "description": "text",
  "queue_name": "text",
  "last_heart_beat": "2025-06-07T13:56:14.337Z",
  "is_enabled": true,
  "task_path": "text",
  "task_trigger_data": "text",
  "is_deleted": true
}

Gets a list of async tasks

get

This endpoint is used to fetch all the async tasks in the current organization

Authorizations

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

get

GET /ux/common/async_tasks/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "status": "text",
    "last_heartbeat_tooltip": "text",
    "last_heartbeat_time": "text",
    "async_task_status": "text",
    "conv_task_name": "text",
    "task_id": "text",
    "organization": "text",
    "task_name": "text",
    "worker_name": "text",
    "worker_ip": "text",
    "worker_hostname": "text",
    "description": "text",
    "queue_name": "text",
    "last_heart_beat": "2025-06-07T13:56:14.337Z",
    "is_enabled": true,
    "task_path": "text",
    "task_trigger_data": "text",
    "is_deleted": true
  }
]

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

statusstringRead-onlyRequired

last_heartbeat_tooltipstringRead-onlyRequired

last_heartbeat_timestringRead-onlyRequired

async_task_statusstringRead-onlyRequired

conv_task_namestringRead-onlyRequired

task_idstring · max: 25Required

organizationstring · max: 25Required

task_namestringRequired

worker_namestringOptional

worker_ipstring | nullableOptional

worker_hostnamestring | nullableOptional

descriptionstringOptional

queue_namestringOptional

last_heart_beatstring · date-timeOptional

is_enabledbooleanOptional

task_pathstringOptional

task_trigger_datastringOptional

is_deletedbooleanOptional

Responses

201Success

application/json

post

POST /ux/common/async_tasks/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 292

{
  "task_id": "text",
  "organization": "text",
  "task_name": "text",
  "worker_name": "text",
  "worker_ip": "text",
  "worker_hostname": "text",
  "description": "text",
  "queue_name": "text",
  "last_heart_beat": "2025-06-07T13:56:14.337Z",
  "is_enabled": true,
  "task_path": "text",
  "task_trigger_data": "text",
  "is_deleted": true
}

201Success

{
  "id": "text",
  "status": "text",
  "last_heartbeat_tooltip": "text",
  "last_heartbeat_time": "text",
  "async_task_status": "text",
  "conv_task_name": "text",
  "task_id": "text",
  "organization": "text",
  "task_name": "text",
  "worker_name": "text",
  "worker_ip": "text",
  "worker_hostname": "text",
  "description": "text",
  "queue_name": "text",
  "last_heart_beat": "2025-06-07T13:56:14.337Z",
  "is_enabled": true,
  "task_path": "text",
  "task_trigger_data": "text",
  "is_deleted": true
}

put

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

statusstringRead-onlyRequired

last_heartbeat_tooltipstringRead-onlyRequired

last_heartbeat_timestringRead-onlyRequired

async_task_statusstringRead-onlyRequired

conv_task_namestringRead-onlyRequired

task_idstring · max: 25Required

organizationstring · max: 25Required

task_namestringRequired

worker_namestringOptional

worker_ipstring | nullableOptional

worker_hostnamestring | nullableOptional

descriptionstringOptional

queue_namestringOptional

last_heart_beatstring · date-timeOptional

is_enabledbooleanOptional

task_pathstringOptional

task_trigger_datastringOptional

is_deletedbooleanOptional

Responses

200Success

application/json

put

PUT /ux/common/async_tasks/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 292

{
  "task_id": "text",
  "organization": "text",
  "task_name": "text",
  "worker_name": "text",
  "worker_ip": "text",
  "worker_hostname": "text",
  "description": "text",
  "queue_name": "text",
  "last_heart_beat": "2025-06-07T13:56:14.337Z",
  "is_enabled": true,
  "task_path": "text",
  "task_trigger_data": "text",
  "is_deleted": true
}

200Success

{
  "id": "text",
  "status": "text",
  "last_heartbeat_tooltip": "text",
  "last_heartbeat_time": "text",
  "async_task_status": "text",
  "conv_task_name": "text",
  "task_id": "text",
  "organization": "text",
  "task_name": "text",
  "worker_name": "text",
  "worker_ip": "text",
  "worker_hostname": "text",
  "description": "text",
  "queue_name": "text",
  "last_heart_beat": "2025-06-07T13:56:14.337Z",
  "is_enabled": true,
  "task_path": "text",
  "task_trigger_data": "text",
  "is_deleted": true
}