orchestrator
2021.10
false
- 入门指南
- 关于 OData 和引用
- 枚举类型
- 正在验证身份
- 构建 API 请求
- 每个端点的权限
- 响应代码
- 运行状况检查端点
- 身份验证
- 身份验证方法
- 外部应用程序 (OAuth)
- ROPC（不推荐）
- Swagger 定义
- 读取我
- 在 Swagger 中授权 API 调用
- 管理逻辑资源
- Orchestrator API
- 警示请求
- 资产请求
- 日历请求
- 环境请求
- 文件夹请求
- 通用任务请求
- 作业请求
- 库请求
- 许可证请求
- 包请求
- 权限请求
- 流程请求
- 机器人请求
- 角色请求
- 计划请求
- 设置请求
- 任务请求
- 任务目录请求
- 任务表单请求
- 租户请求
- 事务请求
- 用户请求
- Webhook 请求
- 平台管理 API
- 入门指南
- 关于本指南
- 可用资源：
- API 端点 URL 结构
- 枚举列表
- 作用域和权限
- 关于作用域和权限
- 平台管理作用域和权限
- 平台管理 API
- 审核日志
- 获取审核日志
- 下载审核日志
- [预览] 组
- [预览] 获取所有组
- [预览] 删除组
- [预览] 获取特定组
- [预览] 删除特定组
- [预览] 创建新的本地组
- [预览] 更新组
- [预览] 机器人帐户
- [预览] 获取所有机器人帐户
- [预览] 删除机器人帐户
- [预览] 获取特定机器人帐户
- [预览] 删除特定机器人帐户
- [预览] 创建新的机器人帐户
- [预览] 更新机器人帐户
- [预览] 用户
- [预览] 更新用户
- [预览] 删除特定用户
- [预览] 删除用户
- [预览] 更新用户密码
- [预览] 设置
- [预览] 更新设置
- 消息模板
- 获取消息模板
- 更新消息模板
- 按名称获取消息模板
重要 :
请注意，此内容已使用机器翻译进行了部分本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
不在支持范围内
Orchestrator API 指南
上次更新日期 2024年10月31日
注意： 全局和每个机器人文本资产最多支持 1,000,000 个字符。
重要提示：
$filter 查询返回自定义筛选器的结果，该筛选器在 contains 函数中使用“名称”和“说明”参数。
通过以下调用，您可以显示具有
DocAPITest 名称和 455 ID 的资产的所有可用信息。
获取
{OrchestratorURL}/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId='455',assetName='DocAPITest')
请求标头
|
密钥 |
值 |
|---|---|
|
授权 |
承载 |
响应代码
200 OK
响应正文
{
"@odata.context": "{OrchestratorURL}/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": "{OrchestratorURL}/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 。 请注意，系统仅返回每个机器人凭据资产的用户名，如以下示例所示。
获取
{OrchestratorURL}/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId(robotId=193,assetName='Testing')
请求标头
|
密钥 |
值 |
|---|---|
|
授权 |
承载 |
响应代码
200 OK
响应正文
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
"Name": "Testing",
"ValueType": "Credential",
"StringValue": "",
"BoolValue": false,
"IntValue": 0,
"CredentialUsername": "DocBot",
"CredentialPassword": ""
}{
"@odata.context": "{OrchestratorURL}/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
"Name": "Testing",
"ValueType": "Credential",
"StringValue": "",
"BoolValue": false,
"IntValue": 0,
"CredentialUsername": "DocBot",
"CredentialPassword": ""
}以下示例使您能够创建文本类型的新全局资产。
发布
{OrchestratorURL}/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": "{OrchestratorURL}/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": "{OrchestratorURL}/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": []
}