Process Instances API
APIs and models to create and manage your process instances.
API
The following methods are available in the process instance category.
| API | Description |
|---|---|
| CreateAsync | Creates a process instance with the specified details inside the connected Control Room. |
| CreateTaskAsync | Creates task(s) for the participant(s). |
| GetActivitiesHistoryAsync | Gets the activity execution records from the specified process instance. |
| GetActivityInstanceByIdAsync | Gets activity instance of specified activity id inside the connected Control Room. |
| GetActivityInstanceByInstIdAsync | Gets activity instance of specified activity instance id inside the connected Control Room. |
| GetActivityInstancesAsync | Gets activity instances of specified process instance id inside the connected Control Room. |
| GetAllInstancesAsync | Gets all the process instances inside the connected Control Room. |
| GetInstanceByIdAsync | Gets process instance of specified process instance id inside the connected Control Room. |
| GetInstanceDataAsync | Gets process data associated with process instance using the specified process instance id inside the connected Control Room. |
| GetInstanceLogsAsync | Gets logs of specified process instance id inside the connected Control Room. |
| GetInstanceTasksAsync | Gets tasks associated with process instance using the specified process instance ID inside the connected Control Room. |
| GetModelDataAsync | Gets Workflow Data of specified process instance inside the connected Control Room. |
| UpdateModelDataAsync | Updates Workflow Data of specified process instance inside the connected Control Room. |
| GetAgentDataAsync | Gets agent data of specified process instance inside the connected Control Room. |
| UpdateAgentDataAsync | Updates agent data of specified process instance inside the connected Control Room. |
| GetWorkflowInstancesByProcessInstanceIdAsync | Gets workflow instances associated with the specified process instance ID inside the connected Control Room. |
| GetModelDataByWorkflowAsync | Gets Workflow Data of a specified workflow instance within a process instance, optionally filtered by requested fields, inside the connected Control Room. |
| GetInstanceStatusByIdAsync | The API gets the process instance status of the specified process instance ID inside the connected AI Command Center. |
Models
The following models are used by the process instance APIs.
| Models | Description |
|---|---|
| ActivityHistory | Represents the activity execution record. |
| TaskParticipant | Represents a task participant. |
| CreateTaskResponse | Represents a response which provides information about tasks created and not created. |
| TaskCreatedForUserResponse | Represents a response which has the information about a task created for the user. |
| TaskNotCreatedForParticipantResponse | Represents a response which has the information about the task not created for the task participant. |
| WorkflowInstanceData | Represents a workflow instance associated with a process instance. |
| ModelData | Represents Workflow Data for a workflow instance within a process instance. |
| AgentData | Represents agent data for a process instance, shared across workflows. |
| ProcessInstanceData | Represents process instance data, including Workflow Data, Form Data, System Data, and Agent Data. |