Solicitudes de CaseApp

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

Desencadenar una tarea de caso ad-hoc

Desencadena una tarea desencadenada manualmente (ad-hoc), identificada por su nombre de plan de caso, en una instancia de Maestro Case en ejecución.

Publicar

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

Solicitar encabezados.

Clave	Valor
Autorización	Portador
X-UIPATH-ClaveDeCarpeta	La clave de la carpeta de la instancia del caso

Solicitar cuerpo

Campo	Tipo	Obligatorio	Descripción
Nombre de la tarea	String	Sí	El nombre de la tarea ad-hoc que se desencadenará, exactamente como se resuelve en el plan del caso. La coincidencia distingue entre mayúsculas y minúsculas.
Entrada de tarea	object	No	Un objeto JSON de forma libre reenviado palabra por palabra a la tarea desencadenada como carga útil anidada, por ejemplo, referencias de aprobación o datos de decisión. La plataforma no interpreta ni valida el esquema de esta carga útil, y no está vinculada a las entradas declaradas de la tarea.

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

Código de respuesta

200 Correcto (cuerpo vacío)

Respuestas de error

Código	Significado
400	Falta el cuerpo de la solicitud o no es válido.
401	La persona que llama no está autenticada.
403	La persona que llama carece del permiso necesario para esta tarea.
404	La instancia del caso no existe o no existe ninguna tarea ad-hoc con ese nombre en el plan del caso. Solo las tareas con un permiso "adhoc" condición de entrada son elegibles: otros nombres devuelven 404.
500	Se ha producido un error inesperado del servidor.

Permisos

Requiere el permiso Cases.RunAdhocTasks, autorizado en el ámbito de la etapa propietaria de la tarea solicitada.

Cerrar una instancia de caso

Cierra una instancia de Maestro Case en ejecución.

Publicar

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

Solicitar encabezados.

Clave	Valor
Autorización	Portador
X-UIPATH-ClaveDeCarpeta	La clave de la carpeta de la instancia del caso

Códigos de respuesta

Código	Significado
200	La instancia ha cambiado a Canceling. El trabajador completa el turno a Cancelled de forma asíncrona. Una instancia ya terminal devuelve su estado actual sin cambios.
400	La instancia ya ha alcanzado Completed y no se puede cancelar.
401	La persona que llama no está autenticada.
403	La persona que llama carece del permiso necesario para esta instancia.
404	El ID de instancia no se resuelve en una instancia de caso.

Permisos

Requiere la concesión de perfil 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.

Obtener

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

Solicitar encabezados.

Clave	Valor
Autorización	Portador
X-UIPATH-ClaveDeCarpeta	La clave de la carpeta de la instancia del caso

Cuerpo de respuesta

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	Descripción
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 respuesta

Código	Significado
200	The list was returned. It can be empty.
400	The X-UIPATH-FolderKey header is missing or invalid.
401	La persona que llama no está autenticada.
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.

Permisos

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