Rufen Sie den täglichen Verbrauch des Mandanten nach Dienst ab

POST-Endpunkt zum Abrufen einer täglichen Aufschlüsselung des Verbrauchs nach Dienst für einen bestimmten Mandanten, mit optionalen Ordner- und Besitzfiltern.

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

API-Endpunkt

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

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.

Anforderungstext

Im Anforderungstext werden der Mandant, der Datumsbereich, der Verbrauchscode und optionale Filter angegeben. Eine detaillierte Liste der Verbrauchscodes finden Sie unter Verbrauchsmaterialien.

{
  "tenantId": "string",
  "startDate": 0,
  "endDate": 0,
  "consumableCode": "string",
  "aggregateByOwnership": false,
  "folderKeys": ["string"],
  "timeZoneId": "string"
}

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.
• 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.
• folderKeys ist optional. Geben Sie eine Liste von Ordner-GUIDs an, um die Ergebnisse nur für bestimmte Ordner zu filtern.
• timeZoneId ist optional (Standard: UTC). Eine IANA-Zeitzonen-ID (z. B. Asia/Tokyo), die verwendet wird, um den Verbrauch in Tagen zu gruppieren. Wenn sie weggelassen oder auf UTC festgelegt sind, sind Tage UTC-Tage. Dies hat keine Auswirkungen auf startDate oder endDate, die exakte Unix-Sekunden-Instanzen bleiben. Nicht unterstützte Werte geben den Fehler 400 Bad Request zurück.

Antworten

200 OK

Gibt eine Liste der täglichen Verbrauchsdatensätze zurück, gruppiert nach Dienst für den angegebenen Mandanten.

Hinweis:

date -Werte (Format YYYY-MM-DD) stellen Tage in der über timeZoneId angeforderten Zeitzone dar.

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/daily-consumption-by-service' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenantId": "string",
  "startDate": 1704067200,
  "endDate": 1706745600,
  "consumableCode": "consumption_unit_code",
  "timeZoneId": "Asia/Tokyo"
}'

Hier ist der Antworttext für einen erfolgreichen Abruf des täglichen Verbrauchs:

{
  "items": [
    {
      "date": "2024-01-15",
      "service": "string",
      "consumedAmount": 0
    }
  ]
}