Processos

Detalhar um evento da timeline do processo.

GET · API de Integração v2

GET/v2/processos/{processoId}/auditoria/{eventoId}

Abre o antes/depois dos campos alterados por um evento — é o clique na linha cujo possuiAlteracoes é true. Continua sem payload, diff bruto, IP ou sessão. Campo sensível vem sinalizado e sem valores. Relações do processo da URL são devolvidas com o rótulo congelado para a tela; em ações em lote, relações de outros processos não são expostas neste detalhe.

Autenticação

X-API-Key no cabeçalho. Como autenticar

Parâmetros de caminho2

eventoIdintegerobrigatório

eventoId

processoIdintegerobrigatório

processoId

Respostas4

Exemplos ilustrativos · nenhuma requisição é enviada

200 · Sucesso

Quando acontece: A operação foi concluída.
Como tratar: Leia os dados retornados; em listagens, confira também a paginação.

Exemplo ilustrativo gerado do schema · application/json

Exemplo · HTTP 200

{
  "alteracoes": [
    {
      "campo": "valorCausa",
      "rotulo": "Fase",
      "sensivel": false,
      "tipo": "REFERENCE",
      "valorAnterior": 10000,
      "valorAnteriorExibicao": "Conhecimento",
      "valorNovo": 25000,
      "valorNovoExibicao": "Instrução"
    }
  ],
  "evento": {
    "acao": "string",
    "agendaId": 1,
    "alteracaoMonitoramento": {
      "anterior": false,
      "novo": false
    },
    "ator": {
      "fotoUrl": "string",
      "id": "string",
      "nome": "string",
      "tipo": "string"
    },
    "categoria": "ALTERACAO",
    "codigoEvento": "string",
    "descricao": "string",
    "id": 1,
    "nomeAtor": "string",
    "ocorridoEm": "yyyy-MM-dd'T'HH:mm:ss",
    "possuiAlteracoes": false,
    "tipo": "AGENDA_ATUALIZADA",
    "tituloAgenda": "string"
  },
  "relacoes": [
    {
      "acao": "string",
      "id": 1,
      "identificador": "string",
      "rotulo": "string",
      "tipo": "string"
    }
  ]
}

Contrato de respostas

200Detalhe do evento retornado.

Detalhe do evento retornado.

application/json

alteracoesAlteracaoTimelineProcessoResponse[]

Campos alterados por este evento. Vazia quando o evento não alterou campos.

Ver propriedades

campostring

Nome técnico do campo, estável entre versões.

exemplo: valorCausa

rotulostring

Rótulo humano congelado do campo.

exemplo: Fase

sensivelboolean

true quando o campo é sensível: os dois valores vêm nulos e a tela deve dizer apenas que o campo mudou.

exemplo: false

tipostring

Tipo semântico do valor, por exemplo REFERENCE ou BOOLEAN.

exemplo: REFERENCE

valorAnteriorstring

Valor antes da alteração. null quando o campo estava vazio ou quando é sensível — use sensivel para distinguir.

exemplo: 10000

valorAnteriorExibicaostring

Texto do valor anterior congelado para exibição.

exemplo: Conhecimento

valorNovostring

Valor depois da alteração.

exemplo: 25000

valorNovoExibicaostring

Texto do valor novo congelado para exibição.

exemplo: Instrução

eventoEventoTimelineProcessoResponse

Ver propriedades

acaostring

Ação técnica registrada no evento.

agendaIdinteger

formato: int64

alteracaoMonitoramentoAlteracaoMonitoramentoResponse

Ver propriedades

anteriorboolean

novoboolean

atorAtorTimelineProcessoResponse

Ver propriedades

fotoUrlstring

idstring

nomestring

tipostring

categoriastring

Categoria estável para agrupamento e apresentação na UI.

valores: ALTERACAO · CRIACAO · EXCLUSAO · OUTRO · STATUS · VINCULO · VISUALIZACAO

codigoEventostring

Código estável do evento; recomendado para novos consumidores.

descricaostring

idinteger

formato: int64

nomeAtorstring

Nome histórico do ator; mantido para compatibilidade.

ocorridoEmstring

exemplo: yyyy-MM-dd'T'HH:mm:ss

possuiAlteracoesboolean

tipostring

Tipo fechado legado; use codigoEvento e categoria em novos consumidores.

valores: AGENDA_ATUALIZADA · AGENDA_CANCELADA · AGENDA_CANCELAMENTO_DESFEITO · AGENDA_CONCLUIDA · AGENDA_CRIADA · AGENDA_EXCLUIDA · AGENDA_REABERTA · AGENDA_REAGENDADA · AGENDA_VISUALIZADA · EQUIPES_ADICIONADAS · EQUIPES_REMOVIDAS · PROCESSO_ALTERADO · PROCESSO_ATUALIZADO · PROCESSO_CRIADO · PROCESSO_EXCLUIDO · PROCESSO_VISUALIZADO · RESPONSAVEIS_ADICIONADOS · RESPONSAVEIS_REMOVIDOS

tituloAgendastring

relacoesRelacaoTimelineProcessoResponse[]

Vínculos adicionados ou removidos por este evento.

Ver propriedades

acaostring

idinteger

formato: int64

identificadorstring

rotulostring

tipostring

401Não autenticado.

Não autenticado.

O contrato não declara um corpo para esta resposta.

403Sem permissão para consultar histórico.

Sem permissão para consultar histórico.

O contrato não declara um corpo para esta resposta.

404Processo ou evento não encontrado na timeline do escritório autenticado.

Processo ou evento não encontrado na timeline do escritório autenticado.

application/json

codestring

exemplo: validation_error

correlationIdstring

exemplo: c4ce7307-1917-4539-b17a-9c73c972c261

detailstring

exemplo: Existem campos inválidos na requisição.

errorsErroItemApiResponse[]

Ver propriedades

codestring

Código estável do erro

exemplo: field_validation_error

fieldstring

Campo relacionado

exemplo: agenda.titulo

messagestring

Mensagem segura

exemplo: não deve estar em branco

instancestring

exemplo: /v2/agenda

requestIdstring

exemplo: e9db6635-7db3-40cb-8dd2-453c25e6a461

statusinteger

formato: int32exemplo: 400

titlestring

exemplo: Erro de validação

typestring

formato: uriexemplo: /errors/validation-error

curl --request GET \
  --url 'https://api.expedit.com.br/v2/processos/1/auditoria/1' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: SUA_API_KEY'

Requisição e resposta

As chamadas são enviadas diretamente à API. O domínio deste portal precisa estar autorizado no CORS.

A resposta aparecerá aquiPreencha os campos e envie a requisição para consultar o retorno da API.

Explorar exemplos de resposta

Exemplos ilustrativos · nenhuma requisição é enviada

200 · Sucesso

Quando acontece: A operação foi concluída.
Como tratar: Leia os dados retornados; em listagens, confira também a paginação.

Exemplo ilustrativo gerado do schema · application/json

Exemplo · HTTP 200

{
  "alteracoes": [
    {
      "campo": "valorCausa",
      "rotulo": "Fase",
      "sensivel": false,
      "tipo": "REFERENCE",
      "valorAnterior": 10000,
      "valorAnteriorExibicao": "Conhecimento",
      "valorNovo": 25000,
      "valorNovoExibicao": "Instrução"
    }
  ],
  "evento": {
    "acao": "string",
    "agendaId": 1,
    "alteracaoMonitoramento": {
      "anterior": false,
      "novo": false
    },
    "ator": {
      "fotoUrl": "string",
      "id": "string",
      "nome": "string",
      "tipo": "string"
    },
    "categoria": "ALTERACAO",
    "codigoEvento": "string",
    "descricao": "string",
    "id": 1,
    "nomeAtor": "string",
    "ocorridoEm": "yyyy-MM-dd'T'HH:mm:ss",
    "possuiAlteracoes": false,
    "tipo": "AGENDA_ATUALIZADA",
    "tituloAgenda": "string"
  },
  "relacoes": [
    {
      "acao": "string",
      "id": 1,
      "identificador": "string",
      "rotulo": "string",
      "tipo": "string"
    }
  ]
}

Exemplos e campos gerados do contrato OpenAPI. Revise os valores antes de integrar.