Orchestrator
2020.10
サポート対象外
Orchestrator API ガイド
Last updated 2024年6月18日

ライセンスの要求

Named User ライセンスを持つすべての Attended ロボットを取得する

The following call to the odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='robotType') endpoint enables you to retrieve all the Attended Robots that are licensed with a named user license.
Note: This request returns a maximum of 1,000 entries.

GET

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

要求ヘッダー

キー

値 (Value)

認可

Bearer

応答コード

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

次の例では、Documentation マシンに接続するロボットが NonProduction/Unattended ライセンスを消費しないように、このマシンを無効化します。

You can also enable a machine with a request to the /odata/LicensesRuntime('Key')/UiPath.Server.Configuration.OData.ToggleEnabled endpoint, by setting the enabled parameter to true.

POST

/odata/LicensesRuntime('Documentation')/UiPath.Server.Configuration.OData.ToggleEnabled

要求ヘッダー

キー

値 (Value)

認可

Bearer

要求本文

{
    "key": "Documentation",
    "robotType": "Unattended",
    "enabled": false
}{
    "key": "Documentation",
    "robotType": "Unattended",
    "enabled": false
}

応答コード

200 OK

ライセンス情報の取得

次のリクエストは、一度に1つのテナントにのみ実行できます。Swagger を使用する場合、このクエリは、リクエストを行う際に自身がログインしている Orchestrator のテナントで実行されます。API テストツールを使用している場合、このリクエストは、ベアラートークンの生成に使用されたテナントに対して実行されます。

GET

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

要求ヘッダー

キー

値 (Value)

認可

Bearer

応答コード

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
    }
}

Was this page helpful?

サポートを受ける
RPA について学ぶ - オートメーション コース
UiPath コミュニティ フォーラム
UiPath ロゴ (白)
信頼とセキュリティ
© 2005-2024 UiPath. All rights reserved.