Querying the To-Do List

Function

This API is used to query the to-do list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/tasks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A
workspace_id	Yes	String	Definition Workspace ID. Range N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Request offset. Constraints N/A Range 0-9999 Default Value 0
limit	No	Integer	Definition Page size of to-do tasks. Constraints N/A Range 1 to 100 Default Value 10
sort_key	No	String	Definition Sort fields of the to-do task. create_time: Tasks are sorted by creation time. update_time: Tasks are sorted by update time. Constraints N/A Range create_time update_time Default Value create_time
sort_dir	No	String	Definition Sorting mode of to-do tasks. ASC: sorting in ascending order DESC: sorting in descending order Constraints N/A Range ASC DESC Default Value DESC
note	No	String	Definition Remarks of the to-do task. Constraints N/A Range N/A Default Value N/A
name	No	String	Definition Name of the to-do task. Constraints N/A Range N/A Default Value N/A
business_type	No	String	Definition Service type of the to-do task. WORKFLOWPUBLISH: workflow publishing WORKFLOWNODEAPPROVE: workflow node review PLAYBOOKPUBLISH: playbook publishing PLAYBOOKNODEAPPROVE: playbook node review Constraints N/A Range WORKFLOWPUBLISH WORKFLOWNODEAPPROVE PLAYBOOKPUBLISH PLAYBOOKNODEAPPROVE Default Value N/A
creator_name	No	String	Definition Creator of the to-do task. Constraints N/A Range N/A Default Value N/A
query_type	No	String	Definition To-do task type. my_todo: task to be handled. all_handled: task that has been handled. Constraints N/A Range my_todo all_handled Default Value my_todo
from_date	No	String	Definition Start time. The format is yyyy-MM-dd'T'HH:mm:ss.SSS'Z'Z. Constraints N/A Range N/A Default Value N/A
to_date	No	String	Definition End time. The format is yyyy-MM-dd'T'HH:mm:ss.SSS'Z'Z. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Constraints N/A Range N/A Default Value N/A
Content-Type	Yes	String	Definition Content type. application/json;charset=UTF-8: common API request type Constraints N/A Range application/json;charset=UTF-8 Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
code	String	Definition Error code. If the request is successful, the value is "00000000". Range N/A
message	String	Definition Error message description. Range N/A
total	Number	Definition Total number of to-do tasks. Range N/A
page	Number	Definition Request offset. Range 1 to 100
size	Number	Definition Size of the to-do task page. Range 1 to 100
request_id	String	Definition Request ID. Constraints N/A
success	Boolean	Definition Successful or not. Range true: successful. false: failed
data	Array of TaskInfo objects	list of informations of task

**Table 5** TaskInfo
Parameter	Type	Description
id	String	Definition ID of the to-do task. Range N/A
aopengine_task_id	String	Definition Engine task ID of the to-do task. Range N/A
name	String	Definition Name of the to-do task. Range N/A
project_id	String	Definition Project ID for the to-do task. Range N/A
description	String	Definition Description of the to-do task. Range N/A
create_time	String	Definition To-do task creation time. Range N/A
creator_id	String	Definition Creator ID of the to-do task. Range system
creator_name	String	Definition Creator name of the to-do task. Range N/A
update_time	String	Definition To-do task update time. Range N/A
modifier_id	String	Definition Modifier ID of the to-do task. Range system
modifier_name	String	Definition Modifier name of the to-do task. Range N/A
approveuser_id	String	Definition ID of the to-do task reviewer. Range N/A
approveuser_name	String	Definition Username of the to-do task reviewer. Range N/A
approver	String	Definition Username of the to-do task reviewer Range N/A
notes	String	Definition Remarks of the to-do task. Range N/A
definition_key	String	Definition Workflow topology key of the to-do task node. Range N/A
note	String	Definition Remarks of the to-do task. Range N/A
due_date	String	Definition To-do task overdue time. Range The default value is the creation time plus 15 days.
action_id	String	Definition Workflow or playbook ID of the to-do task node. If business_type is WORKFLOWPUBLISH or WORKFLOWNODEAPPROVE, the value of this parameter is the workflow ID. If business_type is PLAYBOOKPUBLISH or PLAYBOOKNODEAPPROVE, the value of this parameter is the playbook ID. Range N/A
action_version_id	String	Definition Workflow or playbook version ID of the to-do task node. If business_type is WORKFLOWPUBLISH or WORKFLOWNODEAPPROVE, the value of this parameter is the workflow version ID. If business_type is PLAYBOOKPUBLISH or PLAYBOOKNODEAPPROVE, the value of this parameter is the playbook version ID. Range N/A
action_instance_id	String	Definition Workflow or playbook instance ID of the to-do task node. If business_type is WORKFLOWNODEAPPROVE, the value of this parameter is the workflow instance ID. If business_type is PLAYBOOKNODEAPPROVE, the value of this parameter is the playbook instance ID. Range N/A
workspace_id	String	Definition ID of the workspace for the to-do task. Range N/A
review_comments	String	Definition Review comments of the to-do task. Range N/A
view_parameters	String	Definition Parameters for viewing to-do tasks. Range N/A
handle_parameters	String	Definition Manual processing parameters of the to-do task. Range N/A
business_type	String	Definition Service type of the to-do task. WORKFLOWPUBLISH: workflow publishing WORKFLOWNODEAPPROVE: workflow node review PLAYBOOKPUBLISH: playbook publishing PLAYBOOKNODEAPPROVE: playbook node review Range WORKFLOWPUBLISH WORKFLOWNODEAPPROVE PLAYBOOKPUBLISH PLAYBOOKNODEAPPROVE
related_object	String	Definition Name of the workflow or playbook associated with the to-do task. Range N/A
attachment_id_list	Array of strings	Definition ID list of attachments of the to-do task node. Range N/A
comments	Array of TaskCommentInfo objects	Definition To-do comments of the to-do task node. Range N/A
status	String	Definition Service type of the to-do task. waiting: to be processed canceled: canceled finished: finished Range waiting canceled finished
due_handle	String	Definition Handling method of expired to-do tasks. CONTINUE: continues the execution INTERRUPT: terminates the execution Range CONTINUE INTERRUPT

**Table 6** TaskCommentInfo
Parameter	Type	Description
id	String	Definition To-do task comment ID. Range N/A
message	String	Definition To-do task comment information. Range N/A
user_id	String	Definition ID of to-do task comment creator. Range N/A
user_name	String	Definition Name of the to-do task comment creator. Range N/A
time	Long	Definition Time when the to-do task comment is created. Range N/A

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
code	String	Definition Error code. Range N/A
message	String	Definition Error description. Range N/A

Example Requests

Query my to-dos.

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/tasks?query_type=my_todo&offset=0&limit=10

Query completed tasks.

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/tasks?query_type=all_handled&offset=1&limit=10

Example Responses

Status code: 200

Response of listing task informations

{
  "code" : "00000000",
  "data" : [ {
    "id" : "3e4c170e-7cc9-11f0-9216-fa163e209978",
    "aopengine_task_id" : "3e4c170e-7cc9-11f0-9216-fa163e209978",
    "name" : "test task",
    "project_id" : "15645222e8744afa985c93dab6341da6",
    "description" : "",
    "create_time" : "2025-08-19T14:53:42.424Z+0800",
    "creator_id" : "",
    "creator_name" : "XXXX",
    "modifier_id" : "",
    "modifier_name" : "",
    "update_time" : "2025-08-19T16:50:23.743Z+0800",
    "approveuser_id" : "",
    "approveuser_name" : "",
    "approver" : "",
    "notes" : "006",
    "definition_key" : "Activity_1xkg6ju",
    "due_date" : "2025-09-03T14:53:42.398Z+0800",
    "action_id" : "e1426fd5-bf48-3b71-8f8e-d5ca1047f68b",
    "action_version_id" : "0696648d-9d20-4e21-b1fd-24f9a6f4918c",
    "action_instance_id" : "xxxxx",
    "workspace_id" : "75645d0a-93b8-4a7f-a77c-e97009389445",
    "view_parameters" : "",
    "handle_parameters" : "",
    "review_comments" : "",
    "business_type" : "PLAYBOOKNODEAPPROVE",
    "related_object" : "test",
    "attachment_id_list" : [ ],
    "comments" : [ ],
    "due_handle" : "",
    "status" : "waiting"
  } ],
  "message" : "",
  "page" : 1,
  "request_id" : "",
  "size" : 50,
  "success" : true,
  "total" : 1
}