Agenda
Buscar atividade por id.
GET · API de Integração v2
GET
/v2/agenda/{id}Retorna a atividade completa (com fluxos/vínculos) se pertencer ao cliente autenticado e não estiver excluída.
Autenticação
X-API-Key no cabeçalho. Como autenticar
Parâmetros de caminho1
idintegerobrigatórioID da atividade de agenda.
Respostas3
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
{
"audienciaId": 1,
"concluido": false,
"cor": "string",
"dataFatal": "yyyy-MM-dd",
"diaTodo": false,
"documentos": [
{
"rotulo": "string",
"url": "string"
}
],
"equipesIds": [
1
],
"expedienteId": 1,
"fim": "yyyy-MM-dd",
"id": 1,
"inicio": "yyyy-MM-dd",
"local": "string",
"observacao": "string",
"pessoaId": 1,
"prioridade": "string",
"privada": false,
"processoId": 1,
"publicacaoId": "string",
"recorrencia": {
"quantidade": 1,
"tipo": "string"
},
"responsaveisIds": [
1
],
"revisores": [
{
"tipo": "string",
"userId": 1
}
],
"tipoAlerta": "string",
"tipoEventoId": 1,
"titulo": "string"
}Contrato de respostas
200Atividade encontrada.
Atividade encontrada.
application/json
audienciaIdintegerformato: int64
concluidobooleancorstringdataFatalstringexemplo: yyyy-MM-dd
diaTodobooleandocumentosDocumentoResponse[]Ver propriedades
rotulostringurlstringequipesIdsinteger[]expedienteIdintegerformato: int64
fimstringexemplo: yyyy-MM-dd
idintegerformato: int64
iniciostringexemplo: yyyy-MM-dd
localstringobservacaostringpessoaIdintegerformato: int64
prioridadestringprivadabooleanprocessoIdintegerformato: int64
publicacaoIdstringrecorrenciaRecorrenciaResponseVer propriedades
quantidadeintegerformato: int32
tipostringresponsaveisIdsinteger[]revisoresRevisorResponse[]Ver propriedades
tipostringuserIdintegerformato: int64
tipoAlertastringtipoEventoIdintegerformato: int64
titulostring400Atividade não encontrada para o cliente autenticado, no contrato Problem Details.
Atividade não encontrada para o cliente autenticado, no contrato Problem Details.
application/json
codestringexemplo: validation_error
correlationIdstringexemplo: c4ce7307-1917-4539-b17a-9c73c972c261
detailstringexemplo: Existem campos inválidos na requisição.
errorsErroItemApiResponse[]Ver propriedades
codestringCódigo estável do erro
exemplo: field_validation_error
fieldstringCampo relacionado
exemplo: agenda.titulo
messagestringMensagem segura
exemplo: não deve estar em branco
instancestringexemplo: /v2/agenda
requestIdstringexemplo: e9db6635-7db3-40cb-8dd2-453c25e6a461
statusintegerformato: int32exemplo: 400
titlestringexemplo: Erro de validação
typestringformato: uriexemplo: /errors/validation-error
401Não autenticado (token ausente/inválido).
Não autenticado (token ausente/inválido).
O contrato não declara um corpo para esta resposta.
