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
Automation Cloud	https://cloud.uipath.com/
Automation Cloud – Öffentlicher Sektor	https://govcloud.uipath.us/
Automatisierung – cloudgeeignet	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 and endDate are Unix timestamps in seconds. Both bounds are inclusive. Values provided in milliseconds are rejected with a 400 Bad Request error indicating that seconds are expected.
• 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 is optional (default: UTC). An IANA time zone ID (for example, Asia/Tokyo) used to group consumption into days. When omitted or set to UTC, days are UTC days. This does not affect startDate or endDate, which remain exact Unix-second instants. Unsupported values return a 400 Bad Request error.

Antworten

200 OK

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

Hinweis:

date values (format YYYY-MM-DD) represent days in the time zone requested via timeZoneId.

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
    }
  ]
}