Task

Gets a list of tasks

get

This endpoint is used to fetch all the 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

HTTPcURLJavaScriptPython

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

200Success

[
  {
    "id": "text",
    "formatted_due_date": "text",
    "formatted_actual_start_date": "text",
    "assignee_info": "text",
    "formatted_estimated_duration": "text",
    "formatted_actual_end_date": "text",
    "task_id": "text",
    "type": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "display_id": "text",
    "ref_id": "text",
    "ref_display_id": "text",
    "ref_module_id": 1,
    "name": "text",
    "description": "text",
    "status": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "priority": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "assignee": "text",
    "assignee_profile": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "due_date": "2025-08-31T15:56:03.018Z",
    "repeat_config": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "meta_data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "is_deleted": true,
    "creation_time": "2025-08-31T15:56:03.018Z",
    "last_update_time": "2025-08-31T15:56:03.018Z",
    "closure_time": "2025-08-31T15:56:03.018Z",
    "created_by_id": 1,
    "updated_by_id": 1,
    "estimated_cost": 1,
    "estimated_duration": "2025-08-31T15:56:03.018Z",
    "approval_state": 1,
    "assigned_to_group": true,
    "additional_info": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "check_list": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "closure_note": "text",
    "actual_start_date": "2025-08-31T15:56:03.018Z",
    "actual_end_date": "2025-08-31T15:56:03.018Z",
    "config": {
      "keys": "text",
      "values": "text",
      "queryparam": true
    },
    "current_assignment_info": {
      "keys": "text",
      "values": "text",
      "queryparam": true
    },
    "template_info": {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  }
]

Creates a new task

post

This endpoint is used to save a new task for the current organization

Authorizations

Body

Other propertiesanyOptional

Responses

201

No response body

No content

post

HTTPcURLJavaScriptPython

POST /ux/sd/task/task/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "task": "task1",
  "type": "User"
}

201

No response body

No content

Gets a task with the given id

get

This endpoint is used to fetch a task details in the current organization

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/sd/task/task/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "formatted_due_date": "text",
  "formatted_actual_start_date": "text",
  "assignee_info": "text",
  "formatted_estimated_duration": "text",
  "formatted_actual_end_date": "text",
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

Edits the task with given id

put

This endpoint is used to edit an existing task for the current organization

Authorizations

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

formatted_due_datestringRead-onlyRequired

formatted_actual_start_datestringRead-onlyRequired

assignee_infostringRead-onlyRequired

formatted_estimated_durationstringRead-onlyRequired

formatted_actual_end_datestringRead-onlyRequired

task_idstring · max: 25Optional

display_idstring · max: 25Optional

ref_idstring · max: 25Optional

ref_display_idstring · max: 25Optional

ref_module_idintegerOptional

namestringOptional

descriptionstringOptional

assigneestringOptional

due_datestring · date-timeOptional

is_deletedbooleanOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

closure_timestring · date-timeOptional

created_by_idintegerOptional

updated_by_idintegerOptional

estimated_costnumber · floatOptional

estimated_durationstring · date-timeOptional

approval_stateintegerOptional

assigned_to_groupbooleanOptional

closure_notestringOptional

actual_start_datestring · date-timeOptional

actual_end_datestring · date-timeOptional

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

PUT /ux/sd/task/task/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1215

{
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "formatted_due_date": "text",
  "formatted_actual_start_date": "text",
  "assignee_info": "text",
  "formatted_estimated_duration": "text",
  "formatted_actual_end_date": "text",
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

Deletes the task with given id

delete

This endpoint is used to delete an existing task for the current organization

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

No content

delete

HTTPcURLJavaScriptPython

DELETE /ux/sd/task/task/{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

Path parameters

idstringRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/sd/task/task/change-task-list/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "formatted_due_date": "text",
  "formatted_actual_start_date": "text",
  "assignee_info": "text",
  "formatted_estimated_duration": "text",
  "formatted_actual_end_date": "text",
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/sd/task/task/change-task/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "formatted_due_date": "text",
  "formatted_actual_start_date": "text",
  "assignee_info": "text",
  "formatted_estimated_duration": "text",
  "formatted_actual_end_date": "text",
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

formatted_due_datestringRead-onlyRequired

formatted_actual_start_datestringRead-onlyRequired

assignee_infostringRead-onlyRequired

formatted_estimated_durationstringRead-onlyRequired

formatted_actual_end_datestringRead-onlyRequired

task_idstring · max: 25Optional

display_idstring · max: 25Optional

ref_idstring · max: 25Optional

ref_display_idstring · max: 25Optional

ref_module_idintegerOptional

namestringOptional

descriptionstringOptional

assigneestringOptional

due_datestring · date-timeOptional

is_deletedbooleanOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

closure_timestring · date-timeOptional

created_by_idintegerOptional

updated_by_idintegerOptional

estimated_costnumber · floatOptional

estimated_durationstring · date-timeOptional

approval_stateintegerOptional

assigned_to_groupbooleanOptional

closure_notestringOptional

actual_start_datestring · date-timeOptional

actual_end_datestring · date-timeOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/sd/task/task/delete-change-task/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1215

{
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "formatted_due_date": "text",
  "formatted_actual_start_date": "text",
  "assignee_info": "text",
  "formatted_estimated_duration": "text",
  "formatted_actual_end_date": "text",
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

formatted_due_datestringRead-onlyRequired

formatted_actual_start_datestringRead-onlyRequired

assignee_infostringRead-onlyRequired

formatted_estimated_durationstringRead-onlyRequired

formatted_actual_end_datestringRead-onlyRequired

task_idstring · max: 25Optional

display_idstring · max: 25Optional

ref_idstring · max: 25Optional

ref_display_idstring · max: 25Optional

ref_module_idintegerOptional

namestringOptional

descriptionstringOptional

assigneestringOptional

due_datestring · date-timeOptional

is_deletedbooleanOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

closure_timestring · date-timeOptional

created_by_idintegerOptional

updated_by_idintegerOptional

estimated_costnumber · floatOptional

estimated_durationstring · date-timeOptional

approval_stateintegerOptional

assigned_to_groupbooleanOptional

closure_notestringOptional

actual_start_datestring · date-timeOptional

actual_end_datestring · date-timeOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/sd/task/task/delete-release-task/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1215

{
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "formatted_due_date": "text",
  "formatted_actual_start_date": "text",
  "assignee_info": "text",
  "formatted_estimated_duration": "text",
  "formatted_actual_end_date": "text",
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/sd/task/task/filter/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "formatted_due_date": "text",
  "formatted_actual_start_date": "text",
  "assignee_info": "text",
  "formatted_estimated_duration": "text",
  "formatted_actual_end_date": "text",
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/sd/task/task/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "formatted_due_date": "text",
  "formatted_actual_start_date": "text",
  "assignee_info": "text",
  "formatted_estimated_duration": "text",
  "formatted_actual_end_date": "text",
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/sd/task/task/rel-task-list/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "formatted_due_date": "text",
  "formatted_actual_start_date": "text",
  "assignee_info": "text",
  "formatted_estimated_duration": "text",
  "formatted_actual_end_date": "text",
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/sd/task/task/release-task/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "formatted_due_date": "text",
  "formatted_actual_start_date": "text",
  "assignee_info": "text",
  "formatted_estimated_duration": "text",
  "formatted_actual_end_date": "text",
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/sd/task/task/req-task-list/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "formatted_due_date": "text",
  "formatted_actual_start_date": "text",
  "assignee_info": "text",
  "formatted_estimated_duration": "text",
  "formatted_actual_end_date": "text",
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

formatted_due_datestringRead-onlyRequired

formatted_actual_start_datestringRead-onlyRequired

assignee_infostringRead-onlyRequired

formatted_estimated_durationstringRead-onlyRequired

formatted_actual_end_datestringRead-onlyRequired

task_idstring · max: 25Optional

display_idstring · max: 25Optional

ref_idstring · max: 25Optional

ref_display_idstring · max: 25Optional

ref_module_idintegerOptional

namestringOptional

descriptionstringOptional

assigneestringOptional

due_datestring · date-timeOptional

is_deletedbooleanOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

closure_timestring · date-timeOptional

created_by_idintegerOptional

updated_by_idintegerOptional

estimated_costnumber · floatOptional

estimated_durationstring · date-timeOptional

approval_stateintegerOptional

assigned_to_groupbooleanOptional

closure_notestringOptional

actual_start_datestring · date-timeOptional

actual_end_datestring · date-timeOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/sd/task/task/save-change-task/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1215

{
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "formatted_due_date": "text",
  "formatted_actual_start_date": "text",
  "assignee_info": "text",
  "formatted_estimated_duration": "text",
  "formatted_actual_end_date": "text",
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

formatted_due_datestringRead-onlyRequired

formatted_actual_start_datestringRead-onlyRequired

assignee_infostringRead-onlyRequired

formatted_estimated_durationstringRead-onlyRequired

formatted_actual_end_datestringRead-onlyRequired

task_idstring · max: 25Optional

display_idstring · max: 25Optional

ref_idstring · max: 25Optional

ref_display_idstring · max: 25Optional

ref_module_idintegerOptional

namestringOptional

descriptionstringOptional

assigneestringOptional

due_datestring · date-timeOptional

is_deletedbooleanOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

closure_timestring · date-timeOptional

created_by_idintegerOptional

updated_by_idintegerOptional

estimated_costnumber · floatOptional

estimated_durationstring · date-timeOptional

approval_stateintegerOptional

assigned_to_groupbooleanOptional

closure_notestringOptional

actual_start_datestring · date-timeOptional

actual_end_datestring · date-timeOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/sd/task/task/save-release-task/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1215

{
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "formatted_due_date": "text",
  "formatted_actual_start_date": "text",
  "assignee_info": "text",
  "formatted_estimated_duration": "text",
  "formatted_actual_end_date": "text",
  "task_id": "text",
  "type": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "display_id": "text",
  "ref_id": "text",
  "ref_display_id": "text",
  "ref_module_id": 1,
  "name": "text",
  "description": "text",
  "status": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priority": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignee": "text",
  "assignee_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-08-31T15:56:03.018Z",
  "repeat_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_deleted": true,
  "creation_time": "2025-08-31T15:56:03.018Z",
  "last_update_time": "2025-08-31T15:56:03.018Z",
  "closure_time": "2025-08-31T15:56:03.018Z",
  "created_by_id": 1,
  "updated_by_id": 1,
  "estimated_cost": 1,
  "estimated_duration": "2025-08-31T15:56:03.018Z",
  "approval_state": 1,
  "assigned_to_group": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "check_list": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "closure_note": "text",
  "actual_start_date": "2025-08-31T15:56:03.018Z",
  "actual_end_date": "2025-08-31T15:56:03.018Z",
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}