Obter Resumo do consumo do tenant por tenant

POST endpoint for retrieving the consumption summary for a specific tenant, with breakdown by tenant-pool and organization-pool usage and an optional allocated quantity.

Use esse ponto de extremidade para recuperar o resumo de consumo para um tenant específico em sua organização.

Ponto de Extremidade da API

POST {accessURL}/lease_/api/usage/{organizationId}/tenants/{tenantId}/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 {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.
tenantId (obrigatório)	String (GUID)	O ID do tenant para o 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. O tenant é determinado pelo parâmetro caminho {tenantId} . Para obter uma lista detalhada de códigos de consumíveis, consulte Consumíveis.

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

Campo	Tipo de dados	Description
startDate (obrigatório)	Long	Start of the date range, as a Unix timestamp in seconds. Values in milliseconds are rejected with a 400 Bad Request error.
endDate (obrigatório)	Long	End of the date range, as a Unix timestamp in seconds. Values in milliseconds are rejected with a 400 Bad Request error.
consumableCode (obrigatório)	String	The consumable to summarize. For robot units, use RU.
includeAllocation	Booleano	Defaults to false. When true, the response includes the tenant's allocated quantity for the consumable over the date range.
tenantId	String (GUID)	Don't send this field. The {tenantId} path parameter determines the tenant and overrides any value in the body.
includeTopUpBreakdown	Booleano	Not supported on this endpoint and always treated as false. To retrieve top-up consumption, use Get Tenant Consumption Summary.

Resposta

200 OK

Returns the consumption summary for the specified tenant and, when requested, the tenant's allocated quantity.

Campo	Tipo de dados	Description
allocated	Número	The tenant's allocated quantity for the consumable. Returned only when includeAllocation is true.
consumedFromOrgWithoutTenant	Número	Always 0 on this endpoint, because consumption without tenant context isn't attributed to any tenant.
consumedByTopUp	Número	Always null on this endpoint, because top-up breakdown isn't supported per tenant.
tenantConsumptionItems[].tenantId	String (GUID)	The ID of the tenant.
tenantConsumptionItems[].consumedFromTenantPool	Número	Units consumed from the tenant's allocation.
tenantConsumptionItems[].consumedFromOrgPool	Número	Units consumed from the organization pool.
tenantConsumptionItems[].consumedByTopUp	Número	Always null on this endpoint.

Observação:

Handle a null value in allocated as unknown, not as zero. allocated is null when the tenant has no license for the queried consumable, or when the date range spans more than one allocation period, such as a 90-day range when allocations are set monthly. A value of 0 means the tenant's allocation is zero.

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

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

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