Zusammenfassung des Mandantenverbrauchs nach Mandant abrufen

POST-Endpunkt zum Abrufen der Verbrauchszusammenfassung für einen bestimmten Mandanten, mit Aufschlüsselung nach Mandanten-Pool- und Organisationspoolnutzung und einer optionalen zugewiesenen Menge.

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 <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.
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",
  "includeAllocation": false
}

Feld	Datentyp	Beschreibung
startDate (erforderlich)	Long	Beginn des Datumsbereichs als Unix-Zeitstempel in Sekunden. Werte in Millisekunden werden mit einem 400 Bad Request -Fehler abgelehnt.
endDate (erforderlich)	Long	Ende des Datumsbereichs als Unix-Zeitstempel in Sekunden. Werte in Millisekunden werden mit einem 400 Bad Request -Fehler abgelehnt.
consumableCode (erforderlich)	String	Das zusammenzufassende Verbrauchsmaterial. Verwenden Sie für Robot Units RU.
includeAllocation	Boolescher	Die Standardeinstellung ist false. Bei true enthält die Antwort die dem Mandanten zugewiesene Menge für das Verbrauchsmaterial über den Datumsbereich.
tenantId	Zeichenfolge (GUID)	Dieses Feld nicht senden. Der Pfadparameter {tenantId} bestimmt den Mandanten und überschreibt jeden Wert im Textkörper.
includeTopUpBreakdown	Boolescher	An diesem Endpunkt nicht unterstützt und wird immer als false behandelt. Um den Aufstockungsverbrauch abzurufen, verwenden Sie Zusammenfassung des Mandantenverbrauchs abrufen.

Antworten

200 OK

Gibt die Verbrauchszusammenfassung für den angegebenen Mandanten und, wenn angefordert, die dem Mandanten zugewiesene Menge zurück.

Feld	Datentyp	Beschreibung
allocated	Nummer	Die dem Mandanten zugewiesene Menge für das Verbrauchsmaterial. Wird nur zurückgegeben, wenn includeAllocation true ist.
consumedFromOrgWithoutTenant	Nummer	Immer 0 an diesem Endpunkt, da der Verbrauch ohne Mandantenkontext keinem Mandanten zugeordnet wird.
consumedByTopUp	Nummer	Immer null an diesem Endpunkt, da eine Aufschlüsselung der Aufstockung pro Mandant nicht unterstützt wird.
tenantConsumptionItems[].tenantId	Zeichenfolge (GUID)	Die ID des Mandanten.
tenantConsumptionItems[].consumedFromTenantPool	Nummer	Aus der Zuteilung des Mandanten verbrauchte Einheiten.
tenantConsumptionItems[].consumedFromOrgPool	Nummer	Aus dem Organisationspool verbrauchte Einheiten.
tenantConsumptionItems[].consumedByTopUp	Nummer	Immer null an diesem Endpunkt.

Hinweis:

Behandeln Sie einen null -Wert in allocated als unbekannt, nicht als Null. allocated ist null , wenn der Mandant keine Lizenz für das abgefragte Verbrauchsmaterial hat oder wenn sich der Datumsbereich über mehr als einen Zuweisungszeitraum erstreckt, z. B. ein 90-Tage-Bereich, wenn Zuweisungen monatlich festgelegt werden. Ein Wert von 0 bedeutet, dass die Zuweisung des Mandanten Null ist.

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 <your-access-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "startDate": 1704067200,
  "endDate": 1706745600,
  "consumableCode": "consumption_unit_code",
  "includeAllocation": true
}'

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

{
  "consumedFromOrgWithoutTenant": 0,
  "consumedByTopUp": null,
  "allocated": 200,
  "tenantConsumptionItems": [
    {
      "tenantId": "string",
      "consumedFromTenantPool": 150,
      "consumedFromOrgPool": 0,
      "consumedByTopUp": null
    }
  ]
}