Obter consumo do tenant por processo

Detalhamento do consumo por processo para um tenant específico, com paginação, classificação, filtragem e detalhamento opcional por serviço.

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

Observação:

Ao contrário de Get Tenant Consumo Summary, esse ponto de extremidade não requer permissões de administrador da organização. Um usuário com permissão de visualização de licença com escopo de tenant para o tenant pode chamá-la.

Ponto de Extremidade da API

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

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 autenticar por meio do método Credenciais de senha do proprietário do recurso (ROPC) descrito em Métodos de autenticação.

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 e os filtros opcionais, a paginação e as opções de classificação.

{
  "tenantId": "string",
  "startDate": 0,
  "endDate": 0,
  "aggregateByOwnership": false,
  "processNameFilter": "string",
  "processType": "string",
  "folderKeys": ["string"],
  "skip": 0,
  "take": 50,
  "sortBy": "string",
  "sortDescending": true,
  "includeServiceBreakdown": false
}

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 possui o processo em vez de onde ele foi executado.
• processNameFilter é opcional. Filtra os resultados por nome do processo.
• processType é opcional. Filtra os resultados por tipo de processo.
• folderKeys é opcional. Forneça uma lista de GUIDs de pasta para limitar os resultados a pastas específicas.
• skip é opcional0 (padrão:). Deslocamento de paginação.
• take é opcional50 (padrão:). Tamanho da página
• sortBy é opcionalruns (padrão:). Ou runs ou um código de tipo de unidade (AIU, AGU, PLTU, RU, SPR, TEU, HEAL, APICALLS).
• sortDescending é opcionaltrue (padrão:). Direção de classificação.
• includeServiceBreakdown é opcionalfalse (padrão:). Quando definido como true, cada processo inclui um detalhamento por serviço.

Resposta

200 OK

Retorna a divisão do consumo por processo para o tenant especificado.

Observação:

• totalCount é o número de processos que correspondem aos filtros, antes da paginação.
• consumedUnits lista os códigos de tipo de unidade presentes nos resultados.
• Cada item em items inclui processKey, processName, processType, folderKey, runs e consumption (uma matriz de objetos { "unit": string, "quantity": number }).
• consumptionByService está incluído em cada item somente quando includeServiceBreakdown é,true como uma matriz de { "service": string, "unitBreakdown": [{ "unit": string, "quantity": number }] } objetos.
• subProcesses é opcional e, quando presente, usa o mesmo formato items que.

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-process' \
--header 'Authorization: Bearer <your-access-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenantId": "4b8f2f6e-1c33-4c8a-9f4e-2c1a7d3b5e90",
  "startDate": 1754006400,
  "endDate": 1756684799,
  "sortBy": "runs",
  "includeServiceBreakdown": true
}'

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

{
  "totalCount": 1,
  "consumedUnits": ["RU", "AIU"],
  "items": [
    {
      "processKey": "9d3c1a2b-7e45-4f10-b2aa-0c6d8e914f77",
      "processName": "InvoiceProcessing",
      "processType": "Process",
      "folderKey": "2f6e4b8f-1c33-4c8a-9f4e-2c1a7d3b5e90",
      "runs": 128,
      "consumption": [
        { "unit": "RU", "quantity": 12.5 },
        { "unit": "AIU", "quantity": 340 }
      ],
      "consumptionByService": [
        { "service": "Orchestrator", "unitBreakdown": [{ "unit": "RU", "quantity": 12.5 }] },
        { "service": "Document Understanding", "unitBreakdown": [{ "unit": "AIU", "quantity": 340 }] }
      ]
    }
  ]
}