Requêtes relatives aux locataires

Vue d’ensemble des requêtes d’API pour les locataires permettant de récupérer les locataires activés en tant qu’administrateur d’organisation

Remarque :

Vous devez être un administrateur d'organisation pour effectuer des demandes de locataire.

Remarque :

Les paramètres AdminEmailAddress, AdminName, AdminSurname, AdminPassword, et AdminUserKey sont toujours renvoyés en tant que null.

Récupération des locataires actifs

La requête ci-dessous permet de récupérer tous les locataires activés. Notez que l'exemple de réponse a été tronqué.

Obtenir

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

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 OK

Corps de la réponse

{
    "@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
        }
    ]
}

Récupération d'un locataire en fonction de son ID

L'exemple suivant permet d'afficher les détails du locataire avec Id 99.

Obtenir

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

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 OK

Corps de la réponse

{
  "@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
    }
  }
}

Désactivation d'un locataire

Publier

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

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Corps de la requête

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

Codes de réponse

200 OK

Désactiver une fonctionnalité

Cette requête désactive la fonctionnalité de surveillance pour un locataire avec le Id sur 4 .

Pour activer la fonctionnalité, envoyez une requête au point de terminaison /odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk en définissant le paramètre Monitoring.Enabled sur true.

Publier

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

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Corps de la requête

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

Codes de réponse

200 OK