Pular para o conteúdo principal

Histórico

O histórico do documento aparece no botão Histórico, da tela Detalhe do documento, em duas abas: Interno, com as ações feitas no Pedagogo, e Firmou, com o andamento informado pelo provedor.

Endpoints​

MétodoCaminhoDescrição
GET/digital-signature/documents/{document_uuid}/logsHistórico interno do documento
GET/digital-signature/documents/{document_uuid}/logs/external-logsAndamento informado pelo provedor

GET /digital-signature/documents/{document_uuid}/logs​

Lista as ações registradas no documento, em ordem cronológica. Exemplos de registros: Documento criado, Documento enviado para assinatura, Verificação de status, e Documento cancelado, com o motivo, quando informado.

Parâmetros de URL

ParâmetroObrigatórioDescrição
per_pageNãoQuantidade de registros por página. Sem ele, a resposta é a lista simples
pageNãoNúmero da página, quando per_page é informado

Resposta (200): cada item traz o status (com o nome interno do status), o comments (descrição da ação), os usuários que criaram e alteraram o registro e a data de criação.

GET /digital-signature/documents/{document_uuid}/logs/external-logs​

Devolve o andamento do documento como informado pelo provedor de assinatura. Sem vínculo com o provedor, a resposta é uma lista vazia.

Resposta (200): lista de eventos, no formato devolvido pelo provedor.