Mandantenverbrauch nach Prozess abrufen

Aufschlüsselung des Verbrauchs nach Prozess für einen bestimmten Mandanten, mit Paginierung, Sortierung, Filterung und optionaler Aufschlüsselung pro Dienst.

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

Hinweis:

Im Gegensatz zu „Get Tenant Verbrauchszusammenfassung“ erfordert dieser Endpunkt keine Organisationsadministratorberechtigungen. Ein Benutzer mit mandantenbezogener Lizenzanzeigeberechtigung für den Mandanten kann ihn aufrufen.

API-Endpunkt

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

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 {access_token}'
--header 'Content-Type: application/json'

Hinweis:

Um das {access_token} zu erhalten, müssen Sie sich mit der ROPC-Methode (Resource Owner Password Credentials) authentifizieren, die in Authentifizierungsmethoden beschrieben ist.

Pfadparameter

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

Anforderungstext

Der Anforderungstext gibt den Mandanten, den Datumsbereich sowie optionale Filter, Paginierungs- und Sortieroptionen an.

{
  "tenantId": "string",
  "startDate": 0,
  "endDate": 0,
  "aggregateByOwnership": false,
  "processNameFilter": "string",
  "processType": "string",
  "folderKeys": ["string"],
  "skip": 0,
  "take": 50,
  "sortBy": "string",
  "sortDescending": true,
  "includeServiceBreakdown": false
}

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 durch den Ordner aggregiert, der den Prozess besitzt, und nicht durch den Ordner, in dem er ausgeführt wurde.
• processNameFilter ist optional. Filtert Ergebnisse nach Prozessname.
• processType ist optional. Filtert Ergebnisse nach Prozesstyp.
• folderKeys ist optional. Geben Sie eine Liste von Ordner-GUIDs an, um die Ergebnisse auf bestimmte Ordner zu beschränken.
• skip ist optional (Standard: 0). Offset der Paginierung.
• take ist optional (Standard: 50). Seitengröße.
• sortBy ist optional (Standard: runs). Entweder runs oder ein Einheitentypcode (AIU, AGU, PLTU, RU, SPR, TEU, HEAL, APICALLS).
• sortDescending ist optional (Standard: true). Sortierrichtung.
• includeServiceBreakdown ist optional (Standard: false). Wenn true festgelegt ist, enthält jeder Prozess eine Aufschlüsselung pro Dienst.

Antworten

200 OK

Gibt die Aufschlüsselung des Verbrauchs nach Prozess für den angegebenen Mandanten zurück.

Hinweis:

• totalCount ist die Anzahl der Prozesse, die den Filtern vor der Paginierung entsprechen.
• consumedUnits listet die in den Ergebnissen vorhandenen Einheitentypcodes auf.
• Jedes Element in items enthält processKey, processName, processType, folderKey, runs und consumption (ein Array von { "unit": string, "quantity": number } -Objekten).
• consumptionByService ist nur dann in jedem Element enthalten, wenn includeServiceBreakdown true ist, als Array von { "service": string, "unitBreakdown": [{ "unit": string, "quantity": number }] } -Objekten.
• subProcesses ist optional und verwendet, wenn vorhanden, dieselbe Form wie items.

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-process' \
--header 'Authorization: Bearer <your-access-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenantId": "4b8f2f6e-1c33-4c8a-9f4e-2c1a7d3b5e90",
  "startDate": 1754006400,
  "endDate": 1756684799,
  "sortBy": "runs",
  "includeServiceBreakdown": true
}'

Hier ist der Antworttext für einen erfolgreichen Verbrauch durch Prozessabruf:

{
  "totalCount": 1,
  "consumedUnits": ["RU", "AIU"],
  "items": [
    {
      "processKey": "9d3c1a2b-7e45-4f10-b2aa-0c6d8e914f77",
      "processName": "InvoiceProcessing",
      "processType": "Process",
      "folderKey": "2f6e4b8f-1c33-4c8a-9f4e-2c1a7d3b5e90",
      "runs": 128,
      "consumption": [
        { "unit": "RU", "quantity": 12.5 },
        { "unit": "AIU", "quantity": 340 }
      ],
      "consumptionByService": [
        { "service": "Orchestrator", "unitBreakdown": [{ "unit": "RU", "quantity": 12.5 }] },
        { "service": "Document Understanding", "unitBreakdown": [{ "unit": "AIU", "quantity": 340 }] }
      ]
    }
  ]
}