orchestrator
2023.10
false
- 入门指南
- 身份验证
- Swagger 定义
- Orchestrator API
- 平台管理 API
重要 :
新发布内容的本地化可能需要 1-2 周的时间才能完成。
Orchestrator API 指南
上次更新日期 2026年3月24日
资产请求
备注：
全局文本资产和每个机器人的文本资产最多支持 1,000,000 个字符。
重要提示：
$filter查询返回自定义筛选器的结果，该筛选器在contains函数中使用“名称”和“说明”参数。- 扩展机器人值 (
GET "https://{yourDomain}/odata/Assets/UiPath.Server.Configuration.OData.GetFiltered?%24expand=UserValues") 的资产请求首先检索UserValues，然后将其转换为RobotValues。
检索特定资产
通过以下调用，您可以显示具有 DocAPITest 名称和 455 ID 的资产的所有可用信息。
获取
https://{yourDomain}/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId='455',assetName='DocAPITest')
请求标头
| 密钥 | 值 |
|---|---|
| 授权 | 承载 |
响应代码
200 OK
响应正文
{
"@odata.context": "https://{yourDomain}/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
"Name": "DocAPITest",
"ValueType": "Text",
"StringValue": "An asset added through an API call",
"BoolValue": false,
"IntValue": 0,
"CredentialUsername": "",
"CredentialPassword": ""
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
"Name": "DocAPITest",
"ValueType": "Text",
"StringValue": "An asset added through an API call",
"BoolValue": false,
"IntValue": 0,
"CredentialUsername": "",
"CredentialPassword": ""
}
按机器人检索资产
要对 /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId() 端点执行 GET 请求，您需要在 URL 中提供 robotId 和 assetName 。 请注意，系统仅返回每个机器人凭据资产的用户名，如以下示例所示。
获取
https://{yourDomain}/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId(robotId=193,assetName='Testing')
请求标头
| 密钥 | 值 |
|---|---|
| 授权 | 承载 |
响应代码
200 OK
响应正文
{
"@odata.context": "https://{yourDomain}/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
"Name": "Testing",
"ValueType": "Credential",
"StringValue": "",
"BoolValue": false,
"IntValue": 0,
"CredentialUsername": "DocBot",
"CredentialPassword": ""
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
"Name": "Testing",
"ValueType": "Credential",
"StringValue": "",
"BoolValue": false,
"IntValue": 0,
"CredentialUsername": "DocBot",
"CredentialPassword": ""
}
添加资产
以下示例使您能够创建文本类型的新全局资产。
发布
https://{yourDomain}/odata/Assets
请求标头
| 密钥 | 值 |
|---|---|
| 授权 | 承载 |
请求正文
{
"Name": "DocAPITest",
"ValueScope": "Global",
"ValueType": "Text",
"StringValue": "An asset added through an API call"
}
{
"Name": "DocAPITest",
"ValueScope": "Global",
"ValueType": "Text",
"StringValue": "An asset added through an API call"
}
响应代码
200 OK
响应正文
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Assets/$entity",
"Name": "DocAPITest",
"CanBeDeleted": true,
"ValueScope": "Global",
"ValueType": "Text",
"Value": "An asset added through an API call",
"StringValue": "An asset added through an API call",
"BoolValue": false,
"IntValue": 0,
"CredentialUsername": "",
"CredentialPassword": "",
"Id": 455,
"KeyValueList": []
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Assets/$entity",
"Name": "DocAPITest",
"CanBeDeleted": true,
"ValueScope": "Global",
"ValueType": "Text",
"Value": "An asset added through an API call",
"StringValue": "An asset added through an API call",
"BoolValue": false,
"IntValue": 0,
"CredentialUsername": "",
"CredentialPassword": "",
"Id": 455,
"KeyValueList": []
}