orchestrator
2022.10
false
  • 入门指南
  • Swagger 定义
  • Orchestrator API
重要 :
请注意此内容已使用机器翻译进行了部分本地化。
Orchestrator API 指南
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated 2024年6月22日

租户请求

注意: 您必须是主机管理员才能发出租户请求。
注意: AdminEmailAddressAdminNameAdminSurnameAdminPasswordAdminUserKey 参数始终返回为 null

检索活动租户

您可以使用以下请求检索所有已启用的租户。 请注意,响应示例已被截断。

获取

https://{yourDomain}/odata/Tenants?$filter=IsActive eq true

请求标头

密钥

授权

承载

响应代码

200 OK

响应正文

{
    "@odata.context": "https://{yourDomain}/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
        }
    ]
}{
    "@odata.context": "https://{yourDomain}/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 检索租户

以下示例使您能够查看具有 99 Id的租户的详细信息。

获取

https://{yourDomain}/odata/Tenants(99)

请求标头

密钥

授权

承载

响应代码

200 OK

响应正文

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

禁用租户

发布

https://{yourDomain}/odata/Tenants/UiPath.Server.Configuration.OData.SetActive

请求标头

密钥

授权

承载

请求正文

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

响应代码

200 OK

禁用功能

此请求将为 Id 为 4 的租户禁用监控功能。
要启用此功能,请将 Monitoring.Enabled 参数设置为 true,从而向 /odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk 端点发出请求。

发布

https://{yourDomain}/odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk

请求标头

密钥

授权

承载

请求正文

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

响应代码

200 OK

此页面有帮助吗?

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