Lista de procesos de mi grupo

Última revisión: 18 Abril 2024

Podrás listar los procesos asociados a tu grupo de trabajo a partir de los distintos estados en los que se encuentren, a través del siguiente servicio.

Response body:

    {
      "total": "int",
      "elements": [
        {
          "messageCode": "string",
          "status": "string",
          "userCode": "string",
          "groupCode": "string",
          "templateCode": "string",
          "creationDate": timestamp,
          "setCode": "string",
          "title": "string",
          "description": "string"
        }
      ]
    }

Ejemplo:

    {
      "total": 1,
      "elements": [
        {
          "messageCode": "0Z8P1565351269642R875",
          "status": "RESPONSED",
          "userCode": "null",
          "groupCode": "apisample",
          "templateCode": "apisample_template_01",
          "creationDate": 1565351270000,
          "setCode": "MTB41713267133111T095",
          "title": "Contrato",
          "description": "Documento a firmar"
        }
      ]
    }

Params de la respuesta:

• total: cantidad de procesos de firma que cumplen con el STATUS y GROUPCODE indicados.
• elements: lista con los datos de los diferentes procesos de firma.
• messageCode: código del proceso de firma para el MESSAGE.
• status: estado actual del proceso, por ejemplo “WAITING”.
• userCode: username del usuario que solicitó el proceso de firma. Si el proceso fue solicitado a través de API el userCode será igual a nulL...
• groupCode: código del grupo al que pertenece el proceso de firma.
• templateCode: código de la plantilla asociada al proceso; en caso de no haber usado código de plantilla templateCode valdrá null.
• creationDate: fecha de creación del proceso expresada en milisegundos.
• setCode: código del proceso de firma para el SET.
• title: título para el proceso de firma.
• description: descripción para el proceso de firma.

Respuestas alternativas en caso de fallo: se devolverán HTTP status codes distintos de 200/OK. En ese caso siempre se devolverá un JSON que describe el problema:

    {
      "code": "string",
      "type": "string",
      "message": "string",
      "trace" : "string"
    }