← Volver

API mock — /api/recovery-api/rs

Endpoints implementados según el documento “Endpoints WS Alta procedimientos”, alineados con el formato de la recovery-api real del cliente (base path /recovery-api/rs/procedure-transaction + familia /recovery-api/rs/diccionarios-genericos). Usa esta página como referencia para registrar el Tool Server en Devic apuntando a este backend (vía ngrok/tunnel o despliegue público).

Total de endpoints: 26. Persistencia en data/store.json (local) / D1 (Workers). Todas las rutas exigen cabecera Authorization: Bearer <token> (auth mockeada, sustituible por el JWT real).

Procedimientos

POST/api/recovery-api/rs/procedure-transaction/procedimientos

Alta completa de procedimiento (fases, hitos y campos opcionales en una sola operación). `codigo` es opcional: si se aporta un código de dominio (p.ej. `H001`) se respeta; si se omite, el backend autogenera uno.

Parámetros (2)
  • Authorization (header, string)obligatorio — Bearer <token> (auth mockeada; cualquier token no vacío es válido).
  • Idempotency-Key (header, string) — Para reintentos seguros
Body de ejemplo
{
  "codigo": "H001",
  "nombre": "Monitorio Verbal — DIGLO",
  "descripcion": "Workflow estándar para monitorios <6.000€",
  "jurisdiccion": "CIVIL",
  "tipoActuacion": "MOV",
  "activo": true,
  "fases": [
    {
      "codigo": "VERB_PREP",
      "nombre": "Preparación de la demanda",
      "orden": 1,
      "tipoFase": "NORMAL",
      "hitos": [
        {
          "codigo": "H001_RecepcionDoc",
          "nombre": "Recepción de la documentación",
          "orden": 1,
          "gestorActorCodigo": "ACT-LET-001",
          "diasPlazo": 5,
          "perentorio": false,
          "campos": [
            {
              "codigo": "C_FREC",
              "nombre": "fechaRecepcion",
              "etiqueta": "Fecha de recepción",
              "tipo": "FECHA",
              "obligatorio": true
            }
          ]
        }
      ]
    }
  ]
}
Respuesta de ejemplo
{
  "estado": "OK",
  "mensaje": "Procedimiento creado correctamente",
  "idProcedimiento": 1,
  "codigo": "H001"
}
GET/api/recovery-api/rs/procedure-transaction/procedimientos

Listado paginado y filtrable por nombre. Soporta `?nombre=`, `?page=`, `?size=`, `?sort=`.

GET/api/recovery-api/rs/procedure-transaction/procedimientos/{codigo}

Devuelve el procedimiento con la jerarquía completa. El código va directo como segmento (sin `codigo/`), p.ej. `…/procedimientos/H001`.

Parámetros (1)
  • codigo (path, string)obligatorio

Fases

POST/api/recovery-api/rs/procedure-transaction/procedimientos/{codProcedimiento}/fases

Crea una fase asociada a un procedimiento existente. `tipoFase` es obligatorio (NORMAL | PERSONAS | BIENES). `codigo` opcional (código de dominio aportado o autogenerado).

Body de ejemplo
{
  "codigo": "VERB_SENT",
  "nombre": "Sentencia",
  "descripcion": "Fase de resolución",
  "orden": 3,
  "tipoFase": "NORMAL"
}
GET/api/recovery-api/rs/procedure-transaction/procedimientos/{codProcedimiento}/fases

Lista las fases ordenadas de un procedimiento.

GET/api/recovery-api/rs/procedure-transaction/fases/{codFase}

Devuelve una fase por código.

PUT/api/recovery-api/rs/procedure-transaction/fases/{codFase}

Actualiza atributos de una fase (incluido `tipoFase`).

Body de ejemplo
{
  "nombre": "Sentencia y notificación",
  "orden": 4,
  "tipoFase": "NORMAL"
}
PATCH/api/recovery-api/rs/procedure-transaction/procedimientos/{codProcedimiento}/fases/reordenar

Reordena varias fases de una vez (operación consistente).

Body de ejemplo
{
  "orden": [
    {
      "codigo": "FA-000001",
      "orden": 2
    },
    {
      "codigo": "FA-000002",
      "orden": 1
    }
  ]
}

Hitos

POST/api/recovery-api/rs/procedure-transaction/fases/{codFase}/hitos

Crea un hito dentro de una fase. Acepta también el id numérico de la fase. `codigo` opcional (código de dominio aportado o autogenerado).

Body de ejemplo
{
  "codigo": "H026_ConfirmarAdmisionDemanda",
  "nombre": "Decreto de admisión",
  "orden": 1,
  "gestorActorCodigo": "ACT-LET-001",
  "supervisorActorCodigo": "ACT-N1-001",
  "diasPlazo": 10,
  "perentorio": true,
  "campos": [
    {
      "nombre": "fechaDecreto",
      "etiqueta": "Fecha del decreto",
      "tipo": "FECHA",
      "obligatorio": true
    }
  ]
}
GET/api/recovery-api/rs/procedure-transaction/fases/{codFase}/hitos

Lista los hitos ordenados de una fase.

GET/api/recovery-api/rs/procedure-transaction/hitos/{codigoHito}

Devuelve un hito por código.

PUT/api/recovery-api/rs/procedure-transaction/hitos/{codigoHito}

Actualiza atributos de un hito.

Campos

POST/api/recovery-api/rs/procedure-transaction/hitos/{codigoHito}/campos

Crea un campo de formulario dentro de un hito. `codigo` opcional (código de dominio aportado o autogenerado).

Body de ejemplo
{
  "codigo": "C_RES",
  "nombre": "resultado",
  "etiqueta": "Resultado del hito",
  "tipo": "COMBO",
  "obligatorio": true,
  "diccionarioCodigo": "DD_RES_RESULTADO_HITO"
}
GET/api/recovery-api/rs/procedure-transaction/hitos/{codigoHito}/campos

Lista los campos ordenados de un hito.

GET/api/recovery-api/rs/procedure-transaction/campos/{codigoCampo}

Devuelve un campo por código.

PUT/api/recovery-api/rs/procedure-transaction/campos/{codigoCampo}

Actualiza atributos de un campo.

Diccionarios

GET/api/recovery-api/rs/procedure-transaction/diccionarios

Devuelve todos los diccionarios disponibles.

POST/api/recovery-api/rs/procedure-transaction/diccionarios

Crea un nuevo diccionario con sus valores.

Body de ejemplo
{
  "codigo": "DD_TFA_FICHERO_ADJUNTO",
  "nombre": "Tipos de fichero adjunto",
  "valores": [
    {
      "codigo": "DEM",
      "valor": "Demanda"
    },
    {
      "codigo": "POD",
      "valor": "Poder"
    }
  ]
}
GET/api/recovery-api/rs/procedure-transaction/diccionarios/{codigoDiccionario}

Devuelve la cabecera y valores de un diccionario.

GET/api/recovery-api/rs/procedure-transaction/diccionarios/{codigoDiccionario}/valores

Devuelve solo los valores de un diccionario.

Diccionarios genéricos

GET/api/recovery-api/rs/diccionarios-genericos

Lista los diccionarios genéricos disponibles.

GET/api/recovery-api/rs/diccionarios-genericos/{codigo}/valores

Devuelve los valores de un diccionario genérico.

POST/api/recovery-api/rs/diccionarios-genericos/{codigo}/valores

Da de alta un valor en un diccionario genérico. Body con la forma {codigo, descripcion, descripcionLarga}.

Body de ejemplo
{
  "codigo": "MP001",
  "descripcion": "Causa judicial",
  "descripcionLarga": "Paralización por resolución judicial firme"
}

Actores

GET/api/recovery-api/rs/procedure-transaction/actores

Lista o filtra actores (`?nombre=`, `?tipo=GESTOR|SUPERVISOR`, `?estado=ACTIVO|INACTIVO`).

GET/api/recovery-api/rs/procedure-transaction/actores/{codigoActor}

Devuelve un actor por código.

POST/api/recovery-api/rs/procedure-transaction/actores/validar

Valida si un valor informado existe en el catálogo y es del tipo esperado. La recovery-api real usa la clave `code`; se acepta también `codigo` como alias.

Body de ejemplo
{
  "code": "AGE_POSESION"
}