orchestrator
2024.10
true
Orchestrator API 指南
Last updated 2024年11月11日
许可证请求
通过以下对
odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='robotType')
端点的调用,您可以检索使用命名用户许可证获得许可的所有有人值守的机器人。
注意: 此请求最多返回 1,000 个条目。
获取
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='Attended')
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/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}/{organizationName}/{tenantName}/orchestrator_/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}/{organizationName}/{tenantName}/orchestrator_/odata/LicensesRuntime('Documentation')/UiPath.Server.Configuration.OData.ToggleEnabled
{
"key": "Documentation",
"robotType": "Unattended",
"enabled": false
}
{
"key": "Documentation",
"robotType": "Unattended",
"enabled": false
}
一次只能对 一个租户执行以下请求。 如果您使用的是 Swagger,则会在发出请求时在您登录到 Orchestrator 的租户上执行此查询。 如果您使用的是 API 测试工具,则您发出此请求的租户就是用于生成持有者令牌的租户。
获取
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetLicense
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/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}/{organizationName}/{tenantName}/orchestrator_/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
}
}