- 入门指南
- 身份验证
- Swagger 定义
- Orchestrator API
- 平台管理 API

Orchestrator API 指南
许可证请求
检索所有拥有 Named User 许可证的 Attended Robot
通过以下对 odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='robotType') 端点的调用,您可以检索使用命名用户许可证获得许可的所有有人值守的机器人。
此请求最多返回 1,000 个条目。
获取
https://{yourDomain}/odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='Attended')
请求标头
| 密钥 | 值 |
|---|---|
| 授权 | 承载 |
响应代码
200 OK
响应正文
{
"@odata.context": "https://{yourDomain}/odata/$metadata#NamedUserLicenses",
"@odata.count": 1,
"value": [
{
"UserName": "uipath\\documentation",
"Key": "uipath\\documentation",
"LastLoginDate": "2018-09-19T10:44:45.757Z",
"MachinesCount": 1,
"IsLicensed": false,
"ActiveRobotId": null,
"MachineNames": [
"MINDAGOMIR"
],
"ActiveMachineNames": []
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#NamedUserLicenses",
"@odata.count": 1,
"value": [
{
"UserName": "uipath\\documentation",
"Key": "uipath\\documentation",
"LastLoginDate": "2018-09-19T10:44:45.757Z",
"MachinesCount": 1,
"IsLicensed": false,
"ActiveRobotId": null,
"MachineNames": [
"MINDAGOMIR"
],
"ActiveMachineNames": []
}
]
}
启用或禁用计算机
以下示例将禁用“文档”计算机,以便连接到该计算机的机器人不会使用 NonProduction/Unattended 许可证。
您还可以通过将 enabled 参数设置为 true来启用具有对 /odata/LicensesRuntime('Key')/UiPath.Server.Configuration.OData.ToggleEnabled 端点的请求的计算机。
发布
https://{yourDomain}/odata/LicensesRuntime('Documentation')/UiPath.Server.Configuration.OData.ToggleEnabled
请求标头
| 密钥 | 值 |
|---|---|
| 授权 | 承载 |
请求正文
{
"key": "Documentation",
"robotType": "Unattended",
"enabled": false
}
{
"key": "Documentation",
"robotType": "Unattended",
"enabled": false
}
响应代码
200 OK
检索许可证信息
以下请求一次只能对一个租户执行。如果您使用的是 Swagger,此查询将在您发出请求时登录 Orchestrator 的租户上执行。如果您使用的是 API 测试工具,您提出此请求的租户则为用于生成持有者令牌的租户。
获取
https://{yourDomain}/odata/Settings/UiPath.Server.Configuration.OData.GetLicense
请求标头
| 密钥 | 值 |
|---|---|
| 授权 | 承载 |
响应代码
200 OK
响应正文
{
"@odata.context": "https://{yourDomain}/odata/$metadata#UiPath.Application.Dto.License.LicenseDto",
"ExpireDate": 1545392350,
"IsRegistered": true,
"Concurrent": false,
"IsExpired": false,
"AllowedRobots": {
"Unattended": 50,
"Attended": 50,
"NonProduction": 50,
"Development": 50
},
"DefinedRobots": {
"Unattended": 1,
"Attended": 0,
"NonProduction": 3,
"Development": 1
},
"ConcurrentRobots": {
"Unattended": 0,
"Attended": 0,
"NonProduction": 0,
"Development": 0
}
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#UiPath.Application.Dto.License.LicenseDto",
"ExpireDate": 1545392350,
"IsRegistered": true,
"Concurrent": false,
"IsExpired": false,
"AllowedRobots": {
"Unattended": 50,
"Attended": 50,
"NonProduction": 50,
"Development": 50
},
"DefinedRobots": {
"Unattended": 1,
"Attended": 0,
"NonProduction": 3,
"Development": 1
},
"ConcurrentRobots": {
"Unattended": 0,
"Attended": 0,
"NonProduction": 0,
"Development": 0
}
}