Obter consumo diário do tenant por serviço

Ponto de extremidade POST para recuperar um detalhamento diário do consumo por serviço para um tenant específico, com filtros opcionais de pasta e propriedade.

Use esse ponto de extremidade para recuperar um detalhamento diário do consumo por serviço para um tenant específico.

Ponto de Extremidade da API

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

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Automation Cloud	https://cloud.uipath.com/
Automation Cloud Setor público	https://govcloud.uipath.us/
Automation Cloud dedicado	https://{customURL}.dedicated.uipath.com/

Observação:

O nome da sua organização aparece no URL logo após o URL de acesso quando você está conectado ao produto, por exemplo {accessURL}/{organizationName}/....

Cabeçalhos de solicitação.

--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'

Observação:

Para obter o {access_token}, certifique-se de se autenticar por meio do método ROPC, descrito aqui.

Parâmetros do caminho

Parâmetro do caminho	Tipo de dados	Description
organizationId (obrigatório)	String (GUID)	A ID da organização na qual seu locatário reside.

Corpo da Solicitação

O corpo da solicitação especifica o tenant, o intervalo de datas, o código do consumível e os filtros opcionais. Para obter uma lista detalhada de códigos de consumíveis, consulte Consumíveis.

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

Observação:

• startDate e endDate são carimbos de data/hora Unix em segundos. Ambos os limites são inclusivos. Os valores fornecidos em milissegundos são rejeitados com um erro 400 Bad Request indicando que são esperados segundos.
• é opcional (padrão false aggregateByOwnership . Quando definido como true, o consumo é agregado pela pasta que possui o processo em vez de onde ele foi executado.
• folderKeys opcional. Forneça uma lista de GUIDs de pasta para filtrar resultados apenas para pastas específicas.
• timeZoneId é opcionalUTC (padrão:). Um ID de fuso horário IANA (por exemplo, Asia/Tokyo) usado para agrupar o consumo em dias. Quando omitido ou definido como UTC, os dias são dias UTC. Isso não afeta startDate ou endDate, que permanecem instantâneos exatos do segundo Unix. Os valores não suportados retornam um erro 400 Bad Request.

Resposta

200 OK

Retorna uma lista de registros de consumo diários agrupados por serviço para o tenant especificado.

Observação:

Os valores date (formato YYYY-MM-DD) representam dias no fuso horário solicitado via timeZoneId.

Exemplo de solicitação

A chamada deve ser semelhante ao seguinte exemplo (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"
}'

Aqui está o corpo da resposta para uma recuperação de consumo diário bem-sucedida:

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