Introduction
APIs and Models to create and manage your process instances.
API
Here is the list of APIs existing under 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 model data of specified process instance inside the connected Control Room. |
| UpdateModelDataAsync | Updates model data of specified process instance inside the connected Control Room. |
Models
Here is the list of Models used in connections APIs.
| Models | Description |
|---|---|
| Connection | The structure represents an instance of the Connection entity. |
| ConnectionData | The structure represents an instance of the ConnectionData entity. |
| 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. |