Rufen Sie den Mandantenverbrauch nach Ordner ab

Ruft die Aufschlüsselung des Verbrauchs nach Ordner für einen bestimmten Mandanten ab, mit optionaler Aggregation nach Ordnerbesitz.

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/

Hinweis:

Der Name Ihrer Organisation wird in der URL direkt nach der Zugriffs-URL angezeigt, wenn Sie beim Produkt angemeldet sind, z. B. {accessURL}/{organizationName}/....

Anforderungsheader

--header 'Authorization: Bearer <your-access-token>'
--header 'Content-Type: application/json'

Hinweis:

Um das <your-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,
  "processPersonalWorkspaces": false,
  "alwaysIncludeFolderKeys": ["string"]
}

Hinweis:

• tenantId ist erforderlich. Die ID des Mandanten, für den der Verbrauch abgerufen werden soll.
• startDate und endDate sind Unix-Zeitstempel in Sekunden. Beide Grenzen sind inklusiv. In Millisekunden angegebene Werte werden mit einem 400 Bad Request -Fehler abgelehnt, der angibt, dass Sekunden erwartet werden.
• 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.
• processPersonalWorkspaces ist optional (Standard: false). Wenn auf true festgelegt, sind persönliche Arbeitsbereiche als einzelne Elemente in der Ordneraufschlüsselung enthalten, die unter einem synthetischen PersonalWorkspacesRoot -Übergeordneten Element gruppiert sind. Nur Arbeitsbereiche mit Verbrauch im abgefragten Fenster werden zurückgegeben. Der Verbrauch in Ordnern, die nicht mehr vorhanden sind, wird als synthetische Elemente zurückgegeben, die mit isDeletedFolder gekennzeichnet sind.
• alwaysIncludeFolderKeys ist optional. Geben Sie eine Liste von Ordner-GUIDs an, die in die Antwort aufgenommen werden sollen, auch wenn sie im abgefragten Fenster keinen Verbrauch haben. Unbekannte Schlüssel werden ignoriert.

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": 1704067200,
  "endDate": 1706745600,
  "consumableCode": "consumption_unit_code"
}'

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

Hinweis:

• isPersonalWorkspace ist true, wenn es sich bei dem Element um einen persönlichen Arbeitsbereich handelt.
• isDeletedFolder ist true, wenn das Element den Verbrauch aus einem gelöschten Ordner darstellt.

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