Obtenir le résumé de la consommation des locataires par locataire

Utilisez ce point de terminaison pour récupérer le récapitulatif de la consommation d'un locataire spécifique de votre organisation.

Point de terminaison de l’API

POST {accessURL}/lease_/api/usage/{organizationId}/tenants/{tenantId}/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
Automation Cloud	https://cloud.uipath.com/
Automation Cloud pour le Secteur public	https://govcloud.uipath.us/
Cloud d'automatisation 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 dans laquelle réside votre locataire.
tenantId (requis)	Chaîne (GUID)	L’ID du locataire pour lequel 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é. Le locataire est déterminé par le paramètre de chemin {tenantId} . 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écapitulatif de la consommation pour le locataire spécifié.

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/22222222-2222-2222-2222-222222222222/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:

Remarque :

consumedFromOrgWithoutTenant reflète la consommation qui se produit au niveau de l’organisation sans contexte de locataire - elle n’est attribuée à aucun locataire spécifique.

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