Rufen Sie den Mandantenverbrauch nach Ordner ab

Verwenden Sie diesen Endpunkt, um eine Aufschlüsselung des Verbrauchs nach Ordner für einen bestimmten Mandanten abzurufen.

API-Endpunkt

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

Ersetzen Sie {accessURL} in allen Endpunktpfaden durch die Basis-URL für Ihre Cloud-Plattform:

Cloud Platform	Zugriffs-URL
Test Cloud	https://cloud.uipath.com/
Test Cloud Public Sector	https://govcloud.uipath.us/
Test Cloud Dedicated.	https://{customURL}.dedicated.uipath.com/

Anforderungsheader

--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'

Hinweis:

Um das {access_token} zu erhalten, müssen Sie sich mit der hier beschriebenen ROPC-Methode authentifizieren.

Pfadparameter

Pfadparameter	Datentyp	Beschreibung
organizationId (erforderlich)	Zeichenfolge (GUID)	Die ID der Organisation, in der sich Ihr Mandant befindet.

Anforderungstext

Im Anforderungstext werden der Mandant, der Datumsbereich, der Verbrauchscode und der optionale Aggregationsmodus angegeben. Eine detaillierte Liste der Verbrauchscodes finden Sie unter Verbrauchsmaterialien.

{
  "tenantId": "string",
  "startDate": 0,
  "endDate": 0,
  "consumableCode": "string",
  "aggregateByOwnership": false
}

Hinweis:

• startDate und endDate sind Unix-Zeitstempel in Millisekunden.
• aggregateByOwnership ist optional (Standard: false). Wenn true festgelegt ist, wird der Verbrauch nach dem Ordner aggregiert, der die Prozessausführung ausgelöst hat, und nicht nach dem Ordner, in dem sie ausgeführt wurde.

Antworten

200 OK

Gibt eine Liste von Verbrauchsdatensätzen zurück, die nach Ordnern für den angegebenen Mandanten gruppiert sind.

Beispielanforderung

Der Aufruf sollte dem folgenden Beispiel ähneln (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": 1704067200000,
  "endDate": 1706745600000,
  "consumableCode": "consumption_unit_code"
}'

Hier ist der Antworttext für eine erfolgreiche Nutzung nach Ordnerabruf:

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