orchestrator
2022.10
false
  • 入门指南
    • 关于 OData 和引用
    • 枚举类型
    • 正在验证身份
    • 构建 API 请求
    • 每个端点的权限
    • 响应代码
    • 运行状况检查端点
  • Swagger 定义
  • Orchestrator API
重要 :
请注意此内容已使用机器翻译进行了部分本地化。 新发布内容的本地化可能需要 1-2 周的时间才能完成。
UiPath logo, featuring letters U and I in white

Orchestrator API 指南

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
上次更新日期 2024年6月22日

响应代码

Orchestrator API 会尝试为每个请求返回相应的 HTTP 状态代码

除此之外,Orchestrator API 还会返回一些自定义错误代码。 下表介绍了每个错误以及遇到这些错误的时间。

代码

文本

描述

1000

请求无效!

用户名/电子邮件地址或密码无效。

OData 查询选项无效。

泛型

1001

NameAlreadyUsed

已使用名称 [CustomNameYouAdded]。

如果您尝试使用数据库中已存在的名称创建或编辑资源,则会引发错误消息。

以下端点返回此错误:

  • POST 和 PUT - /odata/Assets
  • POST 和 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 和 PATCH - /odata/Releases
  • POST、PUT 和 PATCH - /odata/Machines
  • POST 和 PUT - /odata/Robots
  • POST - /odata/Robots/UiPath.Server.Configuration.OData.ConvertToFloating
  • POST 和 PUT - /odata/ProcessSchedules
  • POST - /odata/Roles
  • POST - /odata/Users

1002

ItemNotFound

Robot 不存在。

如果您向数据库中不存在的资源发出请求,则会引发错误消息。 系统会为租户、资产、作业、主机许可证、队列和队列项目、流程、设置和用户返回此信息。

1003

StringProtectFailed

针对所提供字符串的保护调用失败。

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

1004

ItemAlreadyExists

如果您尝试创建数据库中已存在的资产或机器人,则会引发此消息。 这也适用于上传包。

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 和 PATCH - /odata/Machines
  • POST 和 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

如果您尝试通过向 /odata/QueueItemComments(Id) 端点发出 PUT 请求来更新由其他用户添加的事务注释,则会显示此错误。

1008

ErrorSendingEmail

如果 Orchestrator 在对 /odata/Users 端点执行 POST、PUT 或 PATCH 请求时无法向用户发送电子邮件,则会引发错误。

1009

InvalidArgument

参数 [参数名称] 无效。

 

1010

SqlAcquireLockFailure

 

1011

LibrariesFeedInUse

无法打开库订阅源。请稍后再试。

如果由于各种原因无法访问库订阅源,则会显示此消息。

以下端点可能会返回错误:

  • 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

如果您尝试删除的组织单位有与之关联的用户,则会引发此错误。 这是对 /odata/OrganizationUnits 端点进行 DELETE 调用时显示的错误。

1013

ItemIsInUse

此程序包在活动流程中引用,无法删除。

尝试删除处于活动状态的包版本时显示错误,例如对 https:/uipath.platform.com/odata/Processes('input_output_test%3A1.1.0') 的 DELETE 请求。 只能删除非活动包(未与环境关联)。

1014

ParameterMissing

缺少参数 [ParameterName]。

这是未提供必需参数时引发的一般错误。

以下端点可能会显示此错误:

  • 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

参数 [ParameterName] 无效。

值必须介于 0 和 168 之间。

在以下情况下会显示此错误:

  • 如果您在向 /odata/Settings('AttendedRobot.RunDisconnectedHours') 端点发出 PUT 请求时为“运行断开连接的小时数”设置提供了无效值。
  • Throw new BadRequestException(ErrorCode .ParameterInvalid, nameof(Resource.DeepPaginationNotPossibleInElasticsearch), null, DefaultElasticMaxResultWindow);

1016

DuplicateReference

创建 [ReferenceName] 时出错。 重复引用。 (示例:创建 UiPath.Core.Model.Queues.UiQueueItem 时出错。 重复引用。)

如果您尝试使用已存在的引用添加队列项目,则会显示此错误。 仅当您将队列设置为仅使用唯一引用时,才会发生这种情况。

1017

ForbiddenOperation

不允许下载指定的包。

必须接受条款和条件。

如果您通过身份验证的用户无权下载特定包或库,则会显示一条消息,方法是对 /odata/Processes/UiPath.Server.Configuration.OData.DownloadPackage(key='key') 或“/odata/Libraries/UiPath.Server.Configuration.OData.DownloadPackage(key= '{键

1018

InvalidUser

无法连接到 AD 域。

用户不存在。

当您尝试导入不是指定域成员的 AD 用户时,将显示此错误消息。

1050

InvalidAuditRelationship

无法包含指定的关系。

审核

1100

InvalidOrganizationUnit

该用户不再与组织单位关联。

仅在启用组织单位时显示。

如果您尝试使用与您尝试访问的组织单位不同的用户拨打电话,则会显示此错误。

1101

RequiredOrganizationUnit

An organization unit is required for this action.

仅当在 Orchestrator 实例上启用了组织单位时才显示。

在不包含组织单位作为参数的情况下发出 POST 请求端点时,将引发错误。

1102

OrganizationUnitNotEditable

组织单位不存在或不再与用户关联。

仅在启用组织单位时显示。

如果您通过身份验证的用户未与作为参数提供的组织单位关联或不存在,则向 /odata/Users(Id)/UiPath.Server.Configuration.OData.ToggleOrganizationUnit 端点发出 POST 请求时,将引发此错误消息。

1200

MachineAlreadyPairedWithDifferentLicenseKey

此计算机上已有一个机器人,具有不同的许可证密钥。

如果指定计算机上已存在具有不同许可证密钥的机器人,则会显示此错误消息。 系统会针对以下端点引发此错误:

  • POST、PUT 和 PATCH - /odata/Machines/
  • POST 和 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

如果 Orchestrator 上没有您尝试开始作业的机器人的许可证,则会引发此错误消息。

1202

HasAttachedRobots

无法删除计算机 [计算机名称],因为它附加了机器人。

如果您尝试删除已定义机器人的计算机,则会引发此错误消息。

1203

InvalidLicenseKey

许可证密钥无效。

计算机密钥已连接到另一台计算机!

机器人

1204

MachineNameRequired

机器人

1205

UserNameRequired

如果设置了密码,则用户名为必填项。

 

1206

CannotDeleteBusyRobot

无法修改或删除忙碌的机器人。

如果您尝试删除当前正在执行作业的机器人,则会显示此消息。

1207

MachineNameCannotChange

机器人

1208

MachineLicenseCannotChange;
InvalidNonProductionMachineSlots;
InvalidUnattendedMachineSlots

机器人

1209

CannotUpdateBusyRobot

无法更新繁忙机器人的用户名、计算机或类型!

如果您尝试更新当前正在执行作业的机器人,则会显示此消息。

1222

RobotStatusNotification

这是在机器人与 Orchestrator 断开连接时触发的警示。

1223

RobotStatusNotification

这是当连接到 Orchestrator 的机器人无响应时触发的警示。

1250

EnvironmentDeploymentConflict

在以下情况下将引发此错误消息:

  • 如果您尝试与环境关联的包已部署到流程。
  • 如果您尝试与环境关联的机器人已部署到其他环境。

1300

ServerConflict

冲突 (409)

1301

ActionAlreadyPerformed

冲突 (409)

1302

UnavailableResources

冲突 (409)

1400

UserIsDeleted

授权、用户、角色

1401

UserIsLockedOut

授权、用户、角色

1403

ChangePassword

更改密码

授权、用户、角色

1404

PasswordExpired

密码已过期。

当您尝试登录的密码已过期时,系统会显示此错误消息。

1405

InvalidPassword

授权、用户、角色

1406

CannotDeleteStaticRole

如果您尝试删除管理员角色,则会显示此消息。

1407

UserNotEditable

当前对其进行身份验证的用户无权编辑指定用户。

1408

DomainUnreachable

授权、用户、角色

1409

PasswordResetFailed

如果密码重置过程失败,则会显示此错误消息。

1410

ConfirmEmailFailed

电子邮件确认失败

 

1411

CannotUsePreviousPassword

如果您在重置密码过程中尝试使用旧密码,则会返回此错误。

1412

RoleIsNotEditable

如果您尝试更改无法编辑的管理员角色,则会显示此消息。

1413

UserNotFoundInDomain

如果您尝试配置到 Orchestrator 的域用户不属于定义的 Active Directory,则会引发此错误。

1414

CannotUpdateUsername

无法更新用户名!

授权、用户、角色

1415

InvalidLoginMethod

授权、用户、角色

1500

CredentialAssetEmptyPasswordForNewUser

凭据资产不能为新用户提供空密码。

 

1501

CredentialAssetEmptyPasswordForNewRobot

凭据资产不能为新机器人提供空密码。

如果在创建凭据资产时未同时提供密码值,则会显示此消息。

1502

AssetTypeNonUpdatable

资产类型无法更新。

如果您尝试通过 PUT 请求更改资产类型,则会引发此错误。

1503

AssetNotAvailableForRobot

资产没有与此机器人关联的值。

如果您发出的请求是针对 PerRobot 资产的,但所提供的机器人未与给定资产关联,则会显示此消息。

1600

InvalidCron

Cron 表达式语法无效

您尝试添加的计划包含无效的 Cron 表达式。

1601

ScheduleWillNeverRun

 

1650

DownloadUnavailable

流程/包/作业

1651

CannotConnectToPackagesRepository

无法连接到包订阅源,URL 可能无效。

流程/包/作业

1652

NotSupportedByExternalFeeds

外部订阅源不支持

流程/包/作业

1653

ErrorDownloading

流程/包/作业

1654

InvalidPackageDetails

包详细信息无效!

流程/包/作业

1655

TenantFeedInUse

无法打开包订阅源。请稍后再试。

流程/包/作业

1656

InvalidProcessKey

流程/包/作业

1657

JobTypeCannotBeStopped

流程/包/作业

1658

JobCannotBeCancelled

无法取消状态为 [Status] 的作业。这只能应用于状态为“正在运行”、“待定”或“停止”的作业。

如果您尝试取消具有以下状态之一的作业,则会显示此消息:成功、故障、正在终止、已停止。

1659

JobCannotBeTerminated

无法终止状态为 [Status] 的作业。这只能应用于状态为“正在运行”、“待定”或“停止”的作业。

如果您尝试取消具有以下状态之一的作业,则会显示此错误:成功、故障、已停止。

1660

VersionNotFound

找不到作业的包 [PackageName],版本 [VersionNumber]。

如果在尝试启动作业时在 NuGet 订阅源中找不到具有指定版本的包,则会引发此错误。

1661

ProcessNotFound,
PackageNotFound

关联的流程不再存在。

流程/包/作业

1662

HasAttachedProcesses

流程/包/作业

1663

InvalidExtension

流程/包/作业

1664

InvalidPackageCount

流程/包/作业

1665

PreviousVersionNotFound

流程/包/作业

1666

HasRunningJobs

流程/包/作业

1667

TenantNotFound

找不到租户。

 

1670

PendingJobsAlreadyExist

对于此流程,机器人已经有待定作业。

当您在同一流程和机器人上已有待处理作业时,将显示此消息。

1671

InvalidStartJobRobotIds

指定的机器人 ID 无效。

流程/包/作业

1672

UnregisteredCannotStartJobs

无法开始作业。需要有效的许可证。

流程/包/作业

1673

LicenseExpiredCannotStartJobs

许可证已过期,无法再开始作业。

流程/包/作业

1674

InvalidReleaseKey

未定义流程

您尝试启动作业的流程的 ID 无效。

1675

InvalidPackageVersion

包版本无效。

流程/包/作业

1676

TenantIsDisabled

租户 [NameOfTenant] 已禁用!

流程/包/作业

1677

PackageNotFound

 

1678

BackgroundJobNotification

如果计划没有可用的机器人,则会引发此错误,因此无法创建作业。

1679

PathTooLong

 

1680

JobStatusNotification

作业失败时会生成此警示。

1700

CyberArkEditPasswordNotAllowed

第三方组件

1750

LogMessageNotFound

日志

1800

EncryptionKeyNotFound

配置

1801

EncryptionKeyIncorrectFormat

配置的加密密钥不是有效的 Base64 格式。

配置

1850

TransactionReferenceRequired

队列/队列项目

1851

InvalidTransactionProgressStatus

您尝试更新的事务的进度状态与您要执行的更新不正确。

1852

TransactionNotStarted

队列/队列项目

1853

ReviewerNotAvailable

您尝试将其分配为事务的审核人的用户不具有所需的权限(对事务的查看和编辑)。

1855

QueueDefinitionParametersCannotChange

队列/队列项目

1856

QueueTransactionStatusNotification

如果针对项目引发了应用程序并且不再重试,则会显示此消息错误。

1900

LicenseNotFound

找不到许可证。

许可证

1901

LicenseExpired

许可证已过期!

许可证

1902

LicenseAlreadyInUse

许可证已在使用!

许可证

1903

InvalidLicenseFormat

许可证格式无效。

许可证

1904

LicenseLimitExceeded

许可证

1905

UnattendedLicenseLimitExceeded

许可证

1906

NonProductionLicenseLimitExceeded

许可证

1907

AttendedLicenseLimitExceeded

许可证

1908

DevelopmentLicenseLimitExceeded

许可证

1909

RobotFailedToAcquireLicense

许可证

1910

NonProductionSlotsLimitExceeded

许可证

1911

UnattendedSlotsLimitExceeded

许可证

1912

LicenseUnregistered

许可证

1913

LicenseNotAvailable

许可证

1914

NotEnoughAvailableSlots

机器人许可失败。服务器上没有可用的许可证。

如果您尝试在未获得许可的计算机上执行作业,该作业的状态为“待定”,即已分配机器人,则“作业详细信息”中将显示此错误消息。

1915

NotEnoughRuntimeLicenses

机器人许可失败。服务器上没有可用的许可证。

1916

SlotsExceedLicenseLimit

没有可用许可证: 新计算机插槽的数量将超过许可证总数。

许可证

1917

NotEnoughAvailableLicenses

没有足够的 {0

许可证

1918

HostLicenseLimitExceeded

许可证

1919

NoHostLicense

许可证

1920

LicenseNewInvalidArguments

许可证

此页面有帮助吗?

获取您需要的帮助
了解 RPA - 自动化课程
UiPath Community 论坛
Uipath Logo White
信任与安全
© 2005-2024 UiPath。保留所有权利。