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

Point de terminaison POST pour récupérer le récapitulatif de la consommation d'un locataire spécifique, avec la ventilation par utilisation du pool de locataires et du pool d'organisation et une quantité attribuée facultative.

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/

Remarque :

Le nom de votre organisation apparaît dans l’URL juste après l’URL d’accès lorsque vous êtes connecté au produit, par exemple {accessURL}/{organizationName}/....

En-têtes de requête.

--header 'Authorization: Bearer <your-access-token>'
--header 'Content-Type: application/json'

Remarque :

Pour obtenir le <your-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",
  "includeAllocation": false
}

Champ	Type de données	Description
startDate (requis)	Long	Début de la plage de dates, sous la forme d'un horodatage Unix en secondes. Les valeurs en millisecondes sont rejetées avec une erreur 400 Bad Request .
endDate (requis)	Long	Fin de la plage de dates, sous la forme d'un horodatage Unix en secondes. Les valeurs en millisecondes sont rejetées avec une erreur 400 Bad Request .
consumableCode (requis)	Chaîne de caractères (string)	Le consommable à résumer. Pour les Robot Units, utilisez RU.
includeAllocation	Booléen	La valeur par défaut est false. Lorsque true, la réponse inclut la quantité allouée au locataire pour le consommable sur la plage de dates.
tenantId	Chaîne (GUID)	N’envoyez pas ce champ. Le paramètre de chemin {tenantId} détermine le locataire et remplace toute valeur dans le corps.
includeTopUpBreakdown	Booléen	Non pris en charge sur ce point de terminaison et toujours traité comme false. Pour récupérer la consommation complémentaire, utilisez Obtenir le résumé de la consommation du locataire.

Réponses

200 OK

Renvoie le récapitulatif de la consommation pour le locataire spécifié et, lorsque la demande est requise, la quantité allouée au locataire.

Champ	Type de données	Description
allocated	Numérique	La quantité attribuée au locataire pour le consommable. Renvoyé uniquement lorsque la includeAllocation est true.
consumedFromOrgWithoutTenant	Numérique	Toujours 0 sur ce point de terminaison, car la consommation sans contexte de locataire n’est attribuée à aucun locataire.
consumedByTopUp	Numérique	Toujours null sur ce point de terminaison, car la répartition du complément n’est pas prise en charge par locataire.
tenantConsumptionItems[].tenantId	Chaîne (GUID)	L’ID du locataire.
tenantConsumptionItems[].consumedFromTenantPool	Numérique	Unités consommées à partir de l’attribution du locataire.
tenantConsumptionItems[].consumedFromOrgPool	Numérique	Unités consommées à partir du pool de l’organisation.
tenantConsumptionItems[].consumedByTopUp	Numérique	Toujours null sur ce point de terminaison.

Remarque :

Gérez une valeur null dans allocated comme inconnue, et non comme zéro. allocated est null lorsque le locataire ne dispose pas de licence pour le consommable interrogé, ou lorsque la plage de dates s'étend sur plus d'une période d'attribution, par exemple une plage de 90 jours lorsque les attributions sont définies mensuellement. Une valeur de 0 signifie que l’attribution du locataire est zéro.

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 <your-access-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "startDate": 1704067200,
  "endDate": 1706745600,
  "consumableCode": "consumption_unit_code",
  "includeAllocation": true
}'

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

{
  "consumedFromOrgWithoutTenant": 0,
  "consumedByTopUp": null,
  "allocated": 200,
  "tenantConsumptionItems": [
    {
      "tenantId": "string",
      "consumedFromTenantPool": 150,
      "consumedFromOrgPool": 0,
      "consumedByTopUp": null
    }
  ]
}