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 <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)	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 é necessário. O ID do tenant para o qual recuperar o consumo.
• 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 disparou a execução do processo em vez de onde ele foi executado.
• processPersonalWorkspaces é opcionalfalse (padrão:). Quando definidos como true, os espaços de trabalho pessoais são incluídos na divisão da pasta como itens individuais, agrupados sob um pai PersonalWorkspacesRoot sintético. Apenas os espaços de trabalho com consumo na janela consultada são retornados. O consumo nas pastas que não existem mais é retornado como itens sintéticos sinalizados com isDeletedFolder.
• alwaysIncludeFolderKeys é opcional. Forneça uma lista de GUIDs de pasta a serem incluídos na resposta, mesmo que tenham consumo zero na janela consultada. As chaves desconhecidas são ignoradas.

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 é true quando o item é um espaço de trabalho pessoal.
• isDeletedFolder é true quando o item representa o consumo de uma pasta excluída.

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