Skip to content

Lista os despachos vinculados a um processo

Request

Responde "quais despachos estão vinculados a este processo (assunto)", com o nome de cada um — o que permite configurar um assunto sem conhecer nenhum UUID de despacho de antemão.

O :id aceita o UUID do blueprint process ou o _id do assunto no Mongo (24 hex, resolvido via legacyId).

Só tem o nome do assunto? Resolva primeiro em GET /hub-api/type/find?cidade=&uf=&titulo=, que devolve o _id do assunto, e passe esse _id aqui. Esta rota não busca por nome de propósito: a busca por título é semântica do Mongo e duplicá-la aqui criaria uma segunda fonte de verdade.

O vínculo lido é blueprint_process.available_custom_posts (Postgres do core-api) — a resposta declara isso em linkedBy, porque não é o form do assunto no Mongo que guarda essa fiação.

⚠️ Caveats:

  1. UUID vinculado que não existe, ou que é de outra city, volta em unresolved com o motivo e a resposta segue 200 — comum em assunto duplicado entre cidades, que copia a fiação apontando pra ids da city de origem. Uma lista unresolved não vazia é sinal de parametrização quebrada, não de erro da chamada.
  2. Por padrão despacho desabilitado ou deletado aparece na lista com as flags disabled/deleted; use onlyEnabled=true pra esconder. Nada é filtrado sem flag.
  3. É um retrato do momento, sem lock — o Estúdio pode mudar o vínculo no segundo seguinte.
  4. Isto descreve o assunto, não processos já protocolados: form_tramites é snapshotado dentro de cada processo na protocolização.

A direção reversa (dado um despacho, em quais assuntos ele está vinculado) não existe: o vínculo é guardado só no lado do processo, sem back-reference.

Query param desconhecido responde 400 (não é descartado em silêncio).

Security
InternalAuth
Path
idstringrequired

UUID do blueprint process ou _id do assunto no Mongo (24 hex)

Example:69aae29b8f070e4432a63036
Query
hydrateboolean

false devolve só os ids vinculados, sem uma leitura por despacho (mais rápido, sem nome)

Default:true
Example:hydrate=true
onlyEnabledboolean

true esconde despacho desabilitado ou deletado. O default devolve tudo, com as flags

Default:false
Example:onlyEnabled=false
GET
/hub-api/blueprint-process/{id}/blueprint-posts
curl -i -X GET \
  'https://api.producao.aprova.com.br/hub-api/blueprint-process/69aae29b8f070e4432a63036/blueprint-posts?hydrate=true&onlyEnabled=false' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Despachos vinculados ao processo

Bodyapplication/json
processobject
linkedBystring

Qual fiação respondeu — sempre blueprint_process.available_custom_posts

Example:"blueprint_process.available_custom_posts"
totalnumber

Quantidade em blueprintPosts, já com onlyEnabled aplicado

Example:2
blueprintPostsArray of objects
unresolvedArray of objects

Ids vinculados que não deram pra resolver — parametrização quebrada, não erro da chamada

Response
{ "process": { "id": "8f2b1c44-9d3e-4a55-b0c1-2e7f9a6d5b41", "legacyId": "69aae29b8f070e4432a63036", "title": "Alvará de Construção", "subject": "Alvará de Construção", "cityId": 138, "disabled": false }, "linkedBy": "blueprint_process.available_custom_posts", "total": 1, "blueprintPosts": [ {} ], "unresolved": [ {} ] }