Skip to content

Habilita ou desabilita abas de um processo

Request

Controla quais abas ficam disponíveis num processo — o mesmo que o modal "Configuração de abas" do Estúdio faz.

Abas aceitas: START (Início), DISPATCH (Despachos), FULL_DOCUMENT (Íntegra), ACCEPTANCE (Aceite), RESUME (Resumo), INTERNAL (Área interna), TAXES (Taxas), HISTORY (Histórico), DOCUMENTS (Documentos), TEMPLATES (Template), STEPS (Etapas). Minúscula é aceita (normalizada pra maiúscula); aba desconhecida responde 400 invalid_tab listando as válidas.

Dois modos, mutuamente exclusivos (os dois juntos = 400 conflicting_fields):

  • delta com enable e/ou disable, que preserva as abas não citadas;
  • replace com availableTabs, que define o conjunto exato e desabilita todo o resto.

Prefira o delta — o replace é fácil de errar pra menos. A mesma aba em enable e disable responde 400 conflicting_tabs.

O :id aceita o UUID do blueprint process ou o _id do assunto no Mongo (24 hex, resolvido via legacyId). A resposta traz o estado final e o que mudou; quando o delta não muda nada, nenhuma escrita é feita e changed volta vazio.

Campo desconhecido no body responde 400 listando os aceitos — em particular from, que não é aceito aqui: blueprint_process não tem histórico, então aceitar o campo faria o caller achar que a autoria foi registrada.

Escopo: uma key tenant só altera abas de processo da própria cidade (403 forbidden_city quando não bate, sem escrever nada). Key support não tem essa restrição.

⚠️ Caveats:

  1. Internamente isto é um read-modify-write e blueprint_process não tem versão nem updatedAt — não há optimistic locking, então um save concorrente no Estúdio pode ser sobrescrito (e vice-versa).
  2. Diferente de form_tramites, isto não é snapshotado dentro do processo: a mudança vale imediatamente para processos já protocolados, no próximo carregamento da tela.
  3. Deixar o processo sem nenhuma aba é bloqueado com 422 empty_available_tabs — para desligar o processo, desabilite o processo.
Security
InternalAuth
Path
idstringrequired

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

Example:69aae29b8f070e4432a63036
Bodyapplication/jsonrequired
enableArray of strings

Abas a habilitar, preservando as demais

Example:
[ "TAXES" ]
disableArray of strings

Abas a desabilitar, preservando as demais

Example:
[ "ACCEPTANCE" ]
availableTabsArray of strings

Conjunto exato de abas (REPLACE completo). Não combine com enable/disable

Example:
[ "START" ]
PATCH
/hub-api/blueprint-process/{id}/tabs
curl -i -X PATCH \
  https://api.producao.aprova.com.br/hub-api/blueprint-process/69aae29b8f070e4432a63036/tabs \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "enable": [
      "TAXES"
    ],
    "disable": [
      "ACCEPTANCE"
    ]
  }'

Responses

Estado final das abas e o que mudou

Bodyapplication/json
blueprintProcessIdstring
Example:"8f2b1c44-9d3e-4a55-b0c1-2e7f9a6d5b41"
legacyIdstring
Example:"69aae29b8f070e4432a63036"
availableTabsArray of strings
Example:
[ "START" ]
changedobject
Response
{ "blueprintProcessId": "8f2b1c44-9d3e-4a55-b0c1-2e7f9a6d5b41", "legacyId": "69aae29b8f070e4432a63036", "availableTabs": [ "START", "DISPATCH", "RESUME", "INTERNAL", "TAXES" ], "changed": { "enabled": [], "disabled": [] } }