orchestrator
2024.10
false
  • Getting started
    • About OData and references
    • Enumerated types
    • Authenticating
    • Permissions per endpoint
    • Building API Requests
    • Response codes
    • Health check endpoints
  • Swagger definition
  • Orchestrator APIs
UiPath logo, featuring letters U and I in white

Orchestrator API guide

Last updated Mar 24, 2026

Enumerated types

JobState

Defines the state of a job.

NameValueDescription
Pending0Job queued on a busy or disconnected robot.
Running1Job currently processed by a robot.
Stopping2Job triggered to cancel as soon as it is safe. This can be implemented in a workflow using the Should Stop activity.
Terminating3Job triggered to stop forcefully. This may take up to a couple of seconds, and the process is killed. Safe stopping is not guaranteed.
Faulted4Job that has failed to start, or the associated workflow threw an unhandled error during execution.
Successful5Job that finished processing without any exceptions.
Stopped6Job stopped before it finished executing without throwing any errors.
Suspended7An 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.
Resumed8An 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

NameValueDescription
Manual0The job has been started and configured from the Jobs/Triggers/Processes pages, using the Start button.
Trigger1The job has been launched through a trigger, used for preplanned job execution.

Job Type

NameValue
Unattended0
Attended1

RobotState

Defines the Robot availability state.

NameValueDescription
Available0A functioning robot that is free to be used.
Busy1A robot that is running a process.
Disconnected2A robot that is disconnected from Orchestrator.
Unknown3A robot that is in an Unknown state.

ProcessingStatus

Defines the processing state of a queue item.

NameValueDescription
New0The state of a newly added item.
InProgress1The state of an item that is being processed.
Failed2The state of an item whose processing failed.
Successful3The state of an item whose processing succeeded.
Abandoned4The state of an item whose processing was stopped before succeeding or failing.
Retried5The state of an item that was processed at least twice.
Deleted6The state of an item that was marked as deleted by the user.

ProcessingExceptionType

Defines categories for the exception thrown when item processing fails.

NameValueDescription
ApplicationException0Thrown when the process fails due to an application error.
BusinessException1Thrown when a business requirement is not met.

ReviewStatus

NameValueDescription
None0Default state applicable to all item types.
InReview1An item in this state has failed with an application exception and has been marked by a user as in the process of being reviewed.
Verified2An 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.
Retried3An item in this state has failed with an application exception and has been marked for retry.

AssetValueScope

Defines the visibility level of an asset.

NameValueDescription
Global0If an asset has Global scope, it is visible to all robots.
PerRobot1If 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.

NameValueDescription
Text2Defines an asset that stores a text value.
Bool3Defines an asset that stores a boolean value.
Integer4Defines an asset that stores a numerical value.
Credential5Defines an asset that stores a username and password.

LogLevel

Defines the log severity.

NameValueDescription
Trace0Fine-grained information.
Debug1Detailed information on the flow through the system.
Info2Runtime events like startup or shutdown. The vast majority of log entries.
Warn3Runtime situations that are undesirable or unexpected, but not necessarily wrong.
Error4Runtime errors or unexpected conditions.
Fatal5Severe errors that cause premature termination.

UserType

Defines how a user was created and how it is supposed to be used.

NameValueDescription
User0A user of type Local User.
Robot1Automatically created when adding a robot, is assigned the Robot role, and it is used by a robot when communicating with Orchestrator.
DirectoryUser2A user of type Directory User
DirectoryGroup3A user of type Directory Group

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated