Descarga del Audit Trail asociado a un proceso de firma

Última revisión: 13 Mayo 2020

Se parte del siguiente caso de uso:

  • Propietario del proceso: API
  • Estado del documento: cualquier estado. Si éste no está aún firmado el audit-trail mostrará el estado de las tareas o evidencias en el momento de la solicitud del servicio de descarga.
Descripción
SERVICIO DOWNLOAD TRAIL
URL /api/v3/documents/download/trail/{messageCode}
SEGURIDAD
METHOD GET
CONTENT/APPLICATION URL PARAM
PARAMS messageCode: código del proceso de firma asociado al documento firmado del que se desea obtener el audit-trail. El API que lo consume debe ser propietario del proceso.
RESPONSE 200: HTTP status code 200/OK
RESPONSE BODY application/json

Respuesta

{
 "link": "string",
 "fileName": "string",
 "expires": "timestamp milliseconds"
}
* "link": "URL descarga directa del Audit Trail en formato PDF.",
* "fileName": "nombre del PDF",
* "expires": "fecha en milisegundos que indica la caducidad del LINK de descarga. Por defecto 10 minutos."

Códigos de error

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"
    }

Ejemplo:

   {
      "code": 91,
      "type": "Error",
      "message": "Sorry, this application is not allowed."
    }

El API ha usado unas credenciales que no son propietarias del proceso de firma asociado al documento que se pretende borrar.

    {
      "code": 236,
      "type": "Error",
      "message": "No es posible recuperar la información del mensaje solicitado",
      "trace": "com.viafirma.documents.api.model.exception.ApiException: no es posible recuperar la información del mensaje solicitado"
    }

El messageCode informado no existe o tiene un parámetro incorrecto.

results matching ""

    No results matching ""