Obtenir la consommation quotidienne des locataires par service

Point de terminaison POST pour récupérer la répartition quotidienne de la consommation par service pour un locataire spécifique, avec des filtres de dossier et de propriété facultatifs.

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

Point de terminaison de l’API

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

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 consommable et les filtres facultatifs. Pour obtenir une liste détaillée des codes consommables, consultez la section Consommables.

{
  "tenantId": "string",
  "startDate": 0,
  "endDate": 0,
  "consumableCode": "string",
  "aggregateByOwnership": false,
  "folderKeys": ["string"],
  "timeZoneId": "string"
}

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.
• 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é.
• folderKeys est facultatif. Fournissez une liste de GUID de dossier pour filtrer les résultats uniquement dans des dossiers spécifiques.
• timeZoneId is optional (default: UTC). An IANA time zone ID (for example, Asia/Tokyo) used to group consumption into days. When omitted or set to UTC, days are UTC days. This does not affect startDate or endDate, which remain exact Unix-second instants. Unsupported values return a 400 Bad Request error.

Réponses

200 OK

Renvoie une liste des enregistrements de consommation quotidienne regroupés par service pour le locataire spécifié.

Remarque :

date values (format YYYY-MM-DD) represent days in the time zone requested via timeZoneId.

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/daily-consumption-by-service' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenantId": "string",
  "startDate": 1704067200,
  "endDate": 1706745600,
  "consumableCode": "consumption_unit_code",
  "timeZoneId": "Asia/Tokyo"
}'

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

{
  "items": [
    {
      "date": "2024-01-15",
      "service": "string",
      "consumedAmount": 0
    }
  ]
}