- Introducción
- Primeros pasos
- Crear en cualquier lienzo
- Crear con caso
- Referencia
- Definir claves de caso (de sistema o externo)
- Establecer contratos de entrada/salida y de escritura diferida de tareas
- Modelar las etapas principal y secundaria
- Iniciar un caso desde Data Fabric
- Implementar perfiles y permisos a nivel de etapa
- Establecer SLA y reglas de escalado automatizadas
- Configurar un bucle de reprocesamiento (reingreso)
- Configurar y probar el agente de Case Manager (vista previa)
- Crear con flujo
- Crear con BPMN
- En funcionamiento
- Supervisión
- Optimizando
- Información de referencia
Solicitudes de CaseApp
Puntos finales de la API para desencadenar tareas de casos ad-hoc, cerrar instancias de casos, enumerar tareas ad-hoc disponibles y leer una instancia de caso y su estado a través de la API de CaseApp v3.
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 Caso 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": {}
}
{
"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 Caso 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.
Enumerar las tareas ad-hoc que puede ejecutar en un caso
Enumera las tareas ad-hoc que una persona que llama puede desencadenar en una instancia de caso, agrupadas por la etapa a la que pertenece cada tarea.
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
Devuelve las tareas ad-hoc que la persona que llama puede desencadenar, agrupadas por la etapa a la que pertenecen. Las etapas sin una tarea que la persona que llama puede desencadenar se omiten, por lo que una lista stages vacía significa que la persona que llama no puede desencadenar ninguna tarea en este caso.
| Campo | Tipo | Descripción |
|---|---|---|
| Estados | Matriz | Las etapas que contienen al menos una tarea que la persona que llama puede desencadenar. |
| etapas[].stageId | String | El ID de nodo del plan del caso de la etapa. Puede ser null. |
| etapas[].stageLabel | String | La etiqueta de la etapa en el plan del caso. |
| etapas[].tareas | Matriz | Las tareas ad-hoc de la etapa, en el orden del plan del caso. |
| etapas[].tareas[].NombreDeLaTarea | String | El nombre de la tarea, para pasar como taskName al llamar a Desencadenar una tarea de caso ad-hoc. La coincidencia distingue entre mayúsculas y minúsculas. |
| etapas[].tareas[].taskId | String | El ID de nodo del plan del caso de la tarea. Puede ser null. El punto final del desencadenador no lo acepta. |
{
"stages": [
{
"stageId": "string",
"stageLabel": "string",
"tasks": [
{
"taskName": "string",
"taskId": "string"
}
]
}
]
}
{
"stages": [
{
"stageId": "string",
"stageLabel": "string",
"tasks": [
{
"taskName": "string",
"taskId": "string"
}
]
}
]
}
Una tarea enumerada es aquella que la persona que llama está autorizada a desencadenar, pero el desencadenador puede fallar. Por ejemplo, desencadenar una tarea en un caso completado devuelve 404.
Códigos de respuesta
| Código | Significado |
|---|---|
| 200 | Se ha devuelto la lista. Puede estar vacío. |
| 400 | Falta el encabezado X-UIPATH-FolderKey o no es válido. |
| 401 | La persona que llama no está autenticada. |
| 403 | La persona que llama no tiene ninguna concesión Cases.RunAdhocTasks relacionada con este caso. |
| 404 | La instancia no existe en la carpeta X-UIPATH-FolderKey en, o no es una instancia de caso. |
| 500 | No se pudo leer el plan del caso o se produjo un error inesperado del servidor. |
Permisos
Requiere el permiso Cases.RunAdhocTasks , autorizado en el ámbito de la etapa propietaria de cada tarea enumerada.
Obtener una instancia de caso
Devuelve una única instancia de caso por su ID. La respuesta tiene los mismos campos que la lista de instancias v3, incluida la prioridad del caso, el motivo de prioridad y el estado de limitación.
Obtener
{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}
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 | Se devolvió la instancia del caso. |
| 400 | Falta el encabezado X-UIPATH-FolderKey o no es válido. |
| 401 | La persona que llama no está autenticada. |
| 403 | La persona que llama no tiene concesión Cases.View en este caso. |
| 404 | La instancia no existe o no es una instancia de caso. |
| 424 | No se pudo contactar con el servicio de autorizaciones. |
| 500 | Se ha producido un error inesperado del servidor. |
Permisos
Requiere el permiso Cases.View , concedido en el proceso del caso o en cualquiera de sus etapas. Todos los casos que muestra la lista de instancias v3 se pueden abrir con esta solicitud.
Obtener el estado de un caso
Devuelve el estado actual completo de un caso en una llamada: el estado del caso y el SLA, la ejecución actual de cada etapa y tarea que ha alcanzado el caso, ejecuciones de tareas fallidas que no se han vuelto a ejecutar, selecciones de etapas abiertas e incidentes abiertos que no están asociados a una tarea.
Obtener
{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}/case-status
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 | Se devolvió el estado del caso. |
| 400 | Falta el encabezado X-UIPATH-FolderKey o no es válido. |
| 401 | La persona que llama no está autenticada. |
| 403 | La persona que llama no tiene concesión Cases.ViewSummary en este caso (CaseRbacAccessDenied). |
| 404 | La instancia no existe o no es una instancia de caso. |
| 424 | No se pudo contactar con el servicio de autorizaciones (CaseRbacAuthzUnavailable). |
| 500 | No se pudo leer el estado del caso o se produjo un error inesperado del servidor. |
Permisos
Requiere el permiso Cases.ViewSummary en el proceso del caso. No se necesitan permisos de carpeta de Orchestrator.
- Desencadenar una tarea de caso ad-hoc
- Solicitar encabezados.
- Solicitar cuerpo
- Código de respuesta
- Respuestas de error
- Permisos
- Cerrar una instancia de caso
- Solicitar encabezados.
- Códigos de respuesta
- Permisos
- Enumerar las tareas ad-hoc que puede ejecutar en un caso
- Solicitar encabezados.
- Cuerpo de respuesta
- Códigos de respuesta
- Permisos
- Obtener una instancia de caso
- Solicitar encabezados.
- Códigos de respuesta
- Permisos
- Obtener el estado de un caso
- Solicitar encabezados.
- Códigos de respuesta
- Permisos