Obter Resumo do consumo do tenant por tenant

Endpoint POST para recuperar o resumo de consumo para um tenant específico, com detalhamento por uso de pool de tenants e pool de organização.

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
Test Cloud	https://cloud.uipath.com/
Test Cloud para o Setor Público	https://govcloud.uipath.us/
Test 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"
}

Observação:

startDate e endDate são carimbos de data/hora Unix em segundos.

Resposta

200 OK

Retorna o resumo de consumo para o tenant especificado.

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 1234' \
--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:

consumedFromOrgWithoutTenant o consumo que ocorre no nível da organização sem contexto do tenant — ele não é atribuído a nenhum tenant específico.

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