Obter consumo do tenant por pasta

Recupera o detalhamento do consumo por pasta para um tenant específico, com agregação opcional por propriedade de pasta.

Use esse ponto de extremidade para recuperar um detalhamento do consumo por pasta para um tenant específico.

Ponto de Extremidade da API

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

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.

Corpo da Solicitação

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

{
  "tenantId": "string",
  "startDate": 0,
  "endDate": 0,
  "consumableCode": "string",
  "aggregateByOwnership": false,
  "processPersonalWorkspaces": false,
  "alwaysIncludeFolderKeys": ["string"]
}

Observação:

• tenantId is required. The ID of the tenant for which to retrieve consumption.
• 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.
• é opcional (padrão false aggregateByOwnership . Quando definido como true, o consumo é agregado pela pasta que disparou a execução do processo em vez de onde ele foi executado.
• processPersonalWorkspaces is optional (default: false). When set to true, personal workspaces are included in the folder breakdown as individual items, grouped under a synthetic PersonalWorkspacesRoot parent. Only workspaces with consumption in the queried window are returned. Consumption in folders that no longer exist is returned as synthetic items flagged with isDeletedFolder.
• alwaysIncludeFolderKeys is optional. Provide a list of folder GUIDs to include in the response even if they have zero consumption in the queried window. Unknown keys are ignored.

Resposta

200 OK

Retorna uma lista de registros de consumo agrupados por pasta 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/consumption-by-folder' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenantId": "string",
  "startDate": 1704067200,
  "endDate": 1706745600,
  "consumableCode": "consumption_unit_code"
}'

Aqui está o corpo da resposta para um consumo bem-sucedido por recuperação de pasta:

Observação:

• isPersonalWorkspace is true when the item is a personal workspace.
• isDeletedFolder is true when the item represents consumption from a deleted folder.

{
  "items": [
    {
      "folderKey": "string",
      "folderName": "string",
      "parentFolderKey": "string",
      "consumedBySelf": 0,
      "processCountSelf": 0,
      "isPersonalWorkspace": false,
      "isDeletedFolder": false
    }
  ]
}