Obtenir la consommation de locataires par processus

Ventilation de la consommation par processus pour un locataire spécifique, avec pagination, tri, filtrage et répartition facultative par service.

Utilisez ce point de terminaison pour récupérer une répartition de la consommation par processus pour un locataire spécifique.

Remarque :

Contrairement à Obtenir le résumé de la consommation du locataire, ce point de terminaison ne nécessite pas d’autorisations d’administrateur d’organisation. Un utilisateur disposant d'une autorisation d'affichage de licence à l'échelle du locataire peut l'appeler.

Point de terminaison de l’API

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

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 {access_token}'
--header 'Content-Type: application/json'

Remarque :

Pour obtenir le {access_token}, assurez-vous de vous authentifier via la méthode Identifiants de mot de passe du propriétaire de la ressource décrite dans Méthodes d’authentification.

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.

Corps de la requête

Le corps de la demande spécifie le locataire, la plage de dates et les filtres facultatifs, la pagination et les options de tri.

{
  "tenantId": "string",
  "startDate": 0,
  "endDate": 0,
  "aggregateByOwnership": false,
  "processNameFilter": "string",
  "processType": "string",
  "folderKeys": ["string"],
  "skip": 0,
  "take": 50,
  "sortBy": "string",
  "sortDescending": true,
  "includeServiceBreakdown": false
}

Remarque :

• tenantId est nécessaire. L’ID du locataire pour lequel récupérer la consommation.
• startDate et endDate sont des horodatages Unix en secondes. Les deux limites sont inclusives. Les valeurs fournies en millisecondes sont rejetées avec une erreur 400 Bad Request indiquant que des secondes sont attendues.
• aggregateByOwnership est facultatif (par défaut: false). Lorsqu’elle est définie sur true, la consommation est agrégée par le dossier qui possède le processus plutôt que de l’endroit où il a été exécuté.
• processNameFilter est facultatif. Filtre les résultats par nom de processus.
• processType est facultatif. Filtre les résultats par type de processus.
• folderKeys est facultatif. Fournissez une liste de GUID de dossier pour limiter les résultats à des dossiers spécifiques.
• skip est facultatif (par défaut: 0). Décalage de la pagination.
• take est facultatif (par défaut: 50). Taille de la page.
• sortBy est facultatif (par défaut: runs). Soit runs, soit un code de type d'unité (AIU, AGU, PLTU, RU, SPR, TEU, HEAL, APICALLS).
• sortDescending est facultatif (par défaut: true). Sens de tri.
• includeServiceBreakdown est facultatif (par défaut: false). Lorsqu'il est défini sur true, chaque processus inclut une répartition par service.

Réponses

200 OK

Renvoie la répartition de la consommation par processus pour le locataire spécifié.

Remarque :

• totalCount correspond au nombre de processus correspondant aux filtres, avant la pagination.
• consumedUnits répertorie les codes de type d'unité présents dans les résultats.
• Chaque élément de items inclut processKey, processName, processType, folderKey, runs et consumption (un tableau de { "unit": string, "quantity": number } objets).
• consumptionByService est inclus sur chaque élément uniquement lorsque includeServiceBreakdown est true, sous la forme d'un tableau d'objets { "service": string, "unitBreakdown": [{ "unit": string, "quantity": number }] }.
• subProcesses est facultatif et, lorsqu'il est présent, utilise la même forme que items.

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-by-process' \
--header 'Authorization: Bearer <your-access-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenantId": "4b8f2f6e-1c33-4c8a-9f4e-2c1a7d3b5e90",
  "startDate": 1754006400,
  "endDate": 1756684799,
  "sortBy": "runs",
  "includeServiceBreakdown": true
}'

Voici le corps de la réponse pour une utilisation réussie par récupération de processus:

{
  "totalCount": 1,
  "consumedUnits": ["RU", "AIU"],
  "items": [
    {
      "processKey": "9d3c1a2b-7e45-4f10-b2aa-0c6d8e914f77",
      "processName": "InvoiceProcessing",
      "processType": "Process",
      "folderKey": "2f6e4b8f-1c33-4c8a-9f4e-2c1a7d3b5e90",
      "runs": 128,
      "consumption": [
        { "unit": "RU", "quantity": 12.5 },
        { "unit": "AIU", "quantity": 340 }
      ],
      "consumptionByService": [
        { "service": "Orchestrator", "unitBreakdown": [{ "unit": "RU", "quantity": 12.5 }] },
        { "service": "Document Understanding", "unitBreakdown": [{ "unit": "AIU", "quantity": 340 }] }
      ]
    }
  ]
}