orchestrator
2022.4
false
  • 入门指南
  • 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日

许可证请求

使用指定用户许可证检索所有有人值守的机器人

通过以下对 odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='robotType') 端点的调用,您可以检索使用命名用户许可证获得许可的所有有人值守的机器人。
注意: 此请求最多返回 1,000 个条目。

获取

{OrchestratorURL}/odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='Attended')

请求标头

密钥

授权

承载

响应代码

200 OK

响应正文

{
  "@odata.context": "{OrchestratorURL}/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": "{OrchestratorURL}/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": []
    }
  ]
}

Enabling or Disabling a Machine

以下示例将禁用“文档”计算机,以便连接到该计算机的机器人不会使用 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 测试工具,则您发出此请求的租户就是用于生成持有者令牌的租户。

获取

{OrchestratorURL}/odata/Settings/UiPath.Server.Configuration.OData.GetLicense

请求标头

密钥

授权

承载

响应代码

200 OK

响应正文

{
    "@odata.context": "{OrchestratorURL}/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": "{OrchestratorURL}/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
    }
}

此页面有帮助吗?

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