Solicitações de aplicativos de casos

API endpoints for triggering ad-hoc case tasks, closing case instances, and listing available ad-hoc tasks through the CaseApp v3 API.

Dispare uma tarefa de caso ad-hoc

Dispara uma tarefa acionada manualmente (ad-hoc), identificada pelo nome do plano de caso, em uma instância em execução do Maestro Case.

Postar

{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}/tasks/trigger

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador
ChaveDaPastaX-UIPATH	A chave da pasta da instância do caso

Corpo da Solicitação

Campo	Tipo	Required	Description
taskName	String	Sim	O nome da tarefa ad-hoc a ser disparada, exatamente como é resolvido no plano de caso. A correspondência diferencia maiúsculas de minúsculas.
Entrada da Tarefa	object	Não	Um objeto JSON de forma livre encaminhado textual para a tarefa acionada como uma carga aninhada, por exemplo, referências de aprovação ou dados de decisão. A plataforma não interpreta nem valida o esquema dessa carga e não está associada às entradas declaradas da tarefa.

{
  "taskName": "string",
  "taskInput": {}
}

Código de resposta

200 Sucesso (corpo vazio)

Respostas de erro

Código	Significado
400	O corpo da solicitação está ausente ou é inválido.
401	O chamador não é autenticado.
403	O chamador não tem a permissão necessária para esta tarefa.
404	A instância de caso não existe ou não existe nenhuma tarefa ad-hoc com esse nome no plano de caso. Apenas tarefas com um evento "adhoc" a condição de entrada é elegível — outros nomes retornam 404.
500	Ocorreu um erro de servidor inesperado.

Permissões

Requer a permissão Cases.RunAdhocTasks, autorizada no escopo do estágio que possui a tarefa solicitada.

Fechar uma instância de caso

Fecha uma instância em execução do Maestro Case.

Postar

{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}/close

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador
ChaveDaPastaX-UIPATH	A chave da pasta da instância do caso

Códigos de resposta

Código	Significado
200	A instância fez a transição para Canceling. O trabalho conclui o deslocamento para Cancelled de forma assíncrona. Uma instância já terminal retorna seu status atual inalterado.
400	A instância já atingiu Completed e não pode ser cancelada.
401	O chamador não é autenticado.
403	O chamador não tem a permissão necessária para esta instância.
404	O ID da instância não é resolvido em uma instância de caso.

Permissões

Requer a concessão de persona Cases.Close.

List the ad-hoc tasks you can run on a case

Lists the ad-hoc tasks a caller is permitted to trigger on a case instance, grouped by the stage that owns each task.

Obter

{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}/tasks/adhoc

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador
ChaveDaPastaX-UIPATH	A chave da pasta da instância do caso

Corpo da Resposta

Returns the ad-hoc tasks the caller can trigger, grouped by the stage that owns them. Stages without a task the caller can trigger are omitted, so an empty stages list means the caller can't trigger any task on this case.

Campo	Tipo	Description
stages	Matriz	The stages that contain at least one task the caller can trigger.
stages[].stageId	String	The stage's case plan node ID. Can be null.
stages[].stageLabel	String	The stage's label in the case plan.
stages[].tasks	Matriz	The stage's ad-hoc tasks, in case plan order.
stages[].tasks[].taskName	String	The task's name, to pass as taskName when calling Trigger an ad-hoc case task. Matching is case-sensitive.
stages[].tasks[].taskId	String	The task's case plan node ID. Can be null. The trigger endpoint doesn't accept it.

{
  "stages": [
    {
      "stageId": "string",
      "stageLabel": "string",
      "tasks": [
        {
          "taskName": "string",
          "taskId": "string"
        }
      ]
    }
  ]
}

A listed task is one the caller is authorized to trigger, but the trigger can still fail. For example, triggering a task on a completed case returns 404.

Códigos de resposta

Código	Significado
200	The list was returned. It can be empty.
400	The X-UIPATH-FolderKey header is missing or invalid.
401	O chamador não é autenticado.
403	The caller has no Cases.RunAdhocTasks grant related to this case.
404	The instance doesn't exist in the folder specified in X-UIPATH-FolderKey, or it isn't a case instance.
500	The case plan couldn't be read, or an unexpected server error occurred.

Permissões

Requires the Cases.RunAdhocTasks permission, authorized at the scope of the stage that owns each listed task.