Orchestrator
latest
false
Banner background image
Orchestrator API Guide
Last updated Mar 21, 2024

Response Codes

The Orchestrator API attempts to return appropriate HTTP status codes for every request.

On top of those, the Orchestrator API also returns some custom error codes. The table below describes each of these errors and when you can encounter them.

Code

Text

Description

1000

Invalid request!

Invalid username/email address or password.

Invalid OData query options.

Generic

1001

NameAlreadyUsed

The name [CustomNameYouAdded] is already used.

An error message that is thrown if you try to create or edit a resource with a name that already exists in the database.

This error is returned for the following endpoints:

  • POST and PUT - /odata/Assets
  • POST and PUT - /odata/QueueDefinitions
  • POST - /odata/QueueItems(id)/UiPathODataSvc.SetTransactionProgress
  • POST - /odata/QueueItems/UiPathODataSvc.SetItemReviewStatus
  • POST - /odata/QueueItems/UiPathODataSvc.DeleteBulk
  • POST - /odata/QueueItems/UiPathODataSvc.SetItemReviewer
  • POST - /odata/QueueItems/UiPathODataSvc.UnsetItemReviewer
  • POST - /odata/Queues(id)/UiPathODataSvc.SetTransactionResult
  • POST - /odata/Queues/UiPathODataSvc.AddQueueItem
  • POST - /odata/Queues/UiPathODataSvc.StartTransaction
  • POST, PUT, and PATCH - /odata/Releases
  • POST, PUT, and PATCH - /odata/Machines
  • POST and PUT - /odata/Robots
  • POST - /odata/Robots/UiPath.Server.Configuration.OData.ConvertToFloating
  • POST and PUT - /odata/ProcessSchedules
  • POST - /odata/Roles
  • POST - /odata/Users

1002

ItemNotFound

Robot does not exist.

An error message that is thrown if you make a request to a resource that does not exist in the database. It is returned for tenants, assets, jobs, host licenses, queues and queue items, processes, settings, and users.

1003

StringProtectFailed

Protect call failed for provided string.

  • POST and PUT - /odata/Robots
  • PUT - /odata/Settings('id')
  • POST - /odata/Settings/UiPath.Server.Configuration.OData.UpdateBulk

1004

ItemAlreadyExists

This message is thrown if you try to create an asset or Robot that already exists in the database. This also applies to uploading a package.

1006

ErrorInserting

  • PUT - /odata/Environments
  • PUT - /odata/QueueDefinitions
  • POST - /odata/QueueItems(Id)/UiPathODataSvc.SetTransactionProgress
  • POST - /odata/QueueItems/UiPathODataSvc.SetItemReviewStatus
  • POST - /odata/QueueItems/UiPathODataSvc.DeleteBulk
  • POST - /odata/QueueItems/UiPathODataSvc.SetItemReviewer
  • POST - /odata/QueueItems/UiPathODataSvc.UnsetItemReviewer
  • POST - /odata/Queues(id)/UiPathODataSvc.SetTransactionResult
  • POST, PUT, and PATCH - /odata/Machines
  • POST and PUT - /odata/Robots
  • POST - /odata/Robots/UiPath.Server.Configuration.OData.ConvertToFloating
  • PUT - /odata/ProcessSchedules(id)
  • POST - /odata/ProcessSchedules/UiPath.Server.Configuration.OData.SetEnabled

1007

ErrorUpdating

This error is displayed if you try to update a transaction comment that was added by a different user, by making a PUT request to the /odata/QueueItemComments(Id) endpoint.

1008

ErrorSendingEmail

An error thrown if Orchestrator failed to send an email to a user when performing a POST, PUT, or PATCH request to the /odata/Users endpoint.

1009

InvalidArgument

Invalid argument [ArgumentName].

 

1010

SqlAcquireLockFailure

 

1011

LibrariesFeedInUse

Cannot open libraries feed. Try again later.

This message is displayed if the libraries feed cannot be accessed, due to various reasons.

The error can be returned by the following endpoints:

  • GET - /odata/Libraries
  • GET - /odata/Libraries/UiPath.Server.Configuration.OData.GetVersions(packageId='Id')
  • DELETE - /odata/Libraries('Id')
  • GET - /odata/Libraries/UiPath.Server.Configuration.OData.DownloadPackage(key='key')
  • POST - /odata/Libraries/UiPath.Server.Configuration.OData.UploadPackage

1012

HasDependentItems

This error is thrown if the organization unit you are trying to delete has users associated to it. This is an error displayed when making a DELETE call to the /odata/OrganizationUnits endpoint.

1013

ItemIsInUse

Package is referred in active processes and cannot be deleted.

An error displayed when trying to delete a package version that is active, such as a DELETE request to https:/uipath.platform.com/odata/Processes('input_output_test%3A1.1.0'). Only inactive packages (not associated with an environment) can be removed.

1014

ParameterMissing

Parameter [ParameterName] is missing.

This is a generic error that is thrown when a required parameter was not provided.

This error can be displayed for the following endpoints:

  • POST - /odata/Alerts/UiPath.Server.Configuration.OData.RaiseProcessAlert
  • POST - /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
  • POST - /odata/Jobs(Id)/UiPath.Server.Configuration.OData.StopJob
  • POST - /odata/Jobs/UiPath.Server.Configuration.OData.StopJobs
  • POST - /odata/Processes/UiPath.Server.Configuration.OData.SetArguments
  • POST - /odata/QueueItems/UiPathODataSvc.SetItemReviewer
  • POST - /odata/QueueItems/UiPathODataSvc.UnsetItemReviewer
  • POST - /odata/Queues/UiPathODataSvc.StartTransaction
  • POST - /odata/Machines/UiPath.Server.Configuration.OData.DeleteBulk
  • POST - /odata/Robots/UiPath.Server.Configuration.OData.DeleteBulk
  • POST - /odata/Robots/UiPath.Server.Configuration.OData.ConvertToFloating

1015

ParameterInvalid

Parameter [ParameterName] is invalid.

Value should be between 0 and 168.

This error is displayed in the following scenarios:

  • If you provide an invalid value for the Run Disconnected Hours setting, while making a PUT request to the /odata/Settings('AttendedRobot.RunDisconnectedHours') endpoint.
  • Throw new BadRequestException( ErrorCode .ParameterInvalid, nameof(Resource.DeepPaginationNotPossibleInElasticsearch), null, DefaultElasticMaxResultWindow);

1016

DuplicateReference

Error creating [ReferenceName]. Duplicate Reference. (Example: Error creating UiPath.Core.Model.Queues.UiQueueItem. Duplicate Reference.)

This error is displayed if you tried to add a queue item with a reference that already exists. This occurs only if you set your queue to work only with unique references.

1017

ForbiddenOperation

Downloading the specified package is not allowed.

Terms and Conditions must be accepted.

A message displayed if the user you are authenticated with does not have rights to download a specific package or library, by performing GET requests to the /odata/Processes/UiPath.Server.Configuration.OData.DownloadPackage(key='key') or `/odata/Libraries/UiPath.Server.Configuration.OData.DownloadPackage(key='{key

1018

InvalidUser

Cannot connect to AD domain.

User does not exist.

This error message is displayed when you are trying to import and AD user which is not a member of the specified domain.

1050

InvalidAuditRelationship

Cannot include specified relationship.

Audit

1100

InvalidOrganizationUnit

The user is no longer associated with the organization unit.

Only displayed if organization units are enabled.

This error is displayed if you are trying to make calls using a user that is associated to a different organization unit than the one you are trying to access.

1101

RequiredOrganizationUnit

An organization unit is required for this action.

Only displayed if organization units are enabled on your Orchestrator instance.

The error is thrown when making POST requests endpoint without including an organization unit as a parameter.

1102

OrganizationUnitNotEditable

The organization unit doesn't exist or is no longer associated with the user.

Only displayed if organization units are enabled.

This error message is thrown when making a POST request to the /odata/Users(Id)/UiPath.Server.Configuration.OData.ToggleOrganizationUnit endpoint if the user you are authenticated with is not associated with the organization unit provided as a parameter or does not exist.

1200

MachineAlreadyPairedWithDifferentLicenseKey

There is already a robot on this machine with a different license key.

This error message is displayed if a Robot is already present on the specified machine with a different license key. It is thrown for the following endpoints:

  • POST, PUT, and PATCH - /odata/Machines/
  • POST and PUT - odata/Robots/
  • POST - /odata/Robots/UiPath.Server.Configuration.OData.ConvertToFloating
  • PUT - /odata/Settings('id')
  • POST - /odata/Settings/UiPath.Server.Configuration.OData.UpdateBulk

1201

NoAvailableLicenses

This error message is thrown if there are no more licenses on Orchestrator for the Robot you are trying to start a job on.

1202

HasAttachedRobots

The machine [MachineName] cannot be deleted because it has robots attached to it.

This error message is thrown if you are trying to delete a machine that has Robots defined on it.

1203

InvalidLicenseKey

Invalid license key.

The machine key is linked to another machine!

Robots

1204

MachineNameRequired

Robots

1205

UserNameRequired

Username is required if the password is set.

 

1206

CannotDeleteBusyRobot

Busy robots cannot be modified or deleted.

This message is displayed if you are trying to delete a Robot that is currently executing a job.

1207

MachineNameCannotChange

Robots

1208

MachineLicenseCannotChange;
InvalidNonProductionMachineSlots;
InvalidUnattendedMachineSlots.

Robots

1209

CannotUpdateBusyRobot

Cannot update the Username, Machine or Type of a busy Robot!

This message is displayed if you are trying to update a Robot that is currently executing a job.

1222

RobotStatusNotification

This is an alert that is triggered when a Robot disconnects from Orchestrator.

1223

RobotStatusNotification

This is an alert that is triggered when a Robot connected to Orchestrator becomes unresponsive.

1250

EnvironmentDeploymentConflict

This error message is thrown in the following cases:

  • If the package you are trying to associate with an environment is already deployed to a process.
  • If the Robot you are trying to associate with an environment is already deployed to a different environment.

1300

ServerConflict

Conflict (409)

1301

ActionAlreadyPerformed

Conflict (409)

1302

UnavailableResources

Conflict (409)

1400

UserIsDeleted

Authorization, Users, Roles

1401

UserIsLockedOut

Authorization, Users, Roles

1403

ChangePassword

Change Password

Authorization, Users, Roles

1404

PasswordExpired

The password has expired.

This error message is displayed when the password you are trying to log in with has expired.

1405

InvalidPassword

Authorization, Users, Roles

1406

CannotDeleteStaticRole

This message is shown if you are trying to delete the Administrator role.

1407

UserNotEditable

The user you are currently authenticated with does not have the right to edit to the indicated user.

1408

DomainUnreachable

Authorization, Users, Roles

1409

PasswordResetFailed

This error message is displayed if the password reset procedure failed.

1410

ConfirmEmailFailed

Email confirmation failed.

 

1411

CannotUsePreviousPassword

This error is returned if you are trying to use an old password during the reset password procedure.

1412

RoleIsNotEditable

This message is displayed if you are trying to make changes to the Administrator role, which is not editable.

1413

UserNotFoundInDomain

This error is thrown if the domain user you are trying to provision to Orchestrator does not belong to the defined Active Directory.

1414

CannotUpdateUsername

Cannot update the username!

Authorization, Users, Roles

1415

InvalidLoginMethod

Authorization, Users, Roles

1500

CredentialAssetEmptyPasswordForNewUser

Credential asset cannot have an empty password for a new user.

 

1501

CredentialAssetEmptyPasswordForNewRobot

Credential asset cannot have an empty password for a new robot.

This message is displayed if, when creating a credential asset, you do not also provide a value for the password.

1502

AssetTypeNonUpdatable

The asset type cannot be updated.

This error is thrown if you are trying to change the asset type through a PUT request.

1503

AssetNotAvailableForRobot

The asset does not have a value associated with this robot.

This message is shown if you the request you made was for a PerRobot asset, but the provided Robot is not associated with the given asset.

1600

InvalidCron

Invalid cron expression syntax.

The schedule you tried to add contains a Cron expression which is not valid.

1601

ScheduleWillNeverRun

 

1650

DownloadUnavailable

Processes/Packages/Jobs

1651

CannotConnectToPackagesRepository

Cannot connect to packages feed, the URL may be invalid.

Processes/Packages/Jobs

1652

NotSupportedByExternalFeeds

Not supported by External Feeds.

Processes/Packages/Jobs

1653

ErrorDownloading

Processes/Packages/Jobs

1654

InvalidPackageDetails

Invalid package details!

Processes/Packages/Jobs

1655

TenantFeedInUse

Cannot open the package feed. Try again later.

Processes/Packages/Jobs

1656

InvalidProcessKey

Processes/Packages/Jobs

1657

JobTypeCannotBeStopped

Processes/Packages/Jobs

1658

JobCannotBeCancelled

Cannot cancel a job with status [Status]. This can only be applied to Running, Pending or Stopping jobs.

This message is shown if you are trying to cancel a job that has one of the following statuses: Successful, Faulted, Terminating, Stopped.

1659

JobCannotBeTerminated

Cannot terminate a job with status [Status]. This can only be applied to Running, Pending or Stopping jobs.

This error is displayed if you are trying to cancel a job that has one of the following statuses: Successful, Faulted, Stopped.

1660

VersionNotFound

The job's package [PackageName], version [VersionNumber] could not be found.

This error is thrown if, when trying to start a job, the package with the indicated version cannot be found in the NuGet feed.

1661

ProcessNotFound,
PackageNotFound.

The associated process no longer exists.

Processes/Packages/Jobs

1662

HasAttachedProcesses

Processes/Packages/Jobs

1663

InvalidExtension

Processes/Packages/Jobs

1664

InvalidPackageCount

Processes/Packages/Jobs

1665

PreviousVersionNotFound

Processes/Packages/Jobs

1666

HasRunningJobs

Processes/Packages/Jobs

1667

TenantNotFound

Tenant not found.

 

1670

PendingJobsAlreadyExist

The robots already have pending jobs for this process.

This message is displayed when you already have a pending job on the same process and Robot.

1671

InvalidStartJobRobotIds

The specified robot(s) id(s) are invalid.

Processes/Packages/Jobs

1672

UnregisteredCannotStartJobs

Starting jobs is not possible. A valid license is required.

Processes/Packages/Jobs

1673

LicenseExpiredCannotStartJobs

License expired, starting jobs is no longer possible.

Processes/Packages/Jobs

1674

InvalidReleaseKey

Undefined process.

The id of the process on which you are trying to start a job is not valid.

1675

InvalidPackageVersion

Invalid package version.

Processes/Packages/Jobs

1676

TenantIsDisabled

Tenant [NameOfTenant] is disabled!

Processes/Packages/Jobs

1677

PackageNotFound

 

1678

BackgroundJobNotification

This error is thrown if there are no available Robots for a schedule, and therefore no jobs can be created.

1679

PathTooLong

 

1680

JobStatusNotification

This alert is generated when a job fails.

1700

CyberArkEditPasswordNotAllowed

Third-party components

1750

LogMessageNotFound

Logs

1800

EncryptionKeyNotFound

Configuration

1801

EncryptionKeyIncorrectFormat

Configured encryption key is not in a valid Base64 format.

Configuration

1850

TransactionReferenceRequired

Queue/Queue item

1851

InvalidTransactionProgressStatus

The progress status of the transaction you are trying to update is not the correct one for the update you want to perform.

1852

TransactionNotStarted

Queue/Queue item

1853

ReviewerNotAvailable

The user you are trying to assign as a reviewer to a transaction does not have the required permission (View and Edit on transactions).

1855

QueueDefinitionParametersCannotChange

Queue/Queue item

1856

QueueTransactionStatusNotification

This message error is displayed if an application is thrown for an item and it is not going to be retried anymore.

1900

LicenseNotFound

License not found.

License

1901

LicenseExpired

License expired!

License

1902

LicenseAlreadyInUse

The license is already in use!

License

1903

InvalidLicenseFormat

Invalid license format.

License

1904

LicenseLimitExceeded

License

1905

UnattendedLicenseLimitExceeded

License

1906

NonProductionLicenseLimitExceeded

License

1907

AttendedLicenseLimitExceeded

License

1908

DevelopmentLicenseLimitExceeded

License

1909

RobotFailedToAcquireLicense

License

1910

NonProductionSlotsLimitExceeded

License

1911

UnattendedSlotsLimitExceeded

License

1912

LicenseUnregistered

License

1913

LicenseNotAvailable

License

1914

NotEnoughAvailableSlots

Robot Licensing Failed. There are no available licenses on the server.

This error message is displayed in the Job Details if you tried to execute a job on a machine that is not licensed, the job has the state Pending, a robot assigned.

1915

NotEnoughRuntimeLicenses

Robot Licensing Failed. There are no available licenses on the server.

1916

SlotsExceedLicenseLimit

No available licenses: the number of new machine slots would exceed the total license count.

License

1917

NotEnoughAvailableLicenses

There are not enough {0

License

1918

HostLicenseLimitExceeded

License

1919

NoHostLicense

License

1920

LicenseNewInvalidArguments

License

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.