viafirma inbox :: manual de integración

Obtener datos de un flujo

Método para la obtener los datos de un flujo a partir de su código público.

  • Tipo: GET
  • URL: url-inbox/api/v3/workflows/{code}
  • Tipo de salida: application/json
  • Parámetros:
    • code: código del flujo

Json de salida

El json de salida está compuesto por los siguientes campos:

  • name: Nombre del grupo
  • publicAccessId: Código público del grupo
  • addresseeLines: Líneas de los destinatarios. Cada línea de destinatarios está compuesto por una lista de grupos de destinatarios (addresseeGroups). Cada uno de estos grupos tiene los siguientes campos:
    • isOrGroup: true si sólo uno de los usuarios del grupo tiene que realizar la acción.
    • userEntities: Lista de usuarios que componen el grupo. Cada uno de estos elementos puede venir dado por tres diferentes criterios: a través de su código de usuario y de entidad, o a partir de un código de cargo o de grupo. Los cargos o grupos indicados se reemplazarán por todos los usuarios que los componen.
      • userCode
      • entityCode
      • jobCode
      • groupCode
  • stringFormat: Destinatarios del flujo en formato texto.

    También se puede indicar el tipo de acción a realizar en el campo action cuyos posibles valores son SIGN y APPROVAL, siendo SIGN el valor por deecto en caso de no indicarse ninguno.

Ejemplo de json de salida