Obtenir le résumé de la consommation des locataires

En tant qu'administrateur de l'organisation, utilisez ce point de terminaison pour récupérer le résumé de la consommation de tous les locataires de votre organisation.

Point de terminaison de l’API

POST {accessURL}/lease_/api/usage/{organizationId}/tenants/consumption-summary

Remplacez {accessURL} dans tous les chemins de point de terminaison par l'URL de base de votre plate-forme cloud :

Cloud Platform	URL d'accès
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/

En-têtes de requête.

--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'

Remarque :

Pour obtenir le {access_token}, assurez-vous de vous authentifier via l'une des méthodes ROPC décrite ici.

Paramètres de chemin d'accès

Paramètre du chemin d'accès	Type de données	Description
organizationId (requis)	Chaîne (GUID)	L’ID de l’organisation pour laquelle récupérer le résumé de la consommation.

Corps de la requête

Le corps de la requête spécifie la plage de dates et le code consommable pour lequel récupérer le résumé. Pour obtenir une liste détaillée des codes consommables, consultez la section Consommables.

{
  "startDate": 0,
  "endDate": 0,
  "consumableCode": "string"
}

Remarque :

startDate et endDate sont des horodatages Unix en millisecondes.

Réponses

200 OK

Renvoie le résumé de la consommation à tous les locataires de l’organisation.

Exemple de requête

L’appel doit ressembler à l’exemple suivant (cURL) :

curl --location --request POST 'https://cloud.uipath.com/lease_/api/usage/11111111-1111-1111-1111-111111111111/tenants/consumption-summary' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
  "startDate": 1704067200000,
  "endDate": 1706745600000,
  "consumableCode": "consumption_unit_code"
}'

Voici le corps de la réponse pour une récupération réussie du résumé de la consommation:

{
  "consumedFromOrgWithoutTenant": 0,
  "tenantConsumptionItems": [
    {
      "tenantId": "string",
      "consumedFromTenantPool": 0,
      "consumedFromOrgPool": 0
    }
  ]
}