Casos¶

Las rutas home/ son el espacio de trabajo del caso: leer un caso, sus documentos, sus notas y sus mensajes, y las acciones que lo hacen avanzar. Son los endpoints que necesita una integración.

Todas son POST con cuerpo JSON. El caso se identifica con app_uid, y casi todas necesitan además del_index — la posición de la tarea en el caso, que la lista de casos proporciona.

Iniciar un caso¶

Esta API no tiene una ruta separada de "crear caso". Iniciar un caso es favorites/launch:

POST /favorites/launch   {"pro_uid": "…", "tas_uid": "…"}

Verifica que el usuario pueda iniciar ese proceso en esa tarea, crea el caso y lo devuelve:

{"success": true, "case": {"APPLICATION": "…", "INDEX": 1, "PROCESS": "…", "TASK": "…"}}

APPLICATION es el app_uid que necesita el resto de esta página, e INDEX es el del_index. Si el usuario no puede iniciarlo, la llamada responde success: false con un reason: process_not_found, process_inactive, task_not_found, task_not_start o user_not_assigned. El proceso además debe estar activo, y la tarea debe ser una tarea inicial asignada al usuario.

La ruta se llama así porque la pantalla que la usa es la de favoritos, pero no necesita un favorito: sirve cualquier proceso y tarea inicial que el usuario tenga permitido iniciar.

Leer un caso¶

Ruta	Campos	Devuelve
`home/case-context`	`app_uid`, `del_index`, `tas_uid`, `action`	El caso, su tarea y los datos que la pantalla necesita para mostrarlo
`home/case-history`	`app_uid`	Los pasos por los que pasó el caso
`home/case-change-log`	`app_uid`, `pro_uid`, `tas_uid`	Las variables que cambió cada paso
`home/case-dynaforms`	`app_uid`	Los formularios del caso
`home/case-actions`	`app_uid`, `del_index`, `action`	Qué acciones están permitidas sobre el caso
`home/case-derivation`	`app_uid`, `del_index`, `tas_uid`, `app_number`	Las rutas disponibles para mover el caso

case-context es el punto de entrada: es lo primero que llama la pantalla del caso, y el valor de action (todo, por ejemplo) dice desde qué lista se abrió.

Documentos¶

Ruta	Campos	Devuelve
`home/case-input-documents/info`	`inp_doc_uid`	La definición: título, extensiones permitidas, tamaño máximo
`home/case-input-documents/upload`	`app_uid`, `del_index`, `inp_doc_uid`, `comments`	Sube uno o más archivos
`home/case-documents/uploaded`	`app_uid`, `del_index`, `tas_uid`	Los archivos que aporta el caso
`home/case-documents/generated`	`app_uid`, `del_index`, `tas_uid`	Los archivos que generó el proceso
`home/case-documents/download`	`app_doc_uid`, `doc_version`, `ext`	El archivo, con su versión
`home/case-messages/attachment`	`app_msg_uid`, `app_uid`, `index`	El archivo adjunto a un correo

La subida es una petición multipart, no JSON: envía los archivos en files (uno o un arreglo) y comments como arreglo con un comentario por archivo. Sin archivo, la llamada responde 400 con No files received.

Notas¶

Ruta	Campos
`home/case-notes`	`app_uid`, `del_index`, `pro_uid`, `tas_uid`
`home/case-notes/create`	`app_uid`, `del_index`, `pro_uid`, `tas_uid`, `note`, `send_mail`
`home/case-notes/users`	`usr_uid`

El texto de la nota es el cuerpo del mensaje, y send_mail decide si las personas mencionadas lo reciben por correo. Listar los usuarios es lo que llena el selector de menciones.

Mensajes¶

Ruta	Campos
`home/case-messages`	`app_uid`
`home/case-messages/resend`	`app_uid`, `app_msg_uid`

Reenviar manda el mismo mensaje otra vez a los mismos destinatarios; el caso conserva el original y la copia queda registrada en el historial de mensajes.

Actuar sobre un caso¶

Ruta	Campos	Efecto
`home/case-claim`	`app_uid`, `del_index`	Asigna al llamador un caso sin asignar
`home/case-pause`	`app_uid`, `del_index`, `reason`, `unpause_date`, `notify`	Pausa el caso
`home/case-unpause`	`app_uid`, `del_index`	Lo reanuda
`home/case-cancel`	`app_uid`, `del_index`, `reason`, `notify`	Lo cancela
`home/case-delete`	`app_uid`	Quita el caso de las listas
`home/case-reassign-users`	`app_uid`, `tas_uid`, `search`, `limit`	Los usuarios a los que se puede dar el caso
`home/case-reassign`	`app_uid`, `usr_uid_target`, `reason`, `notify`	Se lo da a otro usuario

Pausar, cancelar y reasignar aceptan un reason y una marca notify. Con notify activo, las personas afectadas reciben el mensaje que define el proceso; ese mensaje aparece en el historial de mensajes del caso.

case-delete no es lo mismo que cancelar: un caso cancelado sigue en las listas con su estado, uno eliminado desaparece.

Derivar un caso¶

POST /home/case-derivate

Campo	Significado
`app_uid`	El caso
`del_index`	La tarea actual
`tas_uid`	La tarea en la que está el caso
`form`	Los datos del formulario enviado. Cuando viene vacío, la ruta lee `ROU_TYPE` y `TASKS` del nivel superior

La llamada ejecuta los desencadenadores del paso, guarda los valores del formulario y mueve el caso. case-derivation antes es lo que dice a qué tareas puede pasar el caso; es lo que usa la ventana de derivación para armar el selector de rutas.

Fichas de usuario¶

Ruta	Campos	Devuelve
`home/user-card`	`usr_uid`	El nombre, la foto y el contacto de un usuario
`home/user-name-format`	— (`GET` también funciona)	Cómo se formatean los nombres en este espacio

Estas dos no necesitan un caso: son la forma en que una pantalla muestra "quién" sin cargar el registro completo del usuario.

Relacionado¶

Conceptos de la API — URL base y autenticación.
Acciones del caso — las mismas acciones en la interfaz.
Derivación — qué le hace una derivación al caso.
Subir documentos — el flujo de subida.