Agenda

Listar auditoria de uma atividade.

GET · API de Integração v2

GET/v2/agenda/{agendaId}/auditoria

Retorna somente mutações confirmadas da atividade solicitada. A visibilidade é a mesma da Agenda: responsabilidade, equipe, privacidade e herança são reaplicadas. Não inclui payload, metadata, IP ou sessão.

Autenticação

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

Parâmetros de caminho1

agendaIdintegerobrigatório

agendaId

Parâmetros de consulta2

paginainteger

pagina

tamanhointeger

tamanho

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

{
  "acao": "string",
  "categoria": "ALTERACAO",
  "codigoEvento": "string",
  "descricao": "string",
  "id": 1,
  "nomeAtor": "string",
  "ocorridoEm": "yyyy-MM-dd'T'HH:mm:ss",
  "possuiAlteracoes": false
}

Contrato de respostas

200Página da auditoria retornada.

Página da auditoria retornada.

application/json

acaostring

categoriastring

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

codigoEventostring

Código estável para novos consumidores.

descricaostring

idinteger

formato: int64

nomeAtorstring

Nome histórico do usuário ou executor que produziu o evento.

ocorridoEmstring

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

possuiAlteracoesboolean

401Não autenticado.

Não autenticado.

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

403Sem permissão para visualizar Agenda.

Sem permissão para visualizar Agenda.

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

404Atividade não visível ou inexistente no escritório autenticado.

Atividade não visível ou inexistente no 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/agenda/1/auditoria' \
  --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

{
  "acao": "string",
  "categoria": "ALTERACAO",
  "codigoEvento": "string",
  "descricao": "string",
  "id": 1,
  "nomeAtor": "string",
  "ocorridoEm": "yyyy-MM-dd'T'HH:mm:ss",
  "possuiAlteracoes": false
}

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