Obter resumo de consumo do tenant

Endpoint POST para recuperar o resumo de consumo de todos os tenants em uma organização, agrupados por tenant com detalhamento do pool de tenants e do pool da organização.

Como admin da organização, use esse ponto de extremidade para recuperar o resumo de consumo para todos os tenants em sua organização.

Ponto de Extremidade da API

POST {accessURL}/lease_/api/usage/{organizationId}/tenants/consumption-summary

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 <your-access-token>'
--header 'Content-Type: application/json'

Observação:

Para obter o <your-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)	O ID da organização para a qual recuperar o resumo de consumo.

Corpo da Solicitação

O corpo da solicitação especifica o intervalo de datas e o código de consumível para o qual recuperar o resumo. Para obter uma lista detalhada de códigos de consumíveis, consulte Consumíveis.

{
  "startDate": 0,
  "endDate": 0,
  "consumableCode": "string",
  "tenantId": "string",
  "includeTopUpBreakdown": false,
  "includeAllocation": false
}

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.
• tenantId é opcional. Quando fornecido, limita o resumo a este tenant.
• includeTopUpBreakdown é opcionalfalse (padrão:). Quando definida como true, a resposta inclui o consumo extraído de unidades de carregamento (campos consumedByTopUp).
• é opcional (padrão false includeAllocation . Quando definida como true junto com tenantId, a resposta inclui a quantidade alocada desse tenant para o consumível consultado (campo allocated ). Sem tenantId, allocated é null, porque uma solicitação em todos os tenants não tem alocação única para relatar.

Resposta

200 OK

Retorna o resumo de consumo de todos os tenants da organização.

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

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

Observação:

• consumedByTopUp é incluída no nível superior e dentro de cada entrada tenantConsumptionItems somente quando includeTopUpBreakdown é true.
• allocated é incluído no nível superior apenas quando includeAllocation é true e é null a menos que tenantId também seja fornecido. Trate null como desconhecido, não como zero, porque isso significa que a alocação não pode ser determinada.

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