Solicitações de aplicativos de casos

Pontos de extremidade de API para disparar tarefas ad-hoc, fechar instâncias de caso e listar tarefas ad-hoc disponíveis por meio da API CaseApp v3.

Dispare uma tarefa de caso ad-hoc

Triggers one manually-triggered (ad-hoc) task, identified by its case plan name, on a running Case instance.

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

Closes a running Case instance.

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.

Liste as tarefas ad hoc que você pode executar em um caso

Lista as tarefas ad-hoc que um chamador pode disparar em uma instância de caso, agrupadas pelo estágio de propriedade de cada tarefa.

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

Retorna as tarefas ad-hoc que o chamador pode disparar, agrupadas pelo estágio que as possui. Os estágios sem uma tarefa que o chamador pode acionar são omitidos, portanto, uma lista stages significa que o chamador não pode disparar nenhuma tarefa nesse caso.

Campo	Tipo	Description
Estágios	Matriz	Os estágios que contêm pelo menos uma tarefa que o chamador pode disparar.
Estágios[].IDDaFase	String	O ID do nó do plano de caso do estágio. Pode ser null.
Estágios[].stageLabel	String	O rótulo do estágio no plano de caso.
estágios[].tarefas	Matriz	As tarefas ad-hoc do estágio, na ordem do plano de caso.
Estágios[].tasks[].taskNome	String	O nome da tarefa, para passar como taskName ao chamar Disparar uma tarefa de caso ad-hoc. A correspondência diferencia maiúsculas de minúsculas.
Estágios[].tasks[].taskId	String	O ID do nó do plano de caso da tarefa. Pode ser null. O ponto de extremidade do gatilho não o aceita.

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

Uma tarefa listada é aquela que o chamador está autorizado a disparar, mas o gatilho ainda pode falhar. Por exemplo, disparar uma tarefa em um caso concluído retorna 404.

Códigos de resposta

Código	Significado
200	A lista foi retornada. Ele pode estar vazio.
400	O cabeçalho X-UIPATH-FolderKey está ausente ou é inválido.
401	O chamador não é autenticado.
403	O chamador não tem concessão Cases.RunAdhocTasks relacionada a este caso.
404	A instância não existe na pasta especificada em X-UIPATH-FolderKey ou não é uma instância de caso.
500	Não foi possível ler o plano de caso ou ocorreu um erro inesperado do servidor.

Permissões

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