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 <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.

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 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 a déclenché l’exécution du processus plutôt que par l’endroit où elle a été exécutée.
• processPersonalWorkspaces est facultatif (par défaut: false). Lorsqu’ils sont définis sur true, les espaces de travail personnels sont inclus dans la décomposition du dossier en tant qu’éléments individuels, regroupés sous un parent PersonalWorkspacesRoot synthétique. Seuls les espaces de travail avec une consommation dans la fenêtre interrogée sont renvoyés. La consommation dans les dossiers qui n'existent plus est renvoyée sous forme d'éléments synthétiques marqués avec isDeletedFolder.
• alwaysIncludeFolderKeys est facultatif. Fournissez une liste de GUID de dossier à inclure dans la réponse même s’ils n’ont pas de consommation nulle dans la fenêtre interrogée. Les clés inconnues sont ignorées.

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 est true lorsque l'élément est un espace de travail personnel.
• isDeletedFolder est true lorsque l’élément représente la consommation d’un dossier supprimé.

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