Listar compromissos de um processo.
POST · API de Integração v2
/v2/agenda/processos/{processoId}/compromissosReaproveita a consulta de compromissos da agenda; não inclui expedientes, audiências ou diligências.
Autenticação
X-API-Key no cabeçalho. Como autenticar
Parâmetros de caminho1
processoIdintegerobrigatórioID do processo.
Parâmetros de consulta2
paginaintegerPágina (1-based)
tamanhointegerItens por página (máx. 100)
Corpo da requisição
request
application/json
agendaAudienciasinteger1 = inclui audiências no resultado
Checkbox no explorador: marcado envia 1 (incluir); desmarcado envia 0 (não incluir).
agendaCompromissosinteger1 = inclui compromissos no resultado
Checkbox no explorador: marcado envia 1 (incluir); desmarcado envia 0 (não incluir).
agendaDiligenciainteger1 = inclui diligências no resultado
Checkbox no explorador: marcado envia 1 (incluir); desmarcado envia 0 (não incluir).
agendaExpedientesinteger1 = inclui expedientes no resultado
Checkbox no explorador: marcado envia 1 (incluir); desmarcado envia 0 (não incluir).
agendaItemIdintegerID de um item específico da agenda; usado apenas em consultas internas de detalhe
agendaTarefasAtrasadasstringagendaTarefasCanceladasstringagendaTarefasCompartilhadasstringagendaTarefasConcluidastringagendaTarefasDuplocheckstringagendaTarefasPendentesstringclientestringcolumnstringendstringFim do período (yyyy-MM-dd)
equipestringestadostringfiltroDatastringfiltroVisualizacaostringFiltro da leitura do usuário autenticado: visualizados ou nao_visualizados
numeroProcessostringordemstringOrdenação da ficha do processo pela data do prazo
prioridadestringseSouResponsavelstringRestringe aos compromissos do próprio usuário autenticado
selecionaTipoDeTarefaintegersituacaointegersortFieldstringsortOrderstringstartstringInício do período (yyyy-MM-dd)
statusstringtipostringtribunalstringuserstringuserb2stringRespostas2
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
{
"content": [
{
"arquivos": "string",
"arquivos_url": "string",
"audiencia": {},
"comentarios": {},
"compromisso": {},
"concluido": 1,
"data_fatal": "string",
"data_fim": "string",
"data_inicio": "string",
"diligencia": {},
"expediente": {},
"id": 1,
"marcador": {},
"observacao": "string",
"processo": {},
"publicacao_id": "string",
"responsaveis": {},
"tipo": "string",
"tipo_compromisso": {},
"titulo": "string",
"visualizacao": {}
}
],
"page": 1,
"perPage": 1,
"total": 1,
"totalPages": 1
}Contrato de respostas
200Página de compromissos do processo.
Página de compromissos do processo.
application/json
contentAgendaItemResponse[]Ver propriedades
arquivosstringarquivos_urlstringaudienciaobjectcomentariosobjectcompromissoobjectconcluidointegerdata_fatalstringdata_fimstringdata_iniciostringdiligenciaobjectexpedienteobjectidintegermarcadorobjectobservacaostringprocessoobjectpublicacao_idstringresponsaveisobjecttipostringtipo_compromissoobjecttitulostringvisualizacaoobjectpageintegerperPageintegertotalintegertotalPagesinteger401Não autenticado (token ausente/inválido).
Não autenticado (token ausente/inválido).
O contrato não declara um corpo para esta resposta.
