Obtenir la consommation de locataires par dossier

Récupère la répartition de la consommation par dossier pour un locataire spécifique, avec une agrégation facultative par propriété de dossier.

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

Point de terminaison de l’API

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

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 dans laquelle réside votre locataire.

Corps de la requête

Le corps de la requête spécifie le locataire, la plage de dates, le code utilisable et le mode d’agrégation facultatif. Pour obtenir une liste détaillée des codes consommables, consultez la section Consommables.

{
  "tenantId": "string",
  "startDate": 0,
  "endDate": 0,
  "consumableCode": "string",
  "aggregateByOwnership": false,
  "processPersonalWorkspaces": false,
  "alwaysIncludeFolderKeys": ["string"]
}

Remarque :

• tenantId is required. The ID of the tenant for which to retrieve consumption.
• 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.
• aggregateByOwnership est facultatif (par défaut: false). Lorsqu’elle est définie sur true, la consommation est agrégée par le dossier qui a déclenché l’exécution du processus plutôt que par l’endroit où elle a été exécutée.
• processPersonalWorkspaces is optional (default: false). When set to true, personal workspaces are included in the folder breakdown as individual items, grouped under a synthetic PersonalWorkspacesRoot parent. Only workspaces with consumption in the queried window are returned. Consumption in folders that no longer exist is returned as synthetic items flagged with isDeletedFolder.
• alwaysIncludeFolderKeys is optional. Provide a list of folder GUIDs to include in the response even if they have zero consumption in the queried window. Unknown keys are ignored.

Réponses

200 OK

Renvoie une liste d’enregistrements de consommation regroupés par dossier 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/consumption-by-folder' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenantId": "string",
  "startDate": 1704067200,
  "endDate": 1706745600,
  "consumableCode": "consumption_unit_code"
}'

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

Remarque :

• isPersonalWorkspace is true when the item is a personal workspace.
• isDeletedFolder is true when the item represents consumption from a deleted folder.

{
  "items": [
    {
      "folderKey": "string",
      "folderName": "string",
      "parentFolderKey": "string",
      "consumedBySelf": 0,
      "processCountSelf": 0,
      "isPersonalWorkspace": false,
      "isDeletedFolder": false
    }
  ]
}