Zusammenfassung des Mandantenverbrauchs abrufen

Verwenden Sie als Organisationsadministrator diesen Endpunkt, um die Verbrauchszusammenfassung für alle Mandanten in Ihrer Organisation abzurufen.

API-Endpunkt

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

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

Cloud Platform	Zugriffs-URL
Automation Cloud	https://cloud.uipath.com/
Automation Cloud – Öffentlicher Sektor	https://govcloud.uipath.us/
Automatisierung – cloudgeeignet	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, für die die Verbrauchszusammenfassung abgerufen werden soll.

Anforderungstext

Der Anforderungstext gibt den Datumsbereich und den Verbrauchscode an, für den die Zusammenfassung abgerufen werden soll. Eine detaillierte Liste der Verbrauchscodes finden Sie unter Verbrauchsmaterialien.

{
  "startDate": 0,
  "endDate": 0,
  "consumableCode": "string"
}

Hinweis:

startDate und endDate sind Unix-Zeitstempel in Millisekunden.

Antworten

200 OK

Gibt die Zusammenfassung des Verbrauchs für alle Mandanten in der Organisation zurück.

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-summary' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
  "startDate": 1704067200000,
  "endDate": 1706745600000,
  "consumableCode": "consumption_unit_code"
}'

Hier ist der Antworttext für einen erfolgreichen Abruf einer Verbrauchszusammenfassung:

{
  "consumedFromOrgWithoutTenant": 0,
  "tenantConsumptionItems": [
    {
      "tenantId": "string",
      "consumedFromTenantPool": 0,
      "consumedFromOrgPool": 0
    }
  ]
}