Zusammenfassung des Mandantenverbrauchs abrufen

POST-Endpunkt zum Abrufen der Verbrauchszusammenfassung für alle Mandanten in einer Organisation, gruppiert nach Mandant mit Mandantenpool- und Organisationspoolaufschlüsselung.

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
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, 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",
  "tenantId": "string",
  "includeTopUpBreakdown": false,
  "includeAllocation": false
}

Hinweis:

• 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.
• tenantId ist optional. Wenn bereitgestellt, wird die Zusammenfassung auf diesen Mandanten beschränkt.
• includeTopUpBreakdown ist optional (Standard: false). Wenn auf true festgelegt ist, enthält die Antwort den Verbrauch aus Top-up-Einheiten (consumedByTopUp -Felder).
• includeAllocation ist optional (Standard: false). Wenn true zusammen mit tenantId festgelegt wird, enthält die Antwort die diesem Mandanten zugewiesene Menge für das abgefragte Verbrauchsmaterial (Feld allocated ). Ohne tenantId ist allocated null, da eine Anfrage über alle Mandanten hinweg keine einzige Zuweisung zu melden hat.

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 <your-access-token>' \
--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:

• consumedByTopUp ist nur dann auf der obersten Ebene und in jedem tenantConsumptionItems -Eintrag enthalten, wenn includeTopUpBreakdown gleich true ist.
• allocated ist nur auf der obersten Ebene enthalten, wenn includeAllocation true ist und null , es sei denn, tenantId ist auch angegeben. Behandeln Sie null als unbekannt und nicht als Null, da dies bedeutet, dass die Zuweisung nicht bestimmt werden kann.

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