orchestrator
2024.10
false
- Getting started
- Swagger definition
- Orchestrator APIs
- Alerts Requests
- Assets Requests
- Calendars requests
- Environments requests
- Folders requests
- Generic Tasks requests
- Jobs requests
- Libraries requests
- License requests
- Packages requests
- Permissions requests
- Personal workspaces requests
- Processes requests
- Queue Items requests
- Queue retention policy requests
- Robots requests
- Roles requests
- Schedules requests
- Settings requests
- Storage bucket requests
- Tasks requests
- Task Catalogs requests
- Task Forms requests
- Tenants requests
- Transactions requests
- Users requests
- Webhooks requests

Orchestrator API guide
Last updated Mar 24, 2026
Enumerated types
JobState
Defines the state of a job.
| Name | Value | Description |
|---|---|---|
| Pending | 0 | Job queued on a busy or disconnected robot. |
| Running | 1 | Job currently processed by a robot. |
| Stopping | 2 | Job triggered to cancel as soon as it is safe. This can be implemented in a workflow using the Should Stop activity. |
| Terminating | 3 | Job triggered to stop forcefully. This may take up to a couple of seconds, and the process is killed. Safe stopping is not guaranteed. |
| Faulted | 4 | Job that has failed to start, or the associated workflow threw an unhandled error during execution. |
| Successful | 5 | Job that finished processing without any exceptions. |
| Stopped | 6 | Job stopped before it finished executing without throwing any errors. |
| Suspended | 7 | An intermediary state that is triggered with the purpose of allowing user intervention or completion of an intermediary process. It is triggered by the corresponding activities in Studio. |
| Resumed | 8 | An intermediary state that is triggered if the conditions (user intervention, intermediary process completion) of a fragmented workflow have been met. It is triggered by the corresponding activities in Studio. |
JobSource
| Name | Value | Description |
|---|---|---|
| Manual | 0 | The job has been started and configured from the Jobs/Triggers/Processes pages, using the Start button. |
| Trigger | 1 | The job has been launched through a trigger, used for preplanned job execution. |
Job Type
| Name | Value |
|---|---|
| Unattended | 0 |
| Attended | 1 |
RobotState
Defines the Robot availability state.
| Name | Value | Description |
|---|---|---|
| Available | 0 | A functioning robot that is free to be used. |
| Busy | 1 | A robot that is running a process. |
| Disconnected | 2 | A robot that is disconnected from Orchestrator. |
| Unknown | 3 | A robot that is in an Unknown state. |
ProcessingStatus
Defines the processing state of a queue item.
| Name | Value | Description |
|---|---|---|
| New | 0 | The state of a newly added item. |
| InProgress | 1 | The state of an item that is being processed. |
| Failed | 2 | The state of an item whose processing failed. |
| Successful | 3 | The state of an item whose processing succeeded. |
| Abandoned | 4 | The state of an item whose processing was stopped before succeeding or failing. |
| Retried | 5 | The state of an item that was processed at least twice. |
| Deleted | 6 | The state of an item that was marked as deleted by the user. |
ProcessingExceptionType
Defines categories for the exception thrown when item processing fails.
| Name | Value | Description |
|---|---|---|
| ApplicationException | 0 | Thrown when the process fails due to an application error. |
| BusinessException | 1 | Thrown when a business requirement is not met. |
ReviewStatus
| Name | Value | Description |
|---|---|---|
| None | 0 | Default state applicable to all item types. |
| InReview | 1 | An item in this state has failed with an application exception and has been marked by a user as in the process of being reviewed. |
| Verified | 2 | An item in this state has failed with an application exception and has been marked by a user as verified and can no longer be retried. To be retried, an item has to be manually marked for retry. |
| Retried | 3 | An item in this state has failed with an application exception and has been marked for retry. |
AssetValueScope
Defines the visibility level of an asset.
| Name | Value | Description |
|---|---|---|
| Global | 0 | If an asset has Global scope, it is visible to all robots. |
| PerRobot | 1 | If an asset has PerRobot scope, it will be visible only to certain robots, to which it was associated and may have different values for each robot. |
AssetValueType
Defines what type of value is stored by an asset.
| Name | Value | Description |
|---|---|---|
| Text | 2 | Defines an asset that stores a text value. |
| Bool | 3 | Defines an asset that stores a boolean value. |
| Integer | 4 | Defines an asset that stores a numerical value. |
| Credential | 5 | Defines an asset that stores a username and password. |
LogLevel
Defines the log severity.
| Name | Value | Description |
|---|---|---|
| Trace | 0 | Fine-grained information. |
| Debug | 1 | Detailed information on the flow through the system. |
| Info | 2 | Runtime events like startup or shutdown. The vast majority of log entries. |
| Warn | 3 | Runtime situations that are undesirable or unexpected, but not necessarily wrong. |
| Error | 4 | Runtime errors or unexpected conditions. |
| Fatal | 5 | Severe errors that cause premature termination. |
UserType
Defines how a user was created and how it is supposed to be used.
| Name | Value | Description |
|---|---|---|
| User | 0 | A user of type Local User. |
| Robot | 1 | Automatically created when adding a robot, is assigned the Robot role, and it is used by a robot when communicating with Orchestrator. |
| DirectoryUser | 2 | A user of type Directory User |
| DirectoryGroup | 3 | A user of type Directory Group |