テナントの要求

注: テナント要求を作成するには、ホスト管理者である必要があります。

注: AdminEmailAddress、AdminName、AdminSurname、AdminPassword、および AdminUserKey の各パラメーターは、常に null として返されます。

アクティブなテナントを取得する

以下の要求では、有効化されているすべてのテナントを取得できます。この応答例は切り詰められていることに注意してください。

GET

{OrchestratorURL}/odata/Tenants?$filter=IsActive eq true

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

200 OK

応答本文

{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#Tenants",
    "@odata.count": 125,
    "value": [{
            "Name": "mynewtenant",
            "AdminEmailAddress": null,
            "AdminName": null,
            "AdminSurname": null,
            "AdminPassword": null,
            "LastLoginTime": "2017-12-04T16:20:58.65Z",
            "IsActive": true,
            "Id": 93,
            "License": null
        },
    {...},
        {
            "Name": "testing_orche",
            "AdminEmailAddress": null,
            "AdminName": null,
            "AdminSurname": null,
            "AdminPassword": null,
            "LastLoginTime": "2018-01-16T03:40:43.073Z",
            "IsActive": true,
            "Id": 100,
            "License": null
        }
    ]
}

ID に従ってテナントを取得する

次の例では、Id が 99 のテナントの詳細を表示できます。

GET

{OrchestratorURL}/odata/Tenants(99)

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

200 OK

応答本文

{
  "@odata.context": "{OrchestratorURL}/odata/$metadata#Tenants/$entity",
  "Name": "Documentation",
  "AdminEmailAddress": null,
  "AdminName": null,
  "AdminSurname": null,
  "AdminPassword": null,
  "LastLoginTime": "2018-11-26T11:28:03.56Z",
  "IsActive": true,
  "Id": 99,
  "License": {
    "HostLicenseId": null,
    "CreationTime": "2018-01-12T11:49:48.177Z",
    "Code": "1234567890",
    "Id": 99,
    "Allowed": {
      "Unattended": 99,
      "Attended": 99,
      "NonProduction": 99,
      "Development": 99
    }
  }
}

テナントを無効化する

POST

{OrchestratorURL}/odata/Tenants/UiPath.Server.Configuration.OData.SetActive

要求ヘッダー

キー	値 (Value)
認可	Bearer

要求本文

{
    "tenantIds": [375],
    "active": false
}

応答コード

200 OK

機能を無効化する

この要求は、Id が 4 のテナントの監視機能を無効化します。

監視機能を有効化するには、Monitoring.Enabled パラメーターを true に設定して、/odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk エンドポイントに要求を送信します。

POST

{OrchestratorURL}/odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk

要求ヘッダー

キー	値 (Value)
認可	Bearer

要求本文

{
    "Name": "Monitoring.Enabled",
    "TenantId": [4]
    "Value": False
}

応答コード

200 OK