Get Activity Instance Info
Overview
Retrieve an activity instance using its process instance ID and activity instance ID.
Endpoint
GET /api/processinstance/activityInstanceById
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. |
activityInstanceId | string | Required | Activity instance ID; distinct from the designer activity ID. |
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/activityInstanceById?processInstanceId=917cf6d136954a52b62f8a259c898f64&activityInstanceId=d46b970f-0cd3-40e7-95aa-9a5b9fcd7334' \
--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.
{
"id": "83fdea32fa64462a878ee0129d10aadb",
"name": "LeaveRequest",
"session": 1,
"status": "Passed",
"startedAt": "2024-06-27T13:24:02.202564",
"endedOn": "2024-06-27T13:24:02.24273",
"duration": "00:00:00.0401660",
"activityId": "StartTask1",
"activityInstanceId": "d46b970f-0cd3-40e7-95aa-9a5b9fcd7334"
}
Response fields
The table describes selected fields in the response. Types reflect the example; this is not an exhaustive schema or nullability contract.
| Field | Example type | Description |
|---|---|---|
status | string | Resource or operation status shown in the example; the complete allowed set is not defined here. |
activityId | string | Activity identifier from the process definition. |
activityInstanceId | string | ID of the activity execution. |
Errors
Endpoint-specific error statuses and response bodies are not yet documented. See Usage and troubleshooting for general handling guidance.