Zusammenfassung des Mandantenverbrauchs nach Mandant abrufen

POST-Endpunkt zum Abrufen der Verbrauchszusammenfassung für einen bestimmten Mandanten mit Aufschlüsselung nach Mandantenpool- und Organisationspoolnutzung.

Verwenden Sie diesen Endpunkt, um die Verbrauchszusammenfassung für einen bestimmten Mandanten in Ihrer Organisation abzurufen.

API-Endpunkt

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

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 hier beschriebenen ROPC-Methode authentifizieren.

Pfadparameter

Pfadparameter	Datentyp	Beschreibung
organizationId (erforderlich)	Zeichenfolge (GUID)	Die ID der Organisation, in der sich Ihr Mandant befindet.
tenantId (erforderlich)	Zeichenfolge (GUID)	Die ID des Mandanten, für den die Verbrauchszusammenfassung abgerufen werden soll.

Anforderungstext

Der Anforderungstext gibt den Datumsbereich und den Verbrauchscode an, für den die Zusammenfassung abgerufen werden soll. Der Mandant wird durch den Pfadparameter {tenantId} bestimmt. Eine detaillierte Liste der Verbrauchscodes finden Sie unter Verbrauchsmaterialien.

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

Hinweis:

startDate und endDate sind Unix-Zeitstempel in Sekunden.

Antworten

200 OK

Gibt die Verbrauchszusammenfassung für den angegebenen Mandanten 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/22222222-2222-2222-2222-222222222222/consumption-summary' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
  "startDate": 1704067200,
  "endDate": 1706745600,
  "consumableCode": "consumption_unit_code"
}'

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

Hinweis:

consumedFromOrgWithoutTenant spiegelt den Verbrauch wider, der auf Organisationsebene ohne Mandantenkontext erfolgt – er wird keinem bestimmten Mandanten zugeordnet.

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