Obtenir le résumé de la consommation des locataires

Point de terminaison POST pour récupérer le résumé de la consommation de tous les locataires d'une organisation, regroupés par locataire avec la répartition du pool de locataires et du pool d'organisation.

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/

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 {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",
  "tenantId": "string",
  "includeTopUpBreakdown": false,
  "includeAllocation": false
}

Remarque :

• startDate and endDate are Unix timestamps in seconds. Both bounds are inclusive. Values provided in milliseconds are rejected with a 400 Bad Request error indicating that seconds are expected.
• tenantId is optional. When provided, limits the summary to this tenant.
• includeTopUpBreakdown is optional (default: false). When set to true, the response includes the consumption drawn from top-up units (consumedByTopUp fields).
• includeAllocation is optional (default: false). When set to true, the response includes the allocated amount for the queried consumable (allocated field).

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": 1704067200,
  "endDate": 1706745600,
  "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 :

• consumedByTopUp is included at the top level and within each tenantConsumptionItems entry only when includeTopUpBreakdown is true.
• allocated is included at the top level only when includeAllocation is true.

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