Get Tasks by Process Instance
Overview
Retrieve tasks for a process instance, including their task IDs.
Endpoint
GET /api/processinstance/tasks
Use the service origin described in Getting started. The path above already includes /api.
Authentication
Send the access token obtained from Get Access Token in the Authorization header. Access is limited by the authenticated account’s permissions.
Request headers
Accept: application/json
Authorization: Bearer ACCESS_TOKEN
Query parameters
| Parameter | Type | Requirement | Description |
|---|---|---|---|
processInstanceId | string | Required | Execution ID returned by Create Process Instance. |
Request example
The following example uses cURL in a POSIX shell. Replace example credentials and IDs before running it. Replace the AI Command Center origin with your deployment address.
curl --request GET \
--url 'https://command-center.example.com/api/processinstance/tasks?processInstanceId=917cf6d136954a52b62f8a259c898f64' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN'
Response
Successful status: 200 OK.
The following is an illustrative response with synthetic contact and credential values. Arrays are shortened to one representative item.
[
{
"taskId": 117,
"name": "TestForm",
"form": "DemoForm.iform",
"processInstanceId": "917cf6d136954a52b62f8a259c898f64",
"statusId": 2,
"status": "Assigned",
"isAssignedToGroup": false,
"priorityId": 2,
"arguments": null,
"assignedTo": 2,
"assignedUserTitle": "demouser1 1",
"session": 1,
"dueDate": "2024-04-11T10:18:02.803788",
"created": "2024-04-10T10:18:03.009088",
"createdBy": "Sample User",
"modified": "2024-04-10T10:18:03.009088",
"modifiedBy": "Sample User",
"processName": "demo_process",
"creatorName": "Sample User",
"modifierName": "Sample User",
"assignedDate": "2024-04-10T10:18:02.803788",
"completedDate": null,
"activityId": "StandardTask1",
"originalAssignedUserTitle": "demouser1 1"
}
]
Response fields
The response is an array. The table describes fields in an item. Types reflect the example; this is not an exhaustive schema or nullability contract.
| Field | Example type | Description |
|---|---|---|
taskId | integer | ID of the task. |
processInstanceId | string | ID of the process execution. |
statusId | integer | Numeric status identifier; the complete mapping is not defined here. |
status | string | Resource or operation status shown in the example; the complete allowed set is not defined here. |
priorityId | integer | Numeric priority identifier; the complete mapping is not defined here. |
arguments | null | Process or task arguments, when present. |
activityId | string | Activity identifier from the process definition. |
Errors
Endpoint-specific error statuses and response bodies are not yet documented. See Usage and troubleshooting for general handling guidance.