Solicitações de aplicativos de casos

Pontos de extremidade de API para disparar tarefas de caso ad-hoc por meio da API CaseApp v3.

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.