{"items":[{"type":"link","label":"Hub API - Aprova","link":"/aprovahubapi","routeSlug":"/aprovahubapi","content":{"contentType":"overview","meta":{"name":"Hub API - Aprova"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"aprovahubapi.json","url":"/_bundle/aprovahubapi.json?download"},{"kind":"download","label":"aprovahubapi.yaml","url":"/_bundle/aprovahubapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"Aprova","email":"suporte@aprova.com.br","label":"suporte@aprova.com.br","withCopyButton":true,"copyContent":"suporte@aprova.com.br"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.producao.aprova.com.br"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Hub API - Aprova","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O Hub API é uma plataforma de abstração de APIs projetada para padronizar e simplificar a integração de sistemas de parceiros terceiros com o Aprova. O principal objetivo é criar um ponto de entrada único e seguro para as funcionalidades do Aprova. Utilizamos um sistema de autenticação robusto para garantir que o uso dos nossos serviços por terceiros seja seguro, controlado e intuitivo. Isso facilita o trabalho de desenvolvedores externos e reduz a complexidade da integração."},"children":[]}]}]}]}],"sectionId":"/aprovahubapi"}],"sectionId":"/aprovahubapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/como-obter-sua-chave-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Como Obter sua Chave API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para começar a usar o Hub API, siga os passos abaixo para habilitar a funcionalidade e gerar suas chaves de acesso:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passo 1: Ative a Permissão de Administrador"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Navegue até: "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outros > Administração Geral > Permissões > Todas as Permissões"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ative a permissão "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hubapi:admin"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vincule essa permissão a um grupo de usuários administradores"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saia do sistema e entre novamente"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passo 2: Acesse o Gerenciador de Chaves"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Após ativar a permissão, um novo menu aparecerá"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Navegue até: "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outros > Administração Geral > Gerenciar Ambiente > Chaves API - Hub API"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passo 3: Crie sua Chave API"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clique em "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criar Chave API"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defina um nome único para identificar a chave"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Copie e salve a chave exibida imediatamente"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IMPORTANTE:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A chave API será exibida por completo apenas "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uma vez"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Após sair da tela, por motivos de segurança, a chave completa "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"não será mostrada novamente"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Certifique-se de armazená-la em um local seguro."},"children":[]}]}]}]}],"sectionId":"/aprovahubapi/section/como-obter-sua-chave-api"}]}]}},{"type":"link","label":"Como Obter sua Chave API","link":"/aprovahubapi/section/como-obter-sua-chave-api","routeSlug":"/aprovahubapi/section/como-obter-sua-chave-api","content":null},{"type":"group","label":"Health","link":"/aprovahubapi/health","routeSlug":"/aprovahubapi/health","items":[{"label":"Health check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/health/health","routeSlug":"/aprovahubapi/health/health","metadata":{"seo":{"title":"Health check","description":"Health check"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"health","name":"Health check","isWebhook":false,"pointer":"/paths/~1hub-api~1health/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Health check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Health check"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hub-api/health","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/hub-api/health","href":"health/health","openApiOperationId":"health","summary":"Health check"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response"}],"pointer":"/paths/~1hub-api~1health/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/health/health"}],"panels":[]}]},"httpPath":"/hub-api/health"}],"content":{"contentType":"group","meta":{"name":"Health"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Health","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hub-api/health","summary":"Health check","prefix":{"name":"get","color":"get"},"badges":[],"link":"/health/health","deprecated":false}]}]}]}]}},{"type":"group","label":"Metrics","link":"/aprovahubapi/metrics","routeSlug":"/aprovahubapi/metrics","items":[{"label":"Métricas do sistema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/metrics/getmetrics","routeSlug":"/aprovahubapi/metrics/getmetrics","metadata":{"seo":{"title":"Métricas do sistema","description":"Métricas do sistema"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMetrics","name":"Métricas do sistema","isWebhook":false,"pointer":"/paths/~1hub-api~1metrics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Métricas do sistema","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hub-api/metrics","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/hub-api/metrics","href":"metrics/getmetrics","openApiOperationId":"getMetrics","summary":"Métricas do sistema"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response"}],"pointer":"/paths/~1hub-api~1metrics/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metrics/getmetrics"}],"panels":[]}]},"httpPath":"/hub-api/metrics"}],"content":{"contentType":"group","meta":{"name":"Metrics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Metrics","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hub-api/metrics","summary":"Métricas do sistema","prefix":{"name":"get","color":"get"},"badges":[],"link":"/metrics/getmetrics","deprecated":false}]}]}]}]}},{"type":"group","label":"API keys","link":"/aprovahubapi/api-keys","routeSlug":"/aprovahubapi/api-keys","items":[{"label":"Cria uma API key v1","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/api-keys/createapikeyv1http","routeSlug":"/aprovahubapi/api-keys/createapikeyv1http","metadata":{"seo":{"title":"Cria uma API key v1","description":"Cria uma API key V1"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createApiKeyV1Http","name":"Cria uma API key v1","isWebhook":false,"pointer":"/paths/~1hub-api~1api-keys/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cria uma API key v1","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cria uma API key V1"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_120"}},"schemaId":"schema_120","pointer":"/paths/~1hub-api~1api-keys/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hub-api/api-keys","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_120"}},"responseCodes":["200","400","401"],"pointer":"/hub-api/api-keys","href":"api-keys/createapikeyv1http","openApiOperationId":"createApiKeyV1Http","summary":"Cria uma API key v1"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"schemaId":"schema_120","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_120"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_121"}},"schemaId":"schema_121"},{"code":"400","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_122"}},"schemaId":"schema_122"},{"code":"401","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}},"schemaId":"schema_123"}],"pointer":"/paths/~1hub-api~1api-keys/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_121","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_121"}}},{"code":"400","schemaId":"schema_122","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_122"}}},{"code":"401","schemaId":"schema_123","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/createapikeyv1http"}],"panels":[]}]},"httpPath":"/hub-api/api-keys"},{"label":"Lista API keys v1 com chave mascarada","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/api-keys/listapikeysv1http","routeSlug":"/aprovahubapi/api-keys/listapikeysv1http","metadata":{"seo":{"title":"Lista API keys v1 com chave mascarada","description":"Lista API keys v1 com chave mascarada"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listApiKeysV1Http","name":"Lista API keys v1 com chave mascarada","isWebhook":false,"pointer":"/paths/~1hub-api~1api-keys~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lista API keys v1 com chave mascarada","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lista API keys v1 com chave mascarada"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":"Authorization"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hub-api/api-keys/list","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/hub-api/api-keys/list","href":"api-keys/listapikeysv1http","openApiOperationId":"listApiKeysV1Http","summary":"Lista API keys v1 com chave mascarada"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_124"}},"schemaId":"schema_124"},{"code":"400","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_125"}},"schemaId":"schema_125"},{"code":"401","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}},"schemaId":"schema_123"}],"pointer":"/paths/~1hub-api~1api-keys~1list/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_124","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_124"}}},{"code":"400","schemaId":"schema_125","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_125"}}},{"code":"401","schemaId":"schema_123","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/listapikeysv1http"}],"panels":[]}]},"httpPath":"/hub-api/api-keys/list"},{"label":"Revoga uma API key v1","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/api-keys/revokeapikeyv1http","routeSlug":"/aprovahubapi/api-keys/revokeapikeyv1http","metadata":{"seo":{"title":"Revoga uma API key v1","description":"Revoga uma API key v1"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"revokeApiKeyV1Http","name":"Revoga uma API key v1","isWebhook":false,"pointer":"/paths/~1hub-api~1api-keys~1revoke/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoga uma API key v1","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revoga uma API key v1"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_126","required":true}],"pointer":"/paths/~1hub-api~1api-keys~1revoke/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hub-api/api-keys/revoke","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[{"name":"id","in":"query","required":true,"example":"key_123","schemaId":"schema_126"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/hub-api/api-keys/revoke","href":"api-keys/revokeapikeyv1http","openApiOperationId":"revokeApiKeyV1Http","summary":"Revoga uma API key v1"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}},"schemaId":"schema_127"},{"code":"400","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128"}},"schemaId":"schema_128"},{"code":"401","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_129","exampleIds":["paths/~1hub-api~1api-keys~1revoke/delete/responses/401/content/application~1json/example"]}},"schemaId":"schema_129","exampleIds":["paths/~1hub-api~1api-keys~1revoke/delete/responses/401/content/application~1json/example"]}],"pointer":"/paths/~1hub-api~1api-keys~1revoke/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_127","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}}},{"code":"400","schemaId":"schema_128","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128"}}},{"code":"401","schemaId":"schema_129","exampleIds":["paths/~1hub-api~1api-keys~1revoke/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_129","exampleIds":["paths/~1hub-api~1api-keys~1revoke/delete/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/revokeapikeyv1http"}],"panels":[]}]},"httpPath":"/hub-api/api-keys/revoke"}],"content":{"contentType":"group","meta":{"name":"API keys"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API keys","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operações relacionadas ao gerenciamento de API Keys"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hub-api/api-keys","summary":"Cria uma API key v1","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-keys/createapikeyv1http","deprecated":false},{"title":"/hub-api/api-keys/list","summary":"Lista API keys v1 com chave mascarada","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-keys/listapikeysv1http","deprecated":false},{"title":"/hub-api/api-keys/revoke","summary":"Revoga uma API key v1","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/api-keys/revokeapikeyv1http","deprecated":false}]}]}]}]}},{"type":"group","label":"Process","link":"/aprovahubapi/process","routeSlug":"/aprovahubapi/process","items":[{"label":"Retorna o JSON cru de um processo ou formulário","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/process/getdocumentjsonv1http","routeSlug":"/aprovahubapi/process/getdocumentjsonv1http","metadata":{"seo":{"title":"Retorna o JSON cru de um processo ou formulário","description":"Retorna o JSON completo (sem transformações) de um processo ou formuláriodiretamente do MongoDB, a partir do ObjectId do documento."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDocumentJsonV1Http","name":"Retorna o JSON cru de um processo ou formulário","isWebhook":false,"pointer":"/paths/~1hub-api~1document~1json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retorna o JSON cru de um processo ou formulário","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna o JSON completo (sem transformações) de um processo ou formulário"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"diretamente do MongoDB, a partir do ObjectId do documento."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controle de acesso por nível de permissão da API Key:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — retorna o documento somente se o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"city_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do documento"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"corresponder ao município vinculado à API Key. Caso contrário, retorna 403."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"support"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — acesso irrestrito, retorna qualquer documento"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"independentemente do município."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_130","description":"ObjectId do documento (24 caracteres hexadecimais)","required":true},{"name":"type","in":"query","schemaId":"schema_131","description":"Tipo do documento","required":true}],"pointer":"/paths/~1hub-api~1document~1json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hub-api/document/json","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[{"name":"id","in":"query","required":true,"example":"507f1f77bcf86cd799439011","schemaId":"schema_130"},{"name":"type","in":"query","required":true,"example":"process","schemaId":"schema_131"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/hub-api/document/json","href":"process/getdocumentjsonv1http","openApiOperationId":"getDocumentJsonV1Http","summary":"Retorna o JSON cru de um processo ou formulário"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"JSON do documento retornado com sucesso","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}},"schemaId":"schema_132"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parâmetros inválidos"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_133"}},"schemaId":"schema_133"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente, inativa ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134"}},"schemaId":"schema_134"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documento não pertence à organização da API Key"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_135"}},"schemaId":"schema_135"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documento não encontrado"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_136"}},"schemaId":"schema_136"}],"pointer":"/paths/~1hub-api~1document~1json/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_132","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}}},{"code":"400","schemaId":"schema_133","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_133"}}},{"code":"401","schemaId":"schema_134","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134"}}},{"code":"403","schemaId":"schema_135","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_135"}}},{"code":"404","schemaId":"schema_136","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_136"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/process/getdocumentjsonv1http"}],"panels":[]}]},"httpPath":"/hub-api/document/json"},{"label":"Resolve um processo pelo número do processo e cidade","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/process/findprocessbynpv1http","routeSlug":"/aprovahubapi/process/findprocessbynpv1http","metadata":{"seo":{"title":"Resolve um processo pelo número do processo e cidade","description":"Resolve o ObjectId de um processo protocolado a partir do número do processo (nP) + cidade(nome) + UF. Use quando você tem o nP mas não tem o código validador — com o ObjectId emmãos, chame GET /hub-api/document/json para o conteúdo completo do processo."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"findProcessByNpV1Http","name":"Resolve um processo pelo número do processo e cidade","isWebhook":false,"pointer":"/paths/~1hub-api~1process~1find-by-np/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resolve um processo pelo número do processo e cidade","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resolve o ObjectId de um processo protocolado a partir do número do processo (nP) + cidade"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(nome) + UF. Use quando você tem o nP mas "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"não"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tem o código validador — com o ObjectId em"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mãos, chame "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /hub-api/document/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" para o conteúdo completo do processo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cidade é resolvida por collation (ignora acento e caixa — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Florianopolis"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" corresponde a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Florianópolis"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No caso raro de cidade duplicada no mesmo UF com match em mais de uma candidata, a resposta"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"traz "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ambiguous: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e a lista "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", sem escolher automaticamente."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Substitui o antigo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /hub-api/process/get-by-np"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (removido — ver "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rotas Removidas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), que"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exigia o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codValid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"nP","in":"query","schemaId":"schema_137","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número do processo"},"children":[]}]}]}],"required":true},{"name":"cidade","in":"query","schemaId":"schema_138","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome da cidade (acento e caixa são ignorados via collation)"},"children":[]}]}]}],"required":true},{"name":"uf","in":"query","schemaId":"schema_139","description":"UF de 2 letras","required":true}],"pointer":"/paths/~1hub-api~1process~1find-by-np/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hub-api/process/find-by-np","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[{"name":"nP","in":"query","required":true,"example":"664-24-FLN-HAB","schemaId":"schema_137"},{"name":"cidade","in":"query","required":true,"example":"Florianópolis","schemaId":"schema_138"},{"name":"uf","in":"query","required":true,"example":"SC","schemaId":"schema_139"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/hub-api/process/find-by-np","href":"process/findprocessbynpv1http","openApiOperationId":"findProcessByNpV1Http","summary":"Resolve um processo pelo número do processo e cidade"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processo resolvido (ou candidatas, quando a cidade é ambígua)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_140","exampleIds":["paths/~1hub-api~1process~1find-by-np/get/responses/200/content/application~1json/examples/Encontrado","paths/~1hub-api~1process~1find-by-np/get/responses/200/content/application~1json/examples/Nao encontrado"]}},"schemaId":"schema_140","exampleIds":["paths/~1hub-api~1process~1find-by-np/get/responses/200/content/application~1json/examples/Encontrado","paths/~1hub-api~1process~1find-by-np/get/responses/200/content/application~1json/examples/Nao encontrado"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parâmetros obrigatórios ausentes"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_141"}},"schemaId":"schema_141"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente, inativa ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}},"schemaId":"schema_142"},{"code":"500","description":"Erro interno do servidor","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143"}},"schemaId":"schema_143"}],"pointer":"/paths/~1hub-api~1process~1find-by-np/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_140","exampleIds":["paths/~1hub-api~1process~1find-by-np/get/responses/200/content/application~1json/examples/Encontrado","paths/~1hub-api~1process~1find-by-np/get/responses/200/content/application~1json/examples/Nao encontrado"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_140","exampleIds":["paths/~1hub-api~1process~1find-by-np/get/responses/200/content/application~1json/examples/Encontrado","paths/~1hub-api~1process~1find-by-np/get/responses/200/content/application~1json/examples/Nao encontrado"]}}},{"code":"400","schemaId":"schema_141","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_141"}}},{"code":"401","schemaId":"schema_142","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/process/findprocessbynpv1http"}],"panels":[]}]},"httpPath":"/hub-api/process/find-by-np"},{"label":"Lista os processos de uma cidade em lote","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/process/listprocessesv1http","routeSlug":"/aprovahubapi/process/listprocessesv1http","metadata":{"seo":{"title":"Lista os processos de uma cidade em lote","description":"Lista os processos de uma cidade em lote, filtrando por período e, opcionalmente, porassunto (typeId). Substitui o padrão de consultar um processo por vez: use esta rotapara varrer o conjunto (carga inicial ou sincronização) e, quando precisar do conteúdocompleto de um processo específico, chame GET /hub-api/document/json com o idretornado aqui."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProcessesV1Http","name":"Lista os processos de uma cidade em lote","isWebhook":false,"pointer":"/paths/~1hub-api~1process~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lista os processos de uma cidade em lote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista os processos de uma cidade em lote, filtrando por período e, opcionalmente, por"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"assunto ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"typeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Substitui o padrão de consultar um processo por vez: use esta rota"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"para varrer o conjunto (carga inicial ou sincronização) e, quando precisar do conteúdo"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completo de um processo específico, chame "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /hub-api/document/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" com o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retornado aqui."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O retorno é "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enxuto"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": identificação, status, assunto e datas. Os dois blocos pesados —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (movimentações) e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (última versão do formulário) — são"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"controlados pelo parâmetro "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Qual data o filtro usa"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (padrão) — processos protocolados no período."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finished"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — processos encerrados no período. Processo reaberto não aparece."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — processos cuja última movimentação caiu no período, inclusive processos"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"antigos que voltaram a se mexer. É o filtro para sincronização incremental"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(\"o que mudou desde X\")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paginação:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a resposta traz "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextCursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Repita a mesma requisição acrescentando"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor=<nextCursor>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" até receber "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextCursor: null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". O cursor é opaco — apenas repasse"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"o valor recebido, sem tentar construí-lo, e não altere os filtros no meio de uma"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"varredura."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Escopo por cidade:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a cidade é sempre a da API Key da cidade. Um "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" informado"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"por essas chaves é ignorado."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use janelas curtas."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" O período aceito chega a 366 dias, mas o custo da consulta cresce"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"com a quantidade de processos existentes no período — e não com o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Em cidades de"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"volume alto, janelas longas podem exceder o tempo limite da consulta e retornar "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recomendamos varrer em janelas de até 15 dias, paginando dentro de cada janela. Se"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"precisar do bloco "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entre 5 e 10 para não estourar o limite de"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tamanho da resposta (ver "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dateStart","in":"query","schemaId":"schema_144","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Início do período, no formato AAAA-MM-DD"},"children":[]}]}]}],"required":true},{"name":"dateEnd","in":"query","schemaId":"schema_145","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fim do período, no formato AAAA-MM-DD. Não pode ser anterior a dateStart e a janela não pode exceder 366 dias"},"children":[]}]}]}],"required":true},{"name":"dateField","in":"query","schemaId":"schema_146","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Qual data o filtro usa — created (protocolo), updated (última movimentação) ou finished (encerramento)"},"children":[]}]}]}]},{"name":"typeId","in":"query","schemaId":"schema_147","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtra por assunto. É o ObjectId do formulário, obtido em GET /hub-api/type/find"},"children":[]}]}]}]},{"name":"include","in":"query","schemaId":"schema_148","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blocos pesados a incluir, separados por vírgula. Aceita timeline e lastVersion. Omitir o parâmetro traz ambos; enviá-lo vazio (include=) não traz nenhum"},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_149","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor da próxima página, obtido no nextCursor da resposta anterior"},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_150","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Itens por página, de 1 a 50"},"children":[]}]}]}]},{"name":"cityId","in":"query","schemaId":"schema_151","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cidade a consultar. Ignorado nas chaves de cidade, que sempre leem a própria cidade"},"children":[]}]}]}]}],"pointer":"/paths/~1hub-api~1process~1list/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hub-api/process/list","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[{"name":"dateStart","in":"query","required":true,"example":"2026-07-01","schemaId":"schema_144"},{"name":"dateEnd","in":"query","required":true,"example":"2026-07-15","schemaId":"schema_145"},{"name":"dateField","in":"query","required":false,"example":"updated","schemaId":"schema_146"},{"name":"typeId","in":"query","required":false,"example":"60df5787146b5035772c5bcd","schemaId":"schema_147"},{"name":"include","in":"query","required":false,"example":"timeline","schemaId":"schema_148"},{"name":"cursor","in":"query","required":false,"example":"6a574d64c801b5200269cea0","schemaId":"schema_149"},{"name":"limit","in":"query","required":false,"example":50,"schemaId":"schema_150"},{"name":"cityId","in":"query","required":false,"example":145,"schemaId":"schema_151"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","500","502"],"pointer":"/hub-api/process/list","href":"process/listprocessesv1http","openApiOperationId":"listProcessesV1Http","summary":"Lista os processos de uma cidade em lote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Página de processos da cidade"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_152","exampleIds":["paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Pagina com proxima","paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Ultima pagina","paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Sem resultados"]}},"schemaId":"schema_152","exampleIds":["paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Pagina com proxima","paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Ultima pagina","paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Sem resultados"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parâmetros inválidos — período ausente, data fora do formato AAAA-MM-DD, dateStart posterior a dateEnd, janela acima de 366 dias, dateField desconhecido, limit fora de 1 a 50, include com bloco inválido ou cursor malformado"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_153","exampleIds":["paths/~1hub-api~1process~1list/get/responses/400/content/application~1json/examples/Janela longa","paths/~1hub-api~1process~1list/get/responses/400/content/application~1json/examples/Include invalido"]}},"schemaId":"schema_153","exampleIds":["paths/~1hub-api~1process~1list/get/responses/400/content/application~1json/examples/Janela longa","paths/~1hub-api~1process~1list/get/responses/400/content/application~1json/examples/Include invalido"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente, inativa ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}},"schemaId":"schema_142"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A consulta excedeu o tempo limite. Acontece quando o período informado concentra processos demais — encurte a janela (recomendamos até 15 dias) e pagine dentro dela"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_154"}},"schemaId":"schema_154"},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A resposta excedeu o limite de tamanho. Acontece ao incluir o bloco lastVersion em páginas grandes — reduza o limit (5 a 10) ou remova lastVersion do include. O corpo desta resposta não é JSON"},"children":[]}]}]}]}],"pointer":"/paths/~1hub-api~1process~1list/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_152","exampleIds":["paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Pagina com proxima","paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Ultima pagina","paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Sem resultados"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_152","exampleIds":["paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Pagina com proxima","paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Ultima pagina","paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Sem resultados"]}}},{"code":"400","schemaId":"schema_153","exampleIds":["paths/~1hub-api~1process~1list/get/responses/400/content/application~1json/examples/Janela longa","paths/~1hub-api~1process~1list/get/responses/400/content/application~1json/examples/Include invalido"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_153","exampleIds":["paths/~1hub-api~1process~1list/get/responses/400/content/application~1json/examples/Janela longa","paths/~1hub-api~1process~1list/get/responses/400/content/application~1json/examples/Include invalido"]}}},{"code":"401","schemaId":"schema_142","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}}},{"code":"500","schemaId":"schema_154","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_154"}}},{"code":"502"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/process/listprocessesv1http"}],"panels":[]}]},"httpPath":"/hub-api/process/list"}],"content":{"contentType":"group","meta":{"name":"Process"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Process","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operações relacionadas à consulta de processos"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hub-api/document/json","summary":"Retorna o JSON cru de um processo ou formulário","prefix":{"name":"get","color":"get"},"badges":[],"link":"/process/getdocumentjsonv1http","deprecated":false},{"title":"/hub-api/process/find-by-np","summary":"Resolve um processo pelo número do processo e cidade","prefix":{"name":"get","color":"get"},"badges":[],"link":"/process/findprocessbynpv1http","deprecated":false},{"title":"/hub-api/process/list","summary":"Lista os processos de uma cidade em lote","prefix":{"name":"get","color":"get"},"badges":[],"link":"/process/listprocessesv1http","deprecated":false}]}]}]}]}},{"type":"group","label":"Dispatch","link":"/aprovahubapi/dispatch","routeSlug":"/aprovahubapi/dispatch","items":[{"label":"Cria um despacho","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/dispatch/createblueprintpostv1http","routeSlug":"/aprovahubapi/dispatch/createblueprintpostv1http","metadata":{"seo":{"title":"Cria um despacho","description":"Cria um novo despacho a partir de um formulário Formly."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBlueprintPostV1Http","name":"Cria um despacho","isWebhook":false,"pointer":"/paths/~1hub-api~1blueprint-post/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cria um despacho","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cria um novo despacho a partir de um formulário Formly."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controle de acesso por nível de permissão da API Key:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — o despacho é vinculado ao município da API Key; o campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é ignorado."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"support"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — o campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é obrigatório e define o município ao qual o despacho pertence."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_155","exampleIds":["paths/~1hub-api~1blueprint-post/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_155","exampleIds":["paths/~1hub-api~1blueprint-post/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1hub-api~1blueprint-post/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hub-api/blueprint-post","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_155","exampleIds":["paths/~1hub-api~1blueprint-post/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","500"],"pointer":"/hub-api/blueprint-post","href":"dispatch/createblueprintpostv1http","openApiOperationId":"createBlueprintPostV1Http","summary":"Cria um despacho"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"schemaId":"schema_155","exampleIds":["paths/~1hub-api~1blueprint-post/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_155","exampleIds":["paths/~1hub-api~1blueprint-post/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Despacho criado com sucesso","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_156","exampleIds":["paths/~1hub-api~1blueprint-post/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_156","exampleIds":["paths/~1hub-api~1blueprint-post/post/responses/201/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parâmetros inválidos"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_157"}},"schemaId":"schema_157"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente, inativa ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134"}},"schemaId":"schema_134"},{"code":"500","description":"Erro interno do servidor","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_158"}},"schemaId":"schema_158"}],"pointer":"/paths/~1hub-api~1blueprint-post/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_156","exampleIds":["paths/~1hub-api~1blueprint-post/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_156","exampleIds":["paths/~1hub-api~1blueprint-post/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_157","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_157"}}},{"code":"401","schemaId":"schema_134","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134"}}},{"code":"500","schemaId":"schema_158","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_158"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dispatch/createblueprintpostv1http"}],"panels":[]}]},"httpPath":"/hub-api/blueprint-post"},{"label":"Busca um despacho por UUID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/dispatch/getblueprintpostv1http","routeSlug":"/aprovahubapi/dispatch/getblueprintpostv1http","metadata":{"seo":{"title":"Busca um despacho por UUID","description":"Retorna o estado atual de um despacho a partir do seu UUID.Útil para fazer merge seguro do form antes de uma edição (PUT) — busque o despacho, altere apenas o necessário e reenvie."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBlueprintPostV1Http","name":"Busca um despacho por UUID","isWebhook":false,"pointer":"/paths/~1hub-api~1blueprint-post~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Busca um despacho por UUID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna o estado atual de um despacho a partir do seu UUID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Útil para fazer merge seguro do "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" antes de uma edição (PUT) — busque o despacho, altere apenas o necessário e reenvie."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_159","description":"UUID do despacho a ser consultado","required":true}],"pointer":"/paths/~1hub-api~1blueprint-post~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hub-api/blueprint-post/{id}","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"schema_159"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/hub-api/blueprint-post/{id}","href":"dispatch/getblueprintpostv1http","openApiOperationId":"getBlueprintPostV1Http","summary":"Busca um despacho por UUID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Despacho encontrado com sucesso","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_160","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parâmetros inválidos"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_161"}},"schemaId":"schema_161"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente, inativa ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134"}},"schemaId":"schema_134"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Despacho não encontrado"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_162"}},"schemaId":"schema_162"},{"code":"500","description":"Erro interno do servidor","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_163"}},"schemaId":"schema_163"}],"pointer":"/paths/~1hub-api~1blueprint-post~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_160","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_161","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_161"}}},{"code":"401","schemaId":"schema_134","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134"}}},{"code":"404","schemaId":"schema_162","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_162"}}},{"code":"500","schemaId":"schema_163","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_163"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dispatch/getblueprintpostv1http"}],"panels":[]}]},"httpPath":"/hub-api/blueprint-post/{id}"},{"label":"Edita um despacho por UUID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/dispatch/updateblueprintpostv1http","routeSlug":"/aprovahubapi/dispatch/updateblueprintpostv1http","metadata":{"seo":{"title":"Edita um despacho por UUID","description":"Atualiza os dados de um despacho existente a partir do seu UUID.Ao menos um dos campos name ou form deve ser fornecido."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBlueprintPostV1Http","name":"Edita um despacho por UUID","isWebhook":false,"pointer":"/paths/~1hub-api~1blueprint-post~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edita um despacho por UUID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Atualiza os dados de um despacho existente a partir do seu UUID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ao menos um dos campos "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ou "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" deve ser fornecido."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_159","description":"UUID do despacho a ser editado","required":true}],"pointer":"/paths/~1hub-api~1blueprint-post~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_164","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_164","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1hub-api~1blueprint-post~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hub-api/blueprint-post/{id}","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"schema_159"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_164","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/hub-api/blueprint-post/{id}","href":"dispatch/updateblueprintpostv1http","openApiOperationId":"updateBlueprintPostV1Http","summary":"Edita um despacho por UUID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"schemaId":"schema_164","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_164","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Despacho atualizado com sucesso","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_156","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/put/responses/200/content/application~1json/example"]}},"schemaId":"schema_156","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/put/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parâmetros inválidos"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_165"}},"schemaId":"schema_165"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente, inativa ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134"}},"schemaId":"schema_134"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Despacho não encontrado"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_162"}},"schemaId":"schema_162"},{"code":"500","description":"Erro interno do servidor","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166"}},"schemaId":"schema_166"}],"pointer":"/paths/~1hub-api~1blueprint-post~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_156","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_156","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_165","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_165"}}},{"code":"401","schemaId":"schema_134","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134"}}},{"code":"404","schemaId":"schema_162","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_162"}}},{"code":"500","schemaId":"schema_166","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dispatch/updateblueprintpostv1http"}],"panels":[]}]},"httpPath":"/hub-api/blueprint-post/{id}"},{"label":"Altera pontos específicos de um despacho","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/dispatch/patchblueprintpostv1http","routeSlug":"/aprovahubapi/dispatch/patchblueprintpostv1http","metadata":{"seo":{"title":"Altera pontos específicos de um despacho","description":"Aplica operações JSON Patch (RFC 6902) no despacho, sem exigir o reenvio do formcompleto. O servidor lê o estado atual, aplica as operações e persiste — se qualqueroperação falhar, nada é escrito."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBlueprintPostV1Http","name":"Altera pontos específicos de um despacho","isWebhook":false,"pointer":"/paths/~1hub-api~1blueprint-post~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Altera pontos específicos de um despacho","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aplica operações "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Patch (RFC 6902)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" no despacho, sem exigir o reenvio do "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completo. O servidor lê o estado atual, aplica as operações e persiste — se qualquer"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operação falhar, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nada é escrito"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use operações "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" como precondição: elas comparam o valor atual com o que você leu no"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e devolvem "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" se o despacho já mudou."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ Isso "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"estreita a janela de sobrescrita, não a elimina"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A aplicação é"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read-modify-write no servidor, então dois "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" concorrentes podem passar ambos os"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e ambos gravar. Atomicidade real exigiria suporte no core-api."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Só "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/form..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" são editáveis (o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"path"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é validado contra "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"^/(form|name)(/|$)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para trocar o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" inteiro, use o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_159","description":"UUID do despacho","required":true}],"pointer":"/paths/~1hub-api~1blueprint-post~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_167","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_167","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1hub-api~1blueprint-post~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/hub-api/blueprint-post/{id}","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"schema_159"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_167","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","409","500"],"pointer":"/hub-api/blueprint-post/{id}","href":"dispatch/patchblueprintpostv1http","openApiOperationId":"patchBlueprintPostV1Http","summary":"Altera pontos específicos de um despacho"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"schemaId":"schema_167","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_167","exampleIds":["paths/~1hub-api~1blueprint-post~1{id}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O despacho já com o patch aplicado — serve pra conferir o que entrou"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_168"}},"schemaId":"schema_168"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operação ou path inválido (ex. path fora de "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_169"}},"schemaId":"schema_169"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente, inativa ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}},"schemaId":"schema_142"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uma operação "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" não bateu: o despacho mudou desde o seu GET. Nada foi escrito"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_170"}},"schemaId":"schema_170"},{"code":"500","description":"Erro interno do servidor","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_171"}},"schemaId":"schema_171"}],"pointer":"/paths/~1hub-api~1blueprint-post~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_168","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_168"}}},{"code":"400","schemaId":"schema_169","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_169"}}},{"code":"401","schemaId":"schema_142","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}}},{"code":"409","schemaId":"schema_170","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_170"}}},{"code":"500","schemaId":"schema_171","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_171"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dispatch/patchblueprintpostv1http"}],"panels":[]}]},"httpPath":"/hub-api/blueprint-post/{id}"}],"content":{"contentType":"group","meta":{"name":"Dispatch"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dispatch","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operações relacionadas à criação e edição de despachos"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hub-api/blueprint-post","summary":"Cria um despacho","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dispatch/createblueprintpostv1http","deprecated":false},{"title":"/hub-api/blueprint-post/{id}","summary":"Busca um despacho por UUID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dispatch/getblueprintpostv1http","deprecated":false},{"title":"/hub-api/blueprint-post/{id}","summary":"Edita um despacho por UUID","prefix":{"name":"put","color":"put"},"badges":[],"link":"/dispatch/updateblueprintpostv1http","deprecated":false},{"title":"/hub-api/blueprint-post/{id}","summary":"Altera pontos específicos de um despacho","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/dispatch/patchblueprintpostv1http","deprecated":false}]}]}]}]}},{"type":"group","label":"Blueprint Process","link":"/aprovahubapi/blueprint-process","routeSlug":"/aprovahubapi/blueprint-process","items":[{"label":"Habilita ou desabilita abas de um processo","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/blueprint-process/updateavailabletabsv1http","routeSlug":"/aprovahubapi/blueprint-process/updateavailabletabsv1http","metadata":{"seo":{"title":"Habilita ou desabilita abas de um processo","description":"Controla quais abas ficam disponíveis num processo — o mesmo que o modal\"Configuração de abas\" do Estúdio faz."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAvailableTabsV1Http","name":"Habilita ou desabilita abas de um processo","isWebhook":false,"pointer":"/paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Habilita ou desabilita abas de um processo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controla quais abas ficam disponíveis num processo — o mesmo que o modal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Configuração de abas\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do Estúdio faz."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Abas aceitas:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"START"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Início), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DISPATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Despachos), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FULL_DOCUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Íntegra),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCEPTANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Aceite), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESUME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Resumo), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Área interna), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TAXES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Taxas),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Histórico), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Documentos), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TEMPLATES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Template), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STEPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Etapas)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minúscula é aceita (normalizada pra maiúscula); aba desconhecida responde "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_tab"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" listando as válidas."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dois modos, mutuamente exclusivos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (os dois juntos = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conflicting_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delta"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e/ou "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", que preserva as abas não citadas;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replace"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableTabs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", que define o conjunto exato e desabilita todo o resto."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefira o delta — o replace é fácil de errar pra menos. A mesma aba em "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disable"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"responde "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conflicting_tabs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" aceita o "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID do blueprint process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ou o "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do assunto no Mongo"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (24 hex,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resolvido via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legacyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). A resposta traz o estado final e o que mudou; quando o delta não"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"muda nada, nenhuma escrita é feita e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" volta vazio."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campo desconhecido no body responde "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" listando os aceitos — em particular "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", que"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"não"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é aceito aqui: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blueprint_process"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" não tem histórico, então aceitar o campo faria o"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"caller achar que a autoria foi registrada."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Escopo:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uma key "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" só altera abas de processo da própria cidade ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forbidden_city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" quando não bate, sem escrever nada). Key "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"support"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" não tem essa restrição."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ Caveats:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internamente isto é um read-modify-write e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blueprint_process"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" não tem versão nem"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — não há "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optimistic locking"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", então um save concorrente no Estúdio pode ser"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sobrescrito (e vice-versa)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Diferente de "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form_tramites"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", isto "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"não"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é snapshotado dentro do processo: a mudança"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vale imediatamente para processos já protocolados, no próximo carregamento da tela."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deixar o processo sem nenhuma aba é bloqueado com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"empty_available_tabs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — para"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"desligar o processo, desabilite o processo."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_172","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID do blueprint process ou "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do assunto no Mongo (24 hex)"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_173","exampleIds":["paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_173","exampleIds":["paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/hub-api/blueprint-process/{id}/tabs","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"69aae29b8f070e4432a63036","schemaId":"schema_172"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_173","exampleIds":["paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/hub-api/blueprint-process/{id}/tabs","href":"blueprint-process/updateavailabletabsv1http","openApiOperationId":"updateAvailableTabsV1Http","summary":"Habilita ou desabilita abas de um processo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"schemaId":"schema_173","exampleIds":["paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_173","exampleIds":["paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Estado final das abas e o que mudou","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_174","exampleIds":["paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_174","exampleIds":["paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pedido malformado — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_tab"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conflicting_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (delta e replace juntos), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conflicting_tabs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (mesma aba em "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ou campo desconhecido no body"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente, inativa ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}},"schemaId":"schema_142"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forbidden_city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — key "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tentando alterar processo de outra cidade. Nada foi escrito"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_176"}},"schemaId":"schema_176"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blueprint_process_not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — nenhum blueprint process para o id (ou o assunto não tem processo espelhado no core-api, comum em assunto legado)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_177"}},"schemaId":"schema_177"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"empty_available_tabs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — o pedido deixaria o processo sem nenhuma aba"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_178"}},"schemaId":"schema_178"},{"code":"500","description":"Erro interno do servidor","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_179"}},"schemaId":"schema_179"}],"pointer":"/paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_174","exampleIds":["paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_174","exampleIds":["paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_175","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_142","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}}},{"code":"403","schemaId":"schema_176","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_176"}}},{"code":"404","schemaId":"schema_177","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_177"}}},{"code":"422","schemaId":"schema_178","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_178"}}},{"code":"500","schemaId":"schema_179","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_179"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blueprint-process/updateavailabletabsv1http"}],"panels":[]}]},"httpPath":"/hub-api/blueprint-process/{id}/tabs"},{"label":"Lista os despachos vinculados a um processo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/blueprint-process/listblueprintpostsv1http","routeSlug":"/aprovahubapi/blueprint-process/listblueprintpostsv1http","metadata":{"seo":{"title":"Lista os despachos vinculados a um processo","description":"Responde \"quais despachos estão vinculados a este processo (assunto)\", com o nome decada um — o que permite configurar um assunto sem conhecer nenhum UUID de despacho deantemão."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBlueprintPostsV1Http","name":"Lista os despachos vinculados a um processo","isWebhook":false,"pointer":"/paths/~1hub-api~1blueprint-process~1{id}~1blueprint-posts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lista os despachos vinculados a um processo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Responde "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"quais despachos estão vinculados a este processo (assunto)\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", com o "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nome"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" de"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cada um — o que permite configurar um assunto sem conhecer nenhum UUID de despacho de"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"antemão."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" aceita o "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID do blueprint process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ou o "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do assunto no Mongo"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (24 hex,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resolvido via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legacyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Só tem o nome do assunto?"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resolva primeiro em"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /hub-api/type/find?cidade=&uf=&titulo="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", que devolve o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do assunto, e passe esse"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" aqui. Esta rota não busca por nome de propósito: a busca por título é semântica do"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mongo e duplicá-la aqui criaria uma segunda fonte de verdade."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O vínculo lido é "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blueprint_process.available_custom_posts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Postgres do core-api) — a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resposta declara isso em "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", porque não é o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do assunto no Mongo que guarda"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"essa fiação."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ Caveats:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID vinculado que não existe, ou que é de outra city, volta em "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unresolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" com o"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"motivo e a resposta segue "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — comum em assunto duplicado entre cidades, que copia a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fiação apontando pra ids da city de "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"origem"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Uma lista "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unresolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" não vazia é sinal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de parametrização quebrada, não de erro da chamada."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Por padrão despacho desabilitado ou deletado aparece na lista "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"com"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as flags"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onlyEnabled=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pra esconder. Nada é filtrado sem flag."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"É um retrato do momento, sem lock — o Estúdio pode mudar o vínculo no segundo seguinte."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Isto descreve o "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"assunto"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", não processos já protocolados: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form_tramites"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"snapshotado dentro de cada processo na protocolização."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A direção reversa (dado um despacho, em quais assuntos ele está vinculado) não existe: o"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vínculo é guardado só no lado do processo, sem back-reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query param desconhecido responde "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (não é descartado em silêncio)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_172","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID do blueprint process ou "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do assunto no Mongo (24 hex)"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hub-api~1blueprint-process~1{id}~1blueprint-posts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"hydrate","in":"query","schemaId":"schema_180","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" devolve só os ids vinculados, sem uma leitura por despacho (mais rápido, sem nome)"},"children":[]}]}]}]},{"name":"onlyEnabled","in":"query","schemaId":"schema_181","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" esconde despacho desabilitado ou deletado. O default devolve tudo, com as flags"},"children":[]}]}]}]}],"pointer":"/paths/~1hub-api~1blueprint-process~1{id}~1blueprint-posts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hub-api/blueprint-process/{id}/blueprint-posts","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"69aae29b8f070e4432a63036","schemaId":"schema_172"}],"query":[{"name":"hydrate","in":"query","required":false,"example":true,"schemaId":"schema_180"},{"name":"onlyEnabled","in":"query","required":false,"example":false,"schemaId":"schema_181"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/hub-api/blueprint-process/{id}/blueprint-posts","href":"blueprint-process/listblueprintpostsv1http","openApiOperationId":"listBlueprintPostsV1Http","summary":"Lista os despachos vinculados a um processo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Despachos vinculados ao processo","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_182","exampleIds":["paths/~1hub-api~1blueprint-process~1{id}~1blueprint-posts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_182","exampleIds":["paths/~1hub-api~1blueprint-process~1{id}~1blueprint-posts/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (nem UUID nem "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" de 24 hex) ou query param desconhecido"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_183"}},"schemaId":"schema_183"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente, inativa ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}},"schemaId":"schema_142"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forbidden_city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — key "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" lendo processo de outra cidade"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_184"}},"schemaId":"schema_184"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blueprint_process_not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" não existe, ou o assunto não tem processo espelhado no core-api (acontece em assunto legado)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_185"}},"schemaId":"schema_185"},{"code":"500","description":"Erro interno do servidor","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_186"}},"schemaId":"schema_186"}],"pointer":"/paths/~1hub-api~1blueprint-process~1{id}~1blueprint-posts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_182","exampleIds":["paths/~1hub-api~1blueprint-process~1{id}~1blueprint-posts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_182","exampleIds":["paths/~1hub-api~1blueprint-process~1{id}~1blueprint-posts/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_183","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_183"}}},{"code":"401","schemaId":"schema_142","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}}},{"code":"403","schemaId":"schema_184","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_184"}}},{"code":"404","schemaId":"schema_185","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_185"}}},{"code":"500","schemaId":"schema_186","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_186"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blueprint-process/listblueprintpostsv1http"}],"panels":[]}]},"httpPath":"/hub-api/blueprint-process/{id}/blueprint-posts"}],"content":{"contentType":"group","meta":{"name":"Blueprint Process"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Blueprint Process","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operações relacionadas à configuração de um processo (assunto) no core-api — abas disponíveis e despachos vinculados"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hub-api/blueprint-process/{id}/tabs","summary":"Habilita ou desabilita abas de um processo","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/blueprint-process/updateavailabletabsv1http","deprecated":false},{"title":"/hub-api/blueprint-process/{id}/blueprint-posts","summary":"Lista os despachos vinculados a um processo","prefix":{"name":"get","color":"get"},"badges":[],"link":"/blueprint-process/listblueprintpostsv1http","deprecated":false}]}]}]}]}},{"type":"group","label":"Type","link":"/aprovahubapi/type","routeSlug":"/aprovahubapi/type","items":[{"label":"Lista os formulários de uma cidade por nome e UF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/type/findtypesbycityv1http","routeSlug":"/aprovahubapi/type/findtypesbycityv1http","metadata":{"seo":{"title":"Lista os formulários de uma cidade por nome e UF","description":"Lista os formulários (types) de uma cidade a partir do NOME + UF, opcionalmentefiltrando pelo título. Resolve a cidade por collation (ignora acento e caixa —Chapeco corresponde a Chapecó). Use para descobrir o ObjectId de um formulárioa partir da cidade e do nome, sem consultar o MongoDB diretamente."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"findTypesByCityV1Http","name":"Lista os formulários de uma cidade por nome e UF","isWebhook":false,"pointer":"/paths/~1hub-api~1type~1find/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lista os formulários de uma cidade por nome e UF","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista os formulários (types) de uma cidade a partir do NOME + UF, opcionalmente"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filtrando pelo título. Resolve a cidade por collation (ignora acento e caixa —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Chapeco"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" corresponde a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Chapecó"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Use para descobrir o ObjectId de um formulário"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a partir da cidade e do nome, sem consultar o MongoDB diretamente."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O filtro "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"titulo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contains"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" case-insensitive, porém "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sensível a acento"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"envie o termo com o acento correto ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Alvará"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", não "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Alvara"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Sem "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"titulo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", retorna"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"todos os formulários da cidade."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No caso raro de cidade duplicada no mesmo UF com formulários em mais de uma"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"candidata, a resposta traz "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ambiguous: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e a lista "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", sem escolher"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automaticamente."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cidade","in":"query","schemaId":"schema_187","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome da cidade (acento e caixa são ignorados via collation)"},"children":[]}]}]}],"required":true},{"name":"uf","in":"query","schemaId":"schema_139","description":"UF de 2 letras","required":true},{"name":"titulo","in":"query","schemaId":"schema_188","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtro opcional pelo título (contains, case-insensitive, sensível a acento)"},"children":[]}]}]}]}],"pointer":"/paths/~1hub-api~1type~1find/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hub-api/type/find","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[{"name":"cidade","in":"query","required":true,"example":"Chapecó","schemaId":"schema_187"},{"name":"uf","in":"query","required":true,"example":"SC","schemaId":"schema_139"},{"name":"titulo","in":"query","required":false,"example":"Habite","schemaId":"schema_188"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/hub-api/type/find","href":"type/findtypesbycityv1http","openApiOperationId":"findTypesByCityV1Http","summary":"Lista os formulários de uma cidade por nome e UF"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de formulários da cidade"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_189","exampleIds":["paths/~1hub-api~1type~1find/get/responses/200/content/application~1json/examples/Encontrada","paths/~1hub-api~1type~1find/get/responses/200/content/application~1json/examples/Nao encontrada"]}},"schemaId":"schema_189","exampleIds":["paths/~1hub-api~1type~1find/get/responses/200/content/application~1json/examples/Encontrada","paths/~1hub-api~1type~1find/get/responses/200/content/application~1json/examples/Nao encontrada"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parâmetros obrigatórios ausentes"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_190"}},"schemaId":"schema_190"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente, inativa ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}},"schemaId":"schema_142"}],"pointer":"/paths/~1hub-api~1type~1find/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_189","exampleIds":["paths/~1hub-api~1type~1find/get/responses/200/content/application~1json/examples/Encontrada","paths/~1hub-api~1type~1find/get/responses/200/content/application~1json/examples/Nao encontrada"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_189","exampleIds":["paths/~1hub-api~1type~1find/get/responses/200/content/application~1json/examples/Encontrada","paths/~1hub-api~1type~1find/get/responses/200/content/application~1json/examples/Nao encontrada"]}}},{"code":"400","schemaId":"schema_190","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_190"}}},{"code":"401","schemaId":"schema_142","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/type/findtypesbycityv1http"}],"panels":[]}]},"httpPath":"/hub-api/type/find"},{"label":"Cria um novo assunto","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/type/createtypev1http","routeSlug":"/aprovahubapi/type/createtypev1http","metadata":{"seo":{"title":"Cria um novo assunto","description":"Cria um novo assunto associado à cidade do tenant identificado pela API Key. Para keys compermissionLevel support, o campo cityId deve ser informado no body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTypeV1Http","name":"Cria um novo assunto","isWebhook":false,"pointer":"/paths/~1hub-api~1type~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cria um novo assunto","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cria um novo assunto associado à cidade do tenant identificado pela API Key. Para keys com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permissionLevel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" support, o campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" deve ser informado no body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opcionalmente "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"semeia conteúdo já na criação"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e/ou "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — sem eles,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"um formulário grande só tinha o caminho "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cria vazio + edita"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", e o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type/edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é REPLACE"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"total da raiz."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" faz "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MERGE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sobre o template do modelo: mande só o que quer definir ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sigla"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"templates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", …). O "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cidade"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dentro do "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é ignorado — quem decide é o"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cidade"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do topo do body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (área externa) "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"substitui"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" o stepper vazio do template."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" define o fluxo de etapas do assunto."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_191","exampleIds":["paths/~1hub-api~1type~1create/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_191","exampleIds":["paths/~1hub-api~1type~1create/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1hub-api~1type~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hub-api/type/create","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_191","exampleIds":["paths/~1hub-api~1type~1create/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","500"],"pointer":"/hub-api/type/create","href":"type/createtypev1http","openApiOperationId":"createTypeV1Http","summary":"Cria um novo assunto"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"schemaId":"schema_191","exampleIds":["paths/~1hub-api~1type~1create/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_191","exampleIds":["paths/~1hub-api~1type~1create/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Assunto criado com sucesso","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_192","exampleIds":["paths/~1hub-api~1type~1create/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_192","exampleIds":["paths/~1hub-api~1type~1create/post/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requisição inválida"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_193","exampleIds":["paths/~1hub-api~1type~1create/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_193","exampleIds":["paths/~1hub-api~1type~1create/post/responses/400/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Não autorizado"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1hub-api~1type~1create/post/responses/401/content/application~1json/example"]}},"schemaId":"schema_142","exampleIds":["paths/~1hub-api~1type~1create/post/responses/401/content/application~1json/example"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro interno. Quando a falha vem do types service, a resposta traz "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error: \"Upstream Error\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" com a mensagem original do upstream — 5xx não é mais achatado num \"Erro interno\" sem causa"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_194"}},"schemaId":"schema_194"}],"pointer":"/paths/~1hub-api~1type~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_192","exampleIds":["paths/~1hub-api~1type~1create/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_192","exampleIds":["paths/~1hub-api~1type~1create/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_193","exampleIds":["paths/~1hub-api~1type~1create/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_193","exampleIds":["paths/~1hub-api~1type~1create/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_142","exampleIds":["paths/~1hub-api~1type~1create/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1hub-api~1type~1create/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"schema_194","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_194"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/type/createtypev1http"}],"panels":[]}]},"httpPath":"/hub-api/type/create"},{"label":"Atualiza um assunto com validação","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/type/updatetypevalidationv1http","routeSlug":"/aprovahubapi/type/updatetypevalidationv1http","metadata":{"seo":{"title":"Atualiza um assunto com validação","description":"Atualiza um assunto existente com validação. O body aceita config, form, step e/ouform_tramites — qualquer outro campo é ignorado pela allowlist do service, e um body semnenhum campo permitido retorna 400."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTypeValidationV1Http","name":"Atualiza um assunto com validação","isWebhook":false,"pointer":"/paths/~1hub-api~1type~1edit~1{typeId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Atualiza um assunto com validação","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Atualiza um assunto existente com validação. O body aceita "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e/ou"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form_tramites"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — qualquer outro campo é ignorado pela allowlist do service, e um body sem"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nenhum campo permitido retorna "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Semântica de escrita por campo:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" usam "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dot-notation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": enviar "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ step: { config: [...] } }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" substitui"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"apenas "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step.config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e mantém "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step.shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" intacto. Para trocar o objeto inteiro, envie"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"todas as subchaves explicitamente."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REPLACE completo"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do array."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form_tramites"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (área interna / aba de trâmite) também é "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REPLACE completo"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do array e,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no assunto, mora em "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.form_tramites"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Pode ser enviado no topo do body"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ form_tramites: [...] }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", normalizado para "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.form_tramites"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ou"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" aninhado em"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — nunca nos dois no mesmo request ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conflicting_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Precisa ser array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_field_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Na resposta ele volta dentro de "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form_tramites"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"snapshotado"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dentro de cada processo na protocolização. Editar o"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"assunto só afeta processos "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"novos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; processos já protocolados exigem migração na"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"collection "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"process"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O campo opcional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifica o caller no histórico do assunto ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"historico_types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ex.: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"davi-bot:ticket-259147\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Sem "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", o histórico é registrado como "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"hub-api\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O limite de corpo desta rota é de "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 MB"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (forms Formly grandes estouravam o default de"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 MiB do Fastify)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"typeId","in":"path","schemaId":"schema_195","description":"ID MongoDB do assunto","required":true,"example":"69aae29b8f070e4432a63036"}],"pointer":"/paths/~1hub-api~1type~1edit~1{typeId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_196","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_196","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1hub-api~1type~1edit~1{typeId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/hub-api/type/edit/{typeId}","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[{"name":"typeId","in":"path","required":true,"example":"69aae29b8f070e4432a63036","schemaId":"schema_195"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_196","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","500"],"pointer":"/hub-api/type/edit/{typeId}","href":"type/updatetypevalidationv1http","openApiOperationId":"updateTypeValidationV1Http","summary":"Atualiza um assunto com validação"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"schemaId":"schema_196","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_196","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Assunto atualizado com sucesso","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_197","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_197","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requisição inválida"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_198","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Nenhum campo valido","paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Campos conflitantes","paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Tipo invalido"]}},"schemaId":"schema_198","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Nenhum campo valido","paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Campos conflitantes","paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Tipo invalido"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Não autorizado"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/401/content/application~1json/example"]}},"schemaId":"schema_142","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/401/content/application~1json/example"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro interno. Quando a falha vem do types service, a resposta traz "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error: \"Upstream Error\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" com a mensagem original do upstream — 5xx não é mais achatado num \"Erro interno\" sem causa"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_194"}},"schemaId":"schema_194"}],"pointer":"/paths/~1hub-api~1type~1edit~1{typeId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_197","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_197","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_198","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Nenhum campo valido","paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Campos conflitantes","paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Tipo invalido"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_198","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Nenhum campo valido","paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Campos conflitantes","paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Tipo invalido"]}}},{"code":"401","schemaId":"schema_142","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"schema_194","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_194"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/type/updatetypevalidationv1http"}],"panels":[]}]},"httpPath":"/hub-api/type/edit/{typeId}"},{"label":"Altera pontos específicos de um assunto","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/type/patchtypev1http","routeSlug":"/aprovahubapi/type/patchtypev1http","metadata":{"seo":{"title":"Altera pontos específicos de um assunto","description":"Aplica operações JSON Patch (RFC 6902) no assunto, sem exigir o reenvio do form ou doconfig completos. O servidor lê o estado atual, aplica as operações e persiste — sequalquer operação falhar, nada é escrito."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchTypeV1Http","name":"Altera pontos específicos de um assunto","isWebhook":false,"pointer":"/paths/~1hub-api~1type~1patch~1{typeId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Altera pontos específicos de um assunto","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aplica operações "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Patch (RFC 6902)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" no assunto, sem exigir o reenvio do "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ou do"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" completos. O servidor lê o estado atual, aplica as operações e persiste — se"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"qualquer operação falhar, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nada é escrito"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use operações "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" como precondição: elas comparam o valor atual com o que você leu no"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e devolvem "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" se o assunto já mudou."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ Isso "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"estreita a janela de sobrescrita, não a elimina"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A aplicação é"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read-modify-write no servidor, então dois "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" concorrentes podem passar ambos os"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e ambos gravar. Atomicidade real exigiria escrita por caminho no types service."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Escopo do "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"path"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" só "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/config..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/form..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/step..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" são editáveis — as demais"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"raízes o types service descarta em silêncio, então a rota recusa com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" antes de gravar."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para substituir uma raiz inteira, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /hub-api/type/edit/{typeId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limites:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" no máximo 50 operações por request (lote maior é replace de raiz disfarçado) e"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"profundidade de ponteiro de até 30 níveis. O corpo aceita até "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 MB"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", alinhado com o"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type/edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Só as raízes efetivamente "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mutadas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" vão no commit — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é precondição, não escrita."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assunto no formato legado"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (raiz gravada como string de JSON, ex. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): a rota"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"responde "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nomeando o caso — não há caminho para endereçar dentro de um escalar."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Normalize a raiz inteira antes, com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /hub-api/type/edit/{typeId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"typeId","in":"path","schemaId":"schema_199","description":"ObjectId do assunto (hex de 24 chars)","required":true}],"pointer":"/paths/~1hub-api~1type~1patch~1{typeId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_200","exampleIds":["paths/~1hub-api~1type~1patch~1{typeId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_200","exampleIds":["paths/~1hub-api~1type~1patch~1{typeId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1hub-api~1type~1patch~1{typeId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/hub-api/type/patch/{typeId}","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[{"name":"typeId","in":"path","required":true,"example":"69aae29b8f070e4432a63036","schemaId":"schema_199"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_200","exampleIds":["paths/~1hub-api~1type~1patch~1{typeId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","409","422","500"],"pointer":"/hub-api/type/patch/{typeId}","href":"type/patchtypev1http","openApiOperationId":"patchTypeV1Http","summary":"Altera pontos específicos de um assunto"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"schemaId":"schema_200","exampleIds":["paths/~1hub-api~1type~1patch~1{typeId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_200","exampleIds":["paths/~1hub-api~1type~1patch~1{typeId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O assunto já com o patch aplicado"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_201"}},"schemaId":"schema_201"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Op/path inválido, path fora de "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", teto de operações ou profundidade estourado, ou raiz gravada como escalar (assunto legado)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_202"}},"schemaId":"schema_202"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente, inativa ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}},"schemaId":"schema_142"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assunto não encontrado. Nada foi escrito"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_203"}},"schemaId":"schema_203"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uma operação "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" não bateu: o assunto mudou desde o seu GET. Nada foi escrito"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_204"}},"schemaId":"schema_204"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O patch deixaria uma raiz fora da forma exigida ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objeto). Como o commit faz REPLACE dessa raiz, isso destruiria o conteúdo dela. Nada foi escrito"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_205"}},"schemaId":"schema_205"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro interno. Falha do types service chega como "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Upstream Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" com a causa original"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_206"}},"schemaId":"schema_206"}],"pointer":"/paths/~1hub-api~1type~1patch~1{typeId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_201","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_201"}}},{"code":"400","schemaId":"schema_202","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_202"}}},{"code":"401","schemaId":"schema_142","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}}},{"code":"404","schemaId":"schema_203","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_203"}}},{"code":"409","schemaId":"schema_204","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_204"}}},{"code":"422","schemaId":"schema_205","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_205"}}},{"code":"500","schemaId":"schema_206","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_206"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/type/patchtypev1http"}],"panels":[]}]},"httpPath":"/hub-api/type/patch/{typeId}"},{"label":"Duplica um assunto no mesmo ambiente ou para outra cidade","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/type/duplicatetypev1http","routeSlug":"/aprovahubapi/type/duplicatetypev1http","metadata":{"seo":{"title":"Duplica um assunto no mesmo ambiente ou para outra cidade","description":"Duplica um assunto (type) existente. Uma rota só para os dois casos:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"duplicateTypeV1Http","name":"Duplica um assunto no mesmo ambiente ou para outra cidade","isWebhook":false,"pointer":"/paths/~1hub-api~1type~1duplicate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Duplica um assunto no mesmo ambiente ou para outra cidade","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplica um assunto (type) existente. Uma rota só para os dois casos:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sem "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityId"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a cópia fica no "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mesmo ambiente"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do assunto de origem. Os templates"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"são "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"compartilhados"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" com o original e a numeração é herdada."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityId"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a cópia vai para a cidade informada. Ao cruzar de ambiente, os templates"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"do assunto são copiados para "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<CidadeUF>/<arquivo>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (idempotente: reaproveita o arquivo se"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"já existir), junto com a configuração de prancha, e a numeração "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"não"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é herdada."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"city.index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — o mesmo valor devolvido em "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"city.index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pelo"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /hub-api/type/find"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fiação apontando para a cidade de origem."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.form_tramites"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fluxograma"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.blueprintPosts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" são copiados como estão e continuam apontando para ids de setor e"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de despacho da cidade de "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"origem"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Ao copiar entre cidades, essa fiação precisa ser"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reapontada depois da duplicação."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permissões."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Keys "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" só duplicam para o próprio ambiente "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" só a partir de um"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"assunto do próprio ambiente — origem fora do escopo retorna "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Escolher outra cidade de"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"destino, ou duplicar um assunto de outra cidade, exige key "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"support"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_207","exampleIds":["paths/~1hub-api~1type~1duplicate/post/requestBody/content/application~1json/examples/Mesmo ambiente","paths/~1hub-api~1type~1duplicate/post/requestBody/content/application~1json/examples/Outra cidade"]}},"schemaId":"schema_207","exampleIds":["paths/~1hub-api~1type~1duplicate/post/requestBody/content/application~1json/examples/Mesmo ambiente","paths/~1hub-api~1type~1duplicate/post/requestBody/content/application~1json/examples/Outra cidade"],"pointer":"/paths/~1hub-api~1type~1duplicate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hub-api/type/duplicate","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_207","exampleIds":["paths/~1hub-api~1type~1duplicate/post/requestBody/content/application~1json/examples/Mesmo ambiente","paths/~1hub-api~1type~1duplicate/post/requestBody/content/application~1json/examples/Outra cidade"]}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/hub-api/type/duplicate","href":"type/duplicatetypev1http","openApiOperationId":"duplicateTypeV1Http","summary":"Duplica um assunto no mesmo ambiente ou para outra cidade"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"schemaId":"schema_207","exampleIds":["paths/~1hub-api~1type~1duplicate/post/requestBody/content/application~1json/examples/Mesmo ambiente","paths/~1hub-api~1type~1duplicate/post/requestBody/content/application~1json/examples/Outra cidade"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_207","exampleIds":["paths/~1hub-api~1type~1duplicate/post/requestBody/content/application~1json/examples/Mesmo ambiente","paths/~1hub-api~1type~1duplicate/post/requestBody/content/application~1json/examples/Outra cidade"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Assunto duplicado com sucesso","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_208","exampleIds":["paths/~1hub-api~1type~1duplicate/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_208","exampleIds":["paths/~1hub-api~1type~1duplicate/post/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requisição inválida"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_209","exampleIds":["paths/~1hub-api~1type~1duplicate/post/responses/400/content/application~1json/examples/typeId ausente","paths/~1hub-api~1type~1duplicate/post/responses/400/content/application~1json/examples/typeId invalido"]}},"schemaId":"schema_209","exampleIds":["paths/~1hub-api~1type~1duplicate/post/responses/400/content/application~1json/examples/typeId ausente","paths/~1hub-api~1type~1duplicate/post/responses/400/content/application~1json/examples/typeId invalido"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente, inativa ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}},"schemaId":"schema_142"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key sem permissão para o destino ou para a origem informados (key tenant pedindo outra cidade, ou duplicando assunto de outra cidade)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_210"}},"schemaId":"schema_210"},{"code":"404","description":"Assunto de origem ou cidade destino inexistente","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_211"}},"schemaId":"schema_211"},{"code":"500","description":"Erro interno do servidor","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143"}},"schemaId":"schema_143"}],"pointer":"/paths/~1hub-api~1type~1duplicate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_208","exampleIds":["paths/~1hub-api~1type~1duplicate/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_208","exampleIds":["paths/~1hub-api~1type~1duplicate/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_209","exampleIds":["paths/~1hub-api~1type~1duplicate/post/responses/400/content/application~1json/examples/typeId ausente","paths/~1hub-api~1type~1duplicate/post/responses/400/content/application~1json/examples/typeId invalido"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_209","exampleIds":["paths/~1hub-api~1type~1duplicate/post/responses/400/content/application~1json/examples/typeId ausente","paths/~1hub-api~1type~1duplicate/post/responses/400/content/application~1json/examples/typeId invalido"]}}},{"code":"401","schemaId":"schema_142","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}}},{"code":"403","schemaId":"schema_210","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_210"}}},{"code":"404","schemaId":"schema_211","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_211"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/type/duplicatetypev1http"}],"panels":[]}]},"httpPath":"/hub-api/type/duplicate"}],"content":{"contentType":"group","meta":{"name":"Type"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Type","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operações relacionadas a assuntos (types)"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hub-api/type/find","summary":"Lista os formulários de uma cidade por nome e UF","prefix":{"name":"get","color":"get"},"badges":[],"link":"/type/findtypesbycityv1http","deprecated":false},{"title":"/hub-api/type/create","summary":"Cria um novo assunto","prefix":{"name":"post","color":"post"},"badges":[],"link":"/type/createtypev1http","deprecated":false},{"title":"/hub-api/type/edit/{typeId}","summary":"Atualiza um assunto com validação","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/type/updatetypevalidationv1http","deprecated":false},{"title":"/hub-api/type/patch/{typeId}","summary":"Altera pontos específicos de um assunto","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/type/patchtypev1http","deprecated":false},{"title":"/hub-api/type/duplicate","summary":"Duplica um assunto no mesmo ambiente ou para outra cidade","prefix":{"name":"post","color":"post"},"badges":[],"link":"/type/duplicatetypev1http","deprecated":false}]}]}]}]}},{"type":"group","label":"Template","link":"/aprovahubapi/template","routeSlug":"/aprovahubapi/template","items":[{"label":"Retorna o HTML de um template pelo nome","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/template/gettemplatev1http","routeSlug":"/aprovahubapi/template/gettemplatev1http","metadata":{"seo":{"title":"Retorna o HTML de um template pelo nome","description":"Retorna o conteúdo HTML de um template de processo a partir do seu nome.O nome do template segue o padrão {Cidade}/{NomeArquivo}.html (ex: MogidascruzesSP/Alvara_Aprovacao_Execucao_Projetos.html)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTemplateV1Http","name":"Retorna o HTML de um template pelo nome","isWebhook":false,"pointer":"/paths/~1hub-api~1template/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retorna o HTML de um template pelo nome","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna o conteúdo HTML de um template de processo a partir do seu nome."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O nome do template segue o padrão "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{Cidade}/{NomeArquivo}.html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (ex: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MogidascruzesSP/Alvara_Aprovacao_Execucao_Projetos.html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seleção da versão:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usa a versão ativa ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actual_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") quando existir e tiver HTML válido"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Caso contrário, utiliza a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"última versão"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (maior índice) com HTML válido"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite fallback quando "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actual_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" está ausente ou aponta para versão sem conteúdo"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validação de HTML:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna 404 quando o HTML está vazio, nulo ou contém apenas espaços em branco"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possíveis erros 404:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template não encontrado no banco"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template sem versões"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template sem HTML válido (vazio ou inexistente) em nenhuma versão"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_212","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome do template no formato "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{Cidade}/{NomeArquivo}.html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hub-api~1template/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hub-api/template","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","required":true,"example":"MogidascruzesSP/Alvara_Aprovacao_Execucao_Projetos.html","schemaId":"schema_212"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/hub-api/template","href":"template/gettemplatev1http","openApiOperationId":"getTemplateV1Http","summary":"Retorna o HTML de um template pelo nome"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Template encontrado com sucesso","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_213"}},"schemaId":"schema_213"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parâmetro obrigatório ausente"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_214","exampleIds":["paths/~1hub-api~1template/get/responses/400/content/application~1json/example"]}},"schemaId":"schema_214","exampleIds":["paths/~1hub-api~1template/get/responses/400/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1hub-api~1template/get/responses/401/content/application~1json/example"]}},"schemaId":"schema_142","exampleIds":["paths/~1hub-api~1template/get/responses/401/content/application~1json/example"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template não encontrado. Possíveis mensagens:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template não encontrado no banco"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template sem versões"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template sem HTML válido (vazio ou inexistente) em nenhuma versão"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_215","exampleIds":["paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/template_not_found","paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/no_versions","paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/no_valid_html"]}},"schemaId":"schema_215","exampleIds":["paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/template_not_found","paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/no_versions","paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/no_valid_html"]},{"code":"500","description":"Erro interno do servidor","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143"}},"schemaId":"schema_143"}],"pointer":"/paths/~1hub-api~1template/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_213","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_213"}}},{"code":"400","schemaId":"schema_214","exampleIds":["paths/~1hub-api~1template/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_214","exampleIds":["paths/~1hub-api~1template/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_142","exampleIds":["paths/~1hub-api~1template/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1hub-api~1template/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_215","exampleIds":["paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/template_not_found","paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/no_versions","paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/no_valid_html"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_215","exampleIds":["paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/template_not_found","paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/no_versions","paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/no_valid_html"]}}},{"code":"500","schemaId":"schema_143","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template/gettemplatev1http"}],"panels":[]}]},"httpPath":"/hub-api/template"},{"label":"Cria um novo template HTML","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/template/createtemplatev1http","routeSlug":"/aprovahubapi/template/createtemplatev1http","metadata":{"seo":{"title":"Cria um novo template HTML","description":"Cria um novo template de documento HTML associado a uma cidade.O nome do template segue o padrão {Cidade}/{NomeArquivo}.html (ex: MogidascruzesSP/Alvara.html)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTemplateV1Http","name":"Cria um novo template HTML","isWebhook":false,"pointer":"/paths/~1hub-api~1template~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cria um novo template HTML","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cria um novo template de documento HTML associado a uma cidade."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O nome do template segue o padrão "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{Cidade}/{NomeArquivo}.html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (ex: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MogidascruzesSP/Alvara.html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O campo opcional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifica o caller no histórico de versões do template"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(ex.: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ticket-solver:movidesk-259147: template novo\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Sem "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", o histórico é"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registrado como "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"hub-api\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_216","exampleIds":["paths/~1hub-api~1template~1create/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_216","exampleIds":["paths/~1hub-api~1template~1create/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1hub-api~1template~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hub-api/template/create","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_216","exampleIds":["paths/~1hub-api~1template~1create/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","500"],"pointer":"/hub-api/template/create","href":"template/createtemplatev1http","openApiOperationId":"createTemplateV1Http","summary":"Cria um novo template HTML"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"schemaId":"schema_216","exampleIds":["paths/~1hub-api~1template~1create/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_216","exampleIds":["paths/~1hub-api~1template~1create/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Template criado com sucesso","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_217"}},"schemaId":"schema_217"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parâmetro obrigatório ausente"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_218"}},"schemaId":"schema_218"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1hub-api~1template~1create/post/responses/401/content/application~1json/example"]}},"schemaId":"schema_142","exampleIds":["paths/~1hub-api~1template~1create/post/responses/401/content/application~1json/example"]},{"code":"500","description":"Erro interno do servidor","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143"}},"schemaId":"schema_143"}],"pointer":"/paths/~1hub-api~1template~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_217","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_217"}}},{"code":"400","schemaId":"schema_218","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_218"}}},{"code":"401","schemaId":"schema_142","exampleIds":["paths/~1hub-api~1template~1create/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1hub-api~1template~1create/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"schema_143","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template/createtemplatev1http"}],"panels":[]}]},"httpPath":"/hub-api/template/create"},{"label":"Atualiza um template HTML existente","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/template/updatetemplatev1http","routeSlug":"/aprovahubapi/template/updatetemplatev1http","metadata":{"seo":{"title":"Atualiza um template HTML existente","description":"Atualiza o conteúdo HTML de um template existente, identificado pelo name.Cria uma nova versão do template a partir do HTML enviado."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTemplateV1Http","name":"Atualiza um template HTML existente","isWebhook":false,"pointer":"/paths/~1hub-api~1template~1edit/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Atualiza um template HTML existente","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Atualiza o conteúdo HTML de um template existente, identificado pelo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cria uma nova versão do template a partir do HTML enviado."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O campo opcional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifica o caller no histórico de versões do template"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(ex.: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ticket-solver:movidesk-259147: ajuste no cabeçalho\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Sem "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", o histórico é"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registrado como "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"hub-api\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_219","exampleIds":["paths/~1hub-api~1template~1edit/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_219","exampleIds":["paths/~1hub-api~1template~1edit/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1hub-api~1template~1edit/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hub-api/template/edit","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_219","exampleIds":["paths/~1hub-api~1template~1edit/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/hub-api/template/edit","href":"template/updatetemplatev1http","openApiOperationId":"updateTemplateV1Http","summary":"Atualiza um template HTML existente"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"schemaId":"schema_219","exampleIds":["paths/~1hub-api~1template~1edit/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_219","exampleIds":["paths/~1hub-api~1template~1edit/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Template atualizado com sucesso","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_220"}},"schemaId":"schema_220"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parâmetro obrigatório ausente"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_218"}},"schemaId":"schema_218"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1hub-api~1template~1edit/put/responses/401/content/application~1json/example"]}},"schemaId":"schema_142","exampleIds":["paths/~1hub-api~1template~1edit/put/responses/401/content/application~1json/example"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template não encontrado"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_221"}},"schemaId":"schema_221"},{"code":"500","description":"Erro interno do servidor","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143"}},"schemaId":"schema_143"}],"pointer":"/paths/~1hub-api~1template~1edit/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_220","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_220"}}},{"code":"400","schemaId":"schema_218","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_218"}}},{"code":"401","schemaId":"schema_142","exampleIds":["paths/~1hub-api~1template~1edit/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1hub-api~1template~1edit/put/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_221","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_221"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/template/updatetemplatev1http"}],"panels":[]}]},"httpPath":"/hub-api/template/edit"}],"content":{"contentType":"group","meta":{"name":"Template"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Template","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operações relacionadas a templates de processos"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hub-api/template","summary":"Retorna o HTML de um template pelo nome","prefix":{"name":"get","color":"get"},"badges":[],"link":"/template/gettemplatev1http","deprecated":false},{"title":"/hub-api/template/create","summary":"Cria um novo template HTML","prefix":{"name":"post","color":"post"},"badges":[],"link":"/template/createtemplatev1http","deprecated":false},{"title":"/hub-api/template/edit","summary":"Atualiza um template HTML existente","prefix":{"name":"put","color":"put"},"badges":[],"link":"/template/updatetemplatev1http","deprecated":false}]}]}]}]}},{"type":"group","label":"Sector","link":"/aprovahubapi/sector","routeSlug":"/aprovahubapi/sector","items":[{"label":"Lista os setores (organograma) de uma cidade","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/sector/listsectorsbycityv1http","routeSlug":"/aprovahubapi/sector/listsectorsbycityv1http","metadata":{"seo":{"title":"Lista os setores (organograma) de uma cidade","description":"Lista todos os setores de uma cidade — o organograma da prefeitura —, não apenasos setores de um usuário."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSectorsByCityV1Http","name":"Lista os setores (organograma) de uma cidade","isWebhook":false,"pointer":"/paths/~1hub-api~1sector~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lista os setores (organograma) de uma cidade","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"todos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" os setores de uma cidade — o organograma da prefeitura —, não apenas"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"os setores de um usuário."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifique a cidade por "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ou"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" por "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cidade"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Quando os dois vierem,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" vence. Chaves API do tipo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" leem sempre a própria cidade: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cidade"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" informados são ignorados."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dois identificadores saem por setor e "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"não são intercambiáveis"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — identificador estável do setor. É o valor que vai em"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"templateOptions.addressee.values[].value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" de um campo de destinatário"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next-destinatario"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — ObjectId do setor. É o que a tramitação ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.form_tramites"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") e o"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fluxograma guardam."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setor apagado (soft-delete) não aparece. Setor bloqueado aparece com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ele continua no organograma e ainda recebe processo antigo, mas"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"não deve ser escolhido como destinatário de um formulário novo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"q"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" para filtrar por nome, sigla ou tag — em cidade grande o organograma inteiro é"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pesado (a de implantação tem 614 setores). O filtro é substring, sem acento e sem caixa:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fiscalizacao"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" casa "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fiscalização de Obras"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total: 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" preenchido e "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sem"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filteredBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" significa "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"organograma ainda não"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"montado"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" naquela cidade — é resposta, não erro. Já "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total: 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"com"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filteredBy"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"significa que o seu filtro não casou, e a cidade tem "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityTotal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setores: são conclusões"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"opostas. Cidade inexistente devolve 400, e cidade duplicada no"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mesmo UF também: nesse caso a mensagem traz os índices candidatos, para você repetir"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a chamada com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Atenção à diferença para "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/hub-api/type/find"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/hub-api/process/find-by-np"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", que"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nessa mesma situação respondem "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ambiguous"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Lá a lista"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parcial ainda é útil e a escolha fica com você; aqui devolver o organograma de uma"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"das candidatas seria devolver o de "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outra prefeitura"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", sem nada na resposta"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"denunciar — por isso esta rota recusa e pede o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cityId","in":"query","schemaId":"schema_222","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Índice numérico da cidade (o mesmo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"city.index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" devolvido por "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/hub-api/type/find"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Vence "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cidade"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"cidade","in":"query","schemaId":"schema_223","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome da cidade. Exige "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Ignorado quando "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é informado."},"children":[]}]}]}]},{"name":"uf","in":"query","schemaId":"schema_224","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UF de 2 letras. Exige "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cidade"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_225","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtra por nome, sigla ou tag do setor (substring, case-insensitive e sem acento). Vazio ou só espaços = sem filtro."},"children":[]}]}]}]}],"pointer":"/paths/~1hub-api~1sector~1list/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hub-api/sector/list","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[{"name":"cityId","in":"query","required":false,"example":246,"schemaId":"schema_222"},{"name":"cidade","in":"query","required":false,"example":"Barueri","schemaId":"schema_223"},{"name":"uf","in":"query","required":false,"example":"SP","schemaId":"schema_224"},{"name":"q","in":"query","required":false,"example":"protocolo","schemaId":"schema_225"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/hub-api/sector/list","href":"sector/listsectorsbycityv1http","openApiOperationId":"listSectorsByCityV1Http","summary":"Lista os setores (organograma) de uma cidade"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Setores da cidade","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_226","exampleIds":["paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Organograma","paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Sem setor","paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Filtro sem resultado"]}},"schemaId":"schema_226","exampleIds":["paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Organograma","paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Sem setor","paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Filtro sem resultado"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cidade não informada, não encontrada ou ambígua"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_227","exampleIds":["paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Ambigua","paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Nao informada","paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Nao encontrada"]}},"schemaId":"schema_227","exampleIds":["paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Ambigua","paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Nao informada","paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Nao encontrada"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente, inativa ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}},"schemaId":"schema_142"},{"code":"500","description":"Erro interno","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143"}},"schemaId":"schema_143"}],"pointer":"/paths/~1hub-api~1sector~1list/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_226","exampleIds":["paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Organograma","paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Sem setor","paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Filtro sem resultado"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_226","exampleIds":["paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Organograma","paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Sem setor","paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Filtro sem resultado"]}}},{"code":"400","schemaId":"schema_227","exampleIds":["paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Ambigua","paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Nao informada","paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Nao encontrada"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_227","exampleIds":["paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Ambigua","paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Nao informada","paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Nao encontrada"]}}},{"code":"401","schemaId":"schema_142","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sector/listsectorsbycityv1http"}],"panels":[]}]},"httpPath":"/hub-api/sector/list"}],"content":{"contentType":"group","meta":{"name":"Sector"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sector","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operações relacionadas a setores (o organograma da prefeitura)"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hub-api/sector/list","summary":"Lista os setores (organograma) de uma cidade","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sector/listsectorsbycityv1http","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/aprovahubapi/users","routeSlug":"/aprovahubapi/users","items":[{"label":"Consulta informações de um usuário","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/users/getuserv1http","routeSlug":"/aprovahubapi/users/getuserv1http","metadata":{"seo":{"title":"Consulta informações de um usuário","description":"Consulta dados detalhados de um usuário a partir do identificador do Aut0."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUserV1Http","name":"Consulta informações de um usuário","isWebhook":false,"pointer":"/paths/~1hub-api~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consulta informações de um usuário","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consulta dados detalhados de um usuário a partir do identificador do Aut0."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"userId","in":"query","schemaId":"schema_228","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único do usuário (ID Aut0)."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hub-api~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hub-api/users","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[{"name":"userId","in":"query","required":true,"example":"auth0|1234567890abcdef12345678","schemaId":"schema_228"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/hub-api/users","href":"users/getuserv1http","openApiOperationId":"getUserV1Http","summary":"Consulta informações de um usuário"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usuário encontrado com sucesso"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}},"schemaId":"schema_229"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requisição inválida (parâmetros incorretos ou usuário inexistente)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_230"}},"schemaId":"schema_230"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}},"schemaId":"schema_142"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usuário não encontrado"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231"}},"schemaId":"schema_231"}],"pointer":"/paths/~1hub-api~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_229","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_229"}}},{"code":"400","schemaId":"schema_230","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_230"}}},{"code":"401","schemaId":"schema_142","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}}},{"code":"404","schemaId":"schema_231","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getuserv1http"}],"panels":[]}]},"httpPath":"/hub-api/users"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operações relacionadas à consulta de usuários"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hub-api/users","summary":"Consulta informações de um usuário","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getuserv1http","deprecated":false}]}]}]}]}},{"type":"group","label":"Rotas Removidas","link":"/aprovahubapi/rotas-removidas","routeSlug":"/aprovahubapi/rotas-removidas","items":[{"label":"Consulta um processo por np e codvalid","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/rotas-removidas/consultprocessv1http","routeSlug":"/aprovahubapi/rotas-removidas/consultprocessv1http","metadata":{"seo":{"title":"Consulta um processo por np e codvalid","description":"⚠️ Rota removida. Endpoint descontinuado — a rota core correspondente foi removida no sweep de código morto e este proxy retorna 400 para qualquer requisição. Mantido aqui apenas para referência histórica.Substituta: GET /hub-api/process/find-by-np (resolve o processo por nP + cidade + UF, sem exigir o codValid)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consultProcessV1Http","name":"Consulta um processo por np e codvalid","deprecated":true,"isWebhook":false,"pointer":"/paths/~1hub-api~1process~1get-by-np/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consulta um processo por np e codvalid","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rota removida."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Endpoint descontinuado — a rota core correspondente foi removida no sweep de código morto e este proxy retorna "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" para qualquer requisição. Mantido aqui apenas para referência histórica."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Substituta:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /hub-api/process/find-by-np"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (resolve o processo por nP + cidade + UF, sem exigir o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codValid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Este endpoint permitia consultar um processo específico utilizando o número do processo (nP) e o código validador (codValid)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_232"}},"schemaId":"schema_232","pointer":"/paths/~1hub-api~1process~1get-by-np/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hub-api/process/get-by-np","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_232"}},"responseCodes":["200","400","401","404"],"pointer":"/hub-api/process/get-by-np","href":"rotas-removidas/consultprocessv1http","openApiOperationId":"consultProcessV1Http","summary":"Consulta um processo por np e codvalid"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"schemaId":"schema_232","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_232"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Processo encontrado com sucesso","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_233"}},"schemaId":"schema_233"},{"code":"400","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_234"}},"schemaId":"schema_234"},{"code":"401","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134"}},"schemaId":"schema_134"},{"code":"404","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_235"}},"schemaId":"schema_235"}],"pointer":"/paths/~1hub-api~1process~1get-by-np/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_233","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_233"}}},{"code":"400","schemaId":"schema_234","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_234"}}},{"code":"401","schemaId":"schema_134","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134"}}},{"code":"404","schemaId":"schema_235","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_235"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rotas-removidas/consultprocessv1http"}],"panels":[]}]},"httpPath":"/hub-api/process/get-by-np"},{"label":"Cria um processo sem validação de regras de formulário","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/aprovahubapi/rotas-removidas/createprocessv1http","routeSlug":"/aprovahubapi/rotas-removidas/createprocessv1http","metadata":{"seo":{"title":"Cria um processo sem validação de regras de formulário","description":"⚠️ Rota removida. Endpoint descontinuado — a rota core correspondente foi removida no sweep de código morto e este proxy não está mais disponível. Mantido aqui apenas para referência histórica."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProcessV1Http","name":"Cria um processo sem validação de regras de formulário","deprecated":true,"isWebhook":false,"pointer":"/paths/~1hub-api~1process~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cria um processo sem validação de regras de formulário","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rota removida."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Endpoint descontinuado — a rota core correspondente foi removida no sweep de código morto e este proxy não está mais disponível. Mantido aqui apenas para referência histórica."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criava um processo sem validação de regras de formulário (salvava a version da forma que recebeu). Este endpoint permitia criar processos diretamente sem passar pelas validações padrão do sistema."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InternalAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Internal Authentication Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_236"}},"schemaId":"schema_236","pointer":"/paths/~1hub-api~1process~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hub-api/process/create","servers":[{"url":"https://api.producao.aprova.com.br"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InternalAuth","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_236"}},"responseCodes":["200","400","401","500"],"pointer":"/hub-api/process/create","href":"rotas-removidas/createprocessv1http","openApiOperationId":"createProcessV1Http","summary":"Cria um processo sem validação de regras de formulário"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.producao.aprova.com.br"}],"schemaId":"schema_236","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_236"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Processo criado com sucesso","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_237"}},"schemaId":"schema_237"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requisição inválida (campos obrigatórios ausentes ou dados inválidos)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_238"}},"schemaId":"schema_238"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha de autenticação (API Key ausente ou inválida)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134"}},"schemaId":"schema_134"},{"code":"500","description":"Erro interno do servidor","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_239"}},"schemaId":"schema_239"}],"pointer":"/paths/~1hub-api~1process~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_237","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_237"}}},{"code":"400","schemaId":"schema_238","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_238"}}},{"code":"401","schemaId":"schema_134","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134"}}},{"code":"500","schemaId":"schema_239","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_239"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rotas-removidas/createprocessv1http"}],"panels":[]}]},"httpPath":"/hub-api/process/create"}],"content":{"contentType":"group","meta":{"name":"Rotas Removidas"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rotas Removidas","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints descontinuados, mantidos apenas para referência histórica. As rotas core correspondentes foram removidas e estes proxies não estão mais disponíveis (retornam erro). "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Não integrar."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hub-api/process/get-by-np","summary":"Consulta um processo por np e codvalid","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/rotas-removidas/consultprocessv1http","deprecated":true},{"title":"/hub-api/process/create","summary":"Cria um processo sem validação de regras de formulário","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/rotas-removidas/createprocessv1http","deprecated":true}]}]}]}]}}],"store":{"schemaStore":{"schema_120":{"kind":"json-schema","data":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Minha chave de integração"}}},"id":"schema_120"},"schema_121":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","example":"abc123"},"secretKey":{"type":"string","example":"sk_live_xxx"},"organizationCode":{"type":"number","example":123},"createdAt":{"type":"string","example":"2025-10-27T09:00:00Z"},"description":{"type":"string","example":"Chave API principal"},"active":{"type":"boolean","example":true}}},"id":"schema_121"},"schema_122":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Invalid request"},"message":{"type":"string","example":"Campo obrigatório ausente"}}},"id":"schema_122"},"schema_123":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"},"example":["Não autorizado."]},"id":"schema_123"},"schema_124":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"key_123"},"maskedSecretKey":{"type":"string","example":"sk_live_****abcd"},"organizationCode":{"type":"number","example":123},"createdAt":{"type":"string","example":"2025-10-27T09:00:00Z"},"description":{"type":"string","example":"Chave de teste"},"active":{"type":"boolean","example":true},"createdByUser":{"type":"string","example":"admin@empresa.com"}}}},"id":"schema_124"},"schema_125":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Invalid request"},"message":{"type":"string","example":"Erro na requisição"}}},"id":"schema_125"},"schema_126":{"kind":"json-schema","data":{"type":"string","example":"key_123"},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"message":{"type":"string","example":"API Key revogada com sucesso"}}},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"ID inválido"}}},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-fA-F0-9]{24}$","example":"507f1f77bcf86cd799439011"},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"type":"string","enum":["process","form"],"example":"process"},"id":"schema_131"},"schema_132":{"kind":"json-schema","data":{"type":"object","additionalProperties":true,"description":"JSON cru do documento conforme armazenado no MongoDB","example":{"_id":"507f1f77bcf86cd799439011","city_id":123,"nP":"123-25-PRO-EXE"}},"id":"schema_132"},"schema_133":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"ObjectId inválido"}}},"id":"schema_133"},"schema_134":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Unauthorized"},"message":{"type":"string","example":"API Key is required"}},"example":{"error":"Unauthorized","message":"API Key is required"}},"id":"schema_134"},"schema_135":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Forbidden"},"message":{"type":"string","example":"Documento não pertence à organização da API Key"}},"example":{"error":"Forbidden","message":"Documento não pertence à organização da API Key"}},"id":"schema_135"},"schema_136":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"Documento não encontrado"}},"example":{"error":"Not Found","message":"Documento não encontrado"}},"id":"schema_136"},"schema_137":{"kind":"json-schema","data":{"type":"string","example":"664-24-FLN-HAB"},"id":"schema_137"},"schema_138":{"kind":"json-schema","data":{"type":"string","example":"Florianópolis"},"id":"schema_138"},"schema_139":{"kind":"json-schema","data":{"type":"string","example":"SC"},"id":"schema_139"},"schema_140":{"kind":"json-schema","data":{"type":"object","properties":{"city":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cidade resolvida, ou null quando não encontrada"},"children":[]}]}]}],"additionalProperties":true,"properties":{"index":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cityID numérico"},"children":[]}]}]}],"example":145},"cidade":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome canônico da cidade"},"children":[]}]}]}],"example":"Florianópolis"},"estado":{"type":"string","description":"UF da cidade","example":"SC"}}},"process":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processo encontrado, ou null quando o nP não existe na cidade. Use o id em GET /hub-api/document/json"},"children":[]}]}]}],"additionalProperties":true,"properties":{"id":{"type":"string","description":"ObjectId do processo","example":"6a574cfaf63564c7c29d1ea0"},"nP":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número do processo"},"children":[]}]}]}],"example":"664-24-FLN-HAB"},"codValid":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código verificador do processo"},"children":[]}]}]}],"example":"4wsuqzit"}}},"ambiguous":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Presente e true quando há mais de uma cidade candidata com match"},"children":[]}]}]}],"example":true},"candidates":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidatas quando ambiguous é true (a escolha fica a cargo do consumidor)"},"children":[]}]}]}],"items":{"type":"object","additionalProperties":true,"properties":{"index":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cityID numérico da candidata"},"children":[]}]}]}],"example":778},"cidade":{"type":"string","description":"Nome da cidade candidata","example":"Florianópolis"},"estado":{"type":"string","description":"UF da candidata","example":"SC"}}}}}},"id":"schema_140"},"schema_141":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"querystring must have required property 'nP'"}}},"id":"schema_141"},"schema_142":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Unauthorized"},"message":{"type":"string","example":"API Key is required"}}},"id":"schema_142"},"schema_143":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Internal Server Error"},"message":{"type":"string","example":"Erro interno do servidor"}}},"id":"schema_143"},"schema_144":{"kind":"json-schema","data":{"type":"string","example":"2026-07-01"},"id":"schema_144"},"schema_145":{"kind":"json-schema","data":{"type":"string","example":"2026-07-15"},"id":"schema_145"},"schema_146":{"kind":"json-schema","data":{"type":"string","enum":["created","updated","finished"],"default":"created","example":"updated"},"id":"schema_146"},"schema_147":{"kind":"json-schema","data":{"type":"string","example":"60df5787146b5035772c5bcd"},"id":"schema_147"},"schema_148":{"kind":"json-schema","data":{"type":"string","example":"timeline"},"id":"schema_148"},"schema_149":{"kind":"json-schema","data":{"type":"string","example":"6a574d64c801b5200269cea0"},"id":"schema_149"},"schema_150":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":50,"default":20,"example":50},"id":"schema_150"},"schema_151":{"kind":"json-schema","data":{"type":"integer","example":145},"id":"schema_151"},"schema_152":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processos da página, ordenados de forma estável para a paginação"},"children":[]}]}]}],"items":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ObjectId do processo — use em GET /hub-api/document/json para o JSON completo"},"children":[]}]}]}],"example":"6a574cfaf63564c7c29d1ea0"},"nP":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número do processo"},"children":[]}]}]}],"example":"664-26-FLN-HAB"},"codValid":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código verificador do processo"},"children":[]}]}]}],"example":"4wsuqzit"},"status":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Situação atual do processo"},"children":[]}]}]}],"example":"TRAMITE"},"typeId":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ObjectId do assunto (formulário) do processo"},"children":[]}]}]}],"example":"60df5787146b5035772c5bcd"},"typeTitle":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Título do assunto"},"children":[]}]}]}],"example":"Habite-se"},"createdAt":{"type":"string","nullable":true,"description":"Data de protocolo do processo","example":"2026-07-01T20:32:48.625Z"},"finishedAt":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de encerramento, ou null quando o processo não está encerrado"},"children":[]}]}]}],"example":"2026-07-15T09:05:59.566Z"},"finished":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica se o processo está encerrado"},"children":[]}]}]}],"example":true},"rejected":{"type":"boolean","description":"Indica se o processo foi indeferido","example":false},"lastVersion":{"type":"object","nullable":true,"additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Última versão do formulário. Só vem quando include contém lastVersion; caso contrário é null. Campos marcados como sigilosos vêm mascarados"},"children":[]}]}]}]},"timeline":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Movimentações do processo, limitadas às 100 mais recentes. Só vem quando include contém timeline; caso contrário é uma lista vazia. O histórico completo está em GET /hub-api/document/json"},"children":[]}]}]}],"items":{"type":"object","properties":{"date":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data da movimentação"},"children":[]}]}]}],"example":"2026-07-15T09:05:59.566Z"},"class":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tipo da movimentação"},"children":[]}]}]}],"example":"prefeituraEncaminha"},"action":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição da ação registrada"},"children":[]}]}]}],"example":"Processo encaminhado para Fiscalização"}}}}}}},"nextCursor":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor da próxima página, ou null quando não há mais páginas"},"children":[]}]}]}],"example":"6a574d64c801b5200269cea0"}}},"id":"schema_152"},"schema_153":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"A janela de datas não pode exceder 366 dias"}}},"id":"schema_153"},"schema_154":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Internal Server Error"},"message":{"type":"string","example":"Erro interno"}}},"id":"schema_154"},"schema_155":{"kind":"json-schema","data":{"type":"object","required":["form"],"properties":{"form":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Formulário Formly do despacho"},"children":[]}]}]}]},"name":{"type":"string","description":"Nome do despacho","example":"Despacho de Aprovação"},"cityId":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID do município. Obrigatório para API Keys do tipo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"support"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; ignorado para "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":42}}},"id":"schema_155"},"schema_156":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"cityId":{"type":"number","example":42},"form":{"type":"object","additionalProperties":true},"name":{"type":"string","example":"Despacho de Aprovação"},"disabled":{"type":"boolean","example":false},"allowedUserTypes":{"type":"array","items":{"type":"string","example":"Aprovador"}},"statusList":{"type":"array","items":{"type":"string","example":"Em análise"}},"deadlineFormat":{"type":"string","nullable":true,"example":"days"},"deadlineValue":{"type":"number","nullable":true,"example":5},"createdAt":{"type":"string","format":"date-time","example":"2026-01-15T10:30:00.000Z"},"deletedAt":{"type":"string","format":"date-time","nullable":true,"example":"2026-02-01T00:00:00.000Z"},"deleted":{"type":"boolean","example":false}}},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"O campo form é obrigatório"}}},"id":"schema_157"},"schema_158":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Internal Server Error"},"message":{"type":"string","example":"Erro inesperado ao criar o despacho"}}},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"id":"schema_159"},"schema_160":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"cityId":{"type":"number","example":42},"form":{"type":"object","additionalProperties":true},"name":{"type":"string","example":"Despacho de Aprovação"},"disabled":{"type":"boolean","example":false},"allowedUserTypes":{"type":"array","items":{"type":"string","example":"Aprovador"}},"statusList":{"type":"array","items":{"type":"object","additionalProperties":true}},"deadlineFormat":{"type":"string","nullable":true,"example":"days"},"deadlineValue":{"type":"string","nullable":true,"example":"5"},"createdAt":{"type":"string","format":"date-time","example":"2026-01-15T10:30:00.000Z"},"deletedAt":{"type":"string","format":"date-time","nullable":true,"example":null},"deleted":{"type":"boolean","example":false}}},"id":"schema_160"},"schema_161":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"UUID inválido"}}},"id":"schema_161"},"schema_162":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"Despacho não encontrado"}},"example":{"error":"Not Found","message":"Despacho não encontrado"}},"id":"schema_162"},"schema_163":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Internal Server Error"},"message":{"type":"string","example":"Erro inesperado ao buscar o despacho"}}},"id":"schema_163"},"schema_164":{"kind":"json-schema","data":{"type":"object","anyOf":[{"required":["name"]},{"required":["form"]}],"properties":{"name":{"type":"string","description":"Novo nome do despacho","example":"Despacho de Aprovação Revisado"},"form":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Novo formulário Formly do despacho"},"children":[]}]}]}]}}},"id":"schema_164"},"schema_165":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"Ao menos name ou form deve ser fornecido"}}},"id":"schema_165"},"schema_166":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Internal Server Error"},"message":{"type":"string","example":"Erro inesperado ao atualizar o despacho"}}},"id":"schema_166"},"schema_167":{"kind":"json-schema","data":{"type":"object","required":["ops"],"properties":{"ops":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operações JSON Patch, aplicadas em ordem e de forma atômica"},"children":[]}]}]}],"items":{"type":"object","required":["op","path"],"properties":{"op":{"type":"string","enum":["test","replace","add","remove"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = precondição (409 se não bater), não escreve nada. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exige que o path exista. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cria chave em objeto ou insere em array (aceita "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pra append). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" apaga"},"children":[]}]}]}],"example":"replace"},"path":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Pointer (RFC 6901) a partir da raiz do despacho. Precisa começar por "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ou "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Em tokens com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ou "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"~"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" no nome, escapar como "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"~1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"~0"},"children":[]}]}]}],"example":"/form/formData/0/fieldGroup/0/fieldGroup/3/templateOptions/label"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valor novo. Obrigatório em "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; ignorado em "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove"},"children":[]}]}]}]}}}}}},"id":"schema_167"},"schema_168":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"cityId":{"type":"number","example":138},"form":{"type":"object","additionalProperties":true},"name":{"type":"string","example":"Despacho de Aprovação"},"disabled":{"type":"boolean","example":false},"allowedUserTypes":{"type":"array","items":{"type":"string","example":"INTERNAL"}},"statusList":{"type":"array","items":{"type":"object","additionalProperties":true}},"deadlineFormat":{"type":"string","nullable":true,"example":"DAYS"},"deadlineValue":{"type":"string","nullable":true,"example":"5"},"createdAt":{"type":"string","example":"2024-03-15T14:22:10.000Z"},"deletedAt":{"type":"string","nullable":true,"example":"2024-04-01T10:00:00.000Z"},"deleted":{"type":"boolean","example":false}}},"id":"schema_168"},"schema_169":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Client Error"},"message":{"type":"string","example":"path /disabled não é editável: só /name e /form são permitidos"}}},"id":"schema_169"},"schema_170":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Conflict"},"message":{"type":"string","example":"test falhou em /form/formData/0/fieldGroup/0/fieldGroup/3/templateOptions/label"}}},"id":"schema_170"},"schema_171":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Internal Server Error"},"message":{"type":"string","example":"Erro inesperado ao aplicar o patch"}}},"id":"schema_171"},"schema_172":{"kind":"json-schema","data":{"type":"string","example":"69aae29b8f070e4432a63036"},"id":"schema_172"},"schema_173":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"properties":{"enable":{"type":"array","description":"Abas a habilitar, preservando as demais","items":{"type":"string","example":"TAXES"}},"disable":{"type":"array","description":"Abas a desabilitar, preservando as demais","items":{"type":"string","example":"ACCEPTANCE"}},"availableTabs":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conjunto exato de abas (REPLACE completo). Não combine com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disable"},"children":[]}]}]}],"items":{"type":"string","example":"START"}}}},"id":"schema_173"},"schema_174":{"kind":"json-schema","data":{"type":"object","properties":{"blueprintProcessId":{"type":"string","example":"8f2b1c44-9d3e-4a55-b0c1-2e7f9a6d5b41"},"legacyId":{"type":"string","example":"69aae29b8f070e4432a63036"},"availableTabs":{"type":"array","items":{"type":"string","example":"START"}},"changed":{"type":"object","properties":{"enabled":{"type":"array","items":{"type":"string","example":"TAXES"}},"disabled":{"type":"array","items":{"type":"string","example":"ACCEPTANCE"}}}}}},"id":"schema_174"},"schema_175":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Client Error"},"message":{"type":"string","example":"aba desconhecida: \"TAXAS\". Válidas: START, DISPATCH, FULL_DOCUMENT, ACCEPTANCE, RESUME, INTERNAL, TAXES, HISTORY, DOCUMENTS, TEMPLATES, STEPS"}}},"id":"schema_175"},"schema_176":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Forbidden"},"message":{"type":"string","example":"este blueprint process pertence a outra cidade — keys tenant só escrevem no próprio ambiente (138)"}}},"id":"schema_176"},"schema_177":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"Nenhum blueprint process com o id \"8f2b1c44-9d3e-4a55-b0c1-2e7f9a6d5b41\""}}},"id":"schema_177"},"schema_178":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Unprocessable Entity"},"message":{"type":"string","example":"isso deixaria o processo sem nenhuma aba — pra desligar o processo, desabilite o processo"}}},"id":"schema_178"},"schema_179":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Internal Server Error"},"message":{"type":"string","example":"Erro inesperado ao atualizar as abas"}}},"id":"schema_179"},"schema_180":{"kind":"json-schema","data":{"type":"boolean","default":true,"example":true},"id":"schema_180"},"schema_181":{"kind":"json-schema","data":{"type":"boolean","default":false,"example":false},"id":"schema_181"},"schema_182":{"kind":"json-schema","data":{"type":"object","properties":{"process":{"type":"object","properties":{"id":{"type":"string","description":"UUID do blueprint process","example":"8f2b1c44-9d3e-4a55-b0c1-2e7f9a6d5b41"},"legacyId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do assunto no Mongo"},"children":[]}]}]}],"example":"69aae29b8f070e4432a63036"},"title":{"type":"string","example":"Alvará de Construção"},"subject":{"type":"string","example":"Alvará de Construção"},"cityId":{"type":"number","example":138},"disabled":{"type":"boolean","example":false}}},"linkedBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Qual fiação respondeu — sempre "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blueprint_process.available_custom_posts"},"children":[]}]}]}],"example":"blueprint_process.available_custom_posts"},"total":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantidade em "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blueprintPosts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", já com "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onlyEnabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" aplicado"},"children":[]}]}]}],"example":2},"blueprintPosts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","example":"Despacho de Aprovação"},"disabled":{"type":"boolean","example":false},"deleted":{"type":"boolean","example":false},"allowedUserTypes":{"type":"array","items":{"type":"string","example":"INTERNAL"}},"deadlineFormat":{"type":"string","nullable":true,"example":"DAYS"},"deadlineValue":{"type":"string","nullable":true,"example":"5"},"statuses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"b1f0f5c2-6f5a-4c8e-9c9a-1d2e3f4a5b6c"},"name":{"type":"string","example":"Deferido"}}}}}}},"unresolved":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ids vinculados que não deram pra resolver — parametrização quebrada, não erro da chamada"},"children":[]}]}]}],"items":{"type":"object","properties":{"id":{"type":"string","example":"9c1e7a2b-3d4f-4a5b-8c6d-7e8f9a0b1c2d"},"reason":{"type":"string","enum":["not_found","other_city","error"],"example":"other_city"},"message":{"type":"string","example":"despacho pertence a outra cidade (city 42)"}}}}}},"id":"schema_182"},"schema_183":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Client Error"},"message":{"type":"string","example":"Query param desconhecido: includeDisabled. Aceitos: hydrate, onlyEnabled"}}},"id":"schema_183"},"schema_184":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Forbidden"},"message":{"type":"string","example":"este blueprint process pertence a outra cidade — keys tenant só leem o próprio ambiente (138)"}}},"id":"schema_184"},"schema_185":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"Nenhum blueprint process para o assunto \"69aae29b8f070e4432a63036\": ou o _id não existe, ou esse assunto não tem processo espelhado no core-api"}}},"id":"schema_185"},"schema_186":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Internal Server Error"},"message":{"type":"string","example":"Erro inesperado ao listar os despachos vinculados"}}},"id":"schema_186"},"schema_187":{"kind":"json-schema","data":{"type":"string","example":"Chapecó"},"id":"schema_187"},"schema_188":{"kind":"json-schema","data":{"type":"string","example":"Habite"},"id":"schema_188"},"schema_189":{"kind":"json-schema","data":{"type":"object","properties":{"city":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cidade resolvida, ou null quando não encontrada"},"children":[]}]}]}],"properties":{"index":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cityID numérico"},"children":[]}]}]}],"example":145},"cidade":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome canônico da cidade"},"children":[]}]}]}],"example":"Chapecó"},"estado":{"type":"string","description":"UF da cidade","example":"SC"}}},"total":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantidade de formulários retornados"},"children":[]}]}]}],"example":2},"forms":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Formulários da cidade (filtrados por titulo quando informado)"},"children":[]}]}]}],"items":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ObjectId do formulário (24 caracteres hexadecimais)"},"children":[]}]}]}],"example":"60df5787146b5035772c5bcd"},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Título do formulário"},"children":[]}]}]}],"example":"Habite-se"}}}},"ambiguous":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Presente e true quando há mais de uma cidade candidata com formulários"},"children":[]}]}]}],"example":true},"candidates":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidatas quando ambiguous é true (a escolha fica a cargo do consumidor)"},"children":[]}]}]}],"items":{"type":"object","properties":{"index":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cityID numérico da candidata"},"children":[]}]}]}],"example":778},"cidade":{"type":"string","description":"Nome da cidade candidata","example":"Chapecó"},"estado":{"type":"string","description":"UF da candidata","example":"SC"},"totalForms":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantidade de formulários da candidata"},"children":[]}]}]}],"example":165}}}}}},"id":"schema_189"},"schema_190":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"cidade e uf são obrigatórios"}}},"id":"schema_190"},"schema_191":{"kind":"json-schema","data":{"type":"object","required":["modelo","cidade"],"properties":{"modelo":{"type":"number","description":"Modelo do assunto","example":0},"cidade":{"type":"string","pattern":"^[a-zA-Z]","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Slug da cidade (ex. saopaulosp). Deve começar com letra"},"children":[]}]}]}],"example":"saopaulosp"},"cityId":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID numérico da cidade. Obrigatório para keys support; ignorado para tenant (extraído automaticamente da API Key)."},"children":[]}]}]}],"example":138},"config":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Config do assunto. Faz MERGE sobre o template do modelo — mande só o que quer definir. O "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cidade"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" daqui é ignorado"},"children":[]}]}]}]},"form":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Formulário (área externa) completo. Substitui o stepper vazio do template"},"children":[]}]}]}],"items":{"type":"object","additionalProperties":true}},"step":{"type":"object","additionalProperties":true,"description":"Fluxo de etapas do assunto"}}},"id":"schema_191"},"schema_192":{"kind":"json-schema","data":{"type":"object","additionalProperties":true,"properties":{"_id":{"type":"string","example":"69aae29b8f070e4432a63036"},"config":{"type":"object","additionalProperties":true},"form":{"type":"array","items":{"type":"object","additionalProperties":true}},"step":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fluxo de etapas do assunto, como ficou após a criação"},"children":[]}]}]}]},"createdAt":{"type":"string","example":"2026-01-15T10:30:00.000Z"}}},"id":"schema_192"},"schema_193":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"modelo is required"}}},"id":"schema_193"},"schema_194":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Upstream Error"},"message":{"type":"string","example":"types service respondeu 500: Cannot read properties of undefined"}}},"id":"schema_194"},"schema_195":{"kind":"json-schema","data":{"type":"string"},"id":"schema_195"},"schema_196":{"kind":"json-schema","data":{"type":"object","properties":{"config":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configurações do assunto a serem atualizadas"},"children":[]}]}]}],"additionalProperties":true},"form":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Definição dos campos do formulário a ser atualizada (REPLACE completo)"},"children":[]}]}]}],"items":{"type":"object","additionalProperties":true}},"step":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuração de etapas do assunto. Atualizada por dot-notation — as subchaves não enviadas são preservadas"},"children":[]}]}]}],"additionalProperties":true},"form_tramites":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Formulário da área interna / aba de trâmite (REPLACE completo). Normalizado para config.form_tramites. Não envie junto com config.form_tramites no mesmo request"},"children":[]}]}]}],"items":{"type":"object","additionalProperties":true}},"from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador opcional do caller, salvo como user no historico_types. Default: hub-api"},"children":[]}]}]}],"example":"davi-bot:ticket-259147"}}},"id":"schema_196"},"schema_197":{"kind":"json-schema","data":{"type":"object","properties":{"_id":{"type":"string","example":"69aae29b8f070e4432a63036"},"config":{"type":"object","additionalProperties":true},"form":{"type":"array","items":{"type":"object","additionalProperties":true}},"step":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuração de etapas do assunto, quando existir"},"children":[]}]}]}],"additionalProperties":true}}},"id":"schema_197"},"schema_198":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"Nenhum campo válido para atualizar. Campos permitidos: config, form, step, form_tramites"}}},"id":"schema_198"},"schema_199":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-fA-F0-9]{24}$","example":"69aae29b8f070e4432a63036"},"id":"schema_199"},"schema_200":{"kind":"json-schema","data":{"type":"object","required":["ops","from"],"properties":{"ops":{"type":"array","minItems":1,"maxItems":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operações JSON Patch, aplicadas em ordem e de forma atômica (tudo ou nada)"},"children":[]}]}]}],"items":{"type":"object","required":["op","path"],"properties":{"op":{"type":"string","enum":["test","replace","add","remove"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = precondição (409 se não bater), não escreve nada. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exige que o path exista. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cria a chave, ou insere no array (use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" no fim do path para append). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" apaga"},"children":[]}]}]}],"example":"replace"},"path":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Pointer (RFC 6901). Precisa começar por "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ou "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/step"},"children":[]}]}]}],"example":"/form/0/fieldGroup/5/templateOptions/label"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valor da operação. Obrigatório em "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; ignorado em "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove"},"children":[]}]}]}]}}}},"from":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autor + ticket + resumo, gravado no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"historico_types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Formato: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"<agente>:movidesk-<ticketId>: <resumo curto>\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obrigatório"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — sem ele o histórico ficaria anônimo"},"children":[]}]}]}],"example":"ticket-solver:movidesk-259147: renomeia label da área construída"}}},"id":"schema_200"},"schema_201":{"kind":"json-schema","data":{"type":"object","additionalProperties":true,"properties":{"_id":{"type":"string","example":"69aae29b8f070e4432a63036"},"config":{"type":"object","additionalProperties":true},"form":{"type":"array","items":{"type":"object","additionalProperties":true}},"step":{"type":"object","additionalProperties":true}}},"id":"schema_201"},"schema_202":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Client Error"},"message":{"type":"string","example":"ops[0].path \"/titulo\" não é editável — só \"/config...\", \"/form...\" e \"/step...\" são persistidos pelo types service"}}},"id":"schema_202"},"schema_203":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Client Error"},"message":{"type":"string","example":"Assunto 69aae29b8f070e4432a63036 não encontrado. Nada foi escrito"}}},"id":"schema_203"},"schema_204":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Conflict"},"message":{"type":"string","example":"test falhou em /form/0/fieldGroup/5/templateOptions/label"}}},"id":"schema_204"},"schema_205":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Client Error"},"message":{"type":"string","example":"o patch deixaria `form` como object, fora da forma que o assunto exige (array). Nada foi escrito"}}},"id":"schema_205"},"schema_206":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Upstream Error"},"message":{"type":"string","example":"Erro inesperado ao aplicar o patch"}}},"id":"schema_206"},"schema_207":{"kind":"json-schema","data":{"type":"object","required":["typeId"],"properties":{"typeId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ObjectId (hex de 24 caracteres) do assunto que será duplicado"},"children":[]}]}]}],"example":"60df5787146b5035772c5bcd"},"cityId":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opcional. city.index da cidade destino, obtido em GET /hub-api/type/find. Ausente = duplica no mesmo ambiente do assunto. Só keys support podem informar uma cidade diferente da própria"},"children":[]}]}]}],"example":145},"titulo":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opcional. Título do assunto novo. Default = título original seguido de \"copia as\" e a data/hora BRT da duplicação"},"children":[]}]}]}],"example":"Habite-se (cópia)"},"from":{"type":"string","maxLength":120,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opcional. Identificador do caller, salvo como user no historico_types do assunto novo. Default: hub-api"},"children":[]}]}]}],"example":"davi-bot:ticket-259147"}}},"id":"schema_207"},"schema_208":{"kind":"json-schema","data":{"type":"object","properties":{"_id":{"type":"string","description":"ObjectId do assunto criado","example":"6a5c19b18f070e4432a63099"},"config":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuração do assunto novo"},"children":[]}]}]}],"additionalProperties":true},"form":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Definição dos campos do assunto novo"},"children":[]}]}]}],"items":{"type":"object","additionalProperties":true}}}},"id":"schema_208"},"schema_209":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"body must have required property 'typeId'"}}},"id":"schema_209"},"schema_210":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Forbidden"},"message":{"type":"string","example":"Keys tenant só podem duplicar para o próprio ambiente"}}},"id":"schema_210"},"schema_211":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Client Error"},"message":{"type":"string","example":"Cidade destino não encontrada"}}},"id":"schema_211"},"schema_212":{"kind":"json-schema","data":{"type":"string","example":"MogidascruzesSP/Alvara_Aprovacao_Execucao_Projetos.html"},"id":"schema_212"},"schema_213":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","description":"Nome do arquivo de template","example":"MogidascruzesSP/Alvara_Aprovacao_Execucao_Projetos.html"},"html":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conteúdo HTML completo da versão do template (nunca vazio)"},"children":[]}]}]}],"example":"<!DOCTYPE html><html><head><title>Alvará de Aprovação</title></head><body>...</body></html>"},"created_at_iso":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de criação da versão retornada (ISO 8601)"},"children":[]}]}]}],"example":"2025-08-15T14:30:00.000Z"},"from":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autor ou origem da versão retornada"},"children":[]}]}]}],"example":"admin@cidade.gov.br"}}},"id":"schema_213"},"schema_214":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"name is required"}}},"id":"schema_214"},"schema_215":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"Template 'NomeCidade/template.html' não encontrado"}}},"id":"schema_215"},"schema_216":{"kind":"json-schema","data":{"type":"object","required":["name","html"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome do template no formato "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{Cidade}/{NomeArquivo}.html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"MogidascruzesSP/Alvara.html"},"html":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conteúdo HTML do template."},"children":[]}]}]}],"example":"<!DOCTYPE html><html><head><title>Alvará</title></head><body>...</body></html>"},"from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador do caller/origem gravado no histórico de versões do template. Default: hub-api"},"children":[]}]}]}],"example":"ticket-solver:movidesk-259147: template novo"}}},"id":"schema_216"},"schema_217":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","description":"Nome do arquivo de template","example":"MogidascruzesSP/Alvara.html"},"html":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conteúdo HTML do template"},"children":[]}]}]}],"example":"<!DOCTYPE html><html><head><title>Alvará</title></head><body>...</body></html>"},"created_at_iso":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de criação da versão (ISO 8601)"},"children":[]}]}]}],"example":"2026-01-15T10:30:00.000Z"},"from":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autor ou origem da versão criada"},"children":[]}]}]}],"example":"admin@cidade.gov.br"}}},"id":"schema_217"},"schema_218":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"body must have required property 'name'"}}},"id":"schema_218"},"schema_219":{"kind":"json-schema","data":{"type":"object","required":["name","html"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome do template no formato "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{Cidade}/{NomeArquivo}.html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"MogidascruzesSP/Alvara.html"},"html":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Novo conteúdo HTML do template."},"children":[]}]}]}],"example":"<!DOCTYPE html><html><head><title>Alvará v2</title></head><body>...</body></html>"},"from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador do caller/origem gravado no histórico de versões do template. Default: hub-api"},"children":[]}]}]}],"example":"ticket-solver:movidesk-259147: ajuste no cabeçalho"}}},"id":"schema_219"},"schema_220":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","description":"Nome do arquivo de template","example":"MogidascruzesSP/Alvara.html"},"html":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conteúdo HTML atualizado"},"children":[]}]}]}],"example":"<!DOCTYPE html><html><head><title>Alvará v2</title></head><body>...</body></html>"},"created_at_iso":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de criação da versão (ISO 8601)"},"children":[]}]}]}],"example":"2026-01-15T10:30:00.000Z"},"from":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autor ou origem da versão atualizada"},"children":[]}]}]}],"example":"admin@cidade.gov.br"}}},"id":"schema_220"},"schema_221":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"Template 'MogidascruzesSP/Alvara.html' não encontrado"}}},"id":"schema_221"},"schema_222":{"kind":"json-schema","data":{"type":"integer","example":246},"id":"schema_222"},"schema_223":{"kind":"json-schema","data":{"type":"string","example":"Barueri"},"id":"schema_223"},"schema_224":{"kind":"json-schema","data":{"type":"string","example":"SP"},"id":"schema_224"},"schema_225":{"kind":"json-schema","data":{"type":"string","example":"protocolo"},"id":"schema_225"},"schema_226":{"kind":"json-schema","data":{"type":"object","properties":{"city":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cidade consultada. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cidade"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estado"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" só vêm quando a cidade foi resolvida por nome."},"children":[]}]}]}],"properties":{"index":{"type":"integer","example":246},"cidade":{"type":"string","example":"Barueri"},"estado":{"type":"string","example":"SP"}}},"total":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantidade de setores retornados (sem os apagados e já filtrados por "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"q"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", quando houver)"},"children":[]}]}]}],"example":54},"cityTotal":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Só quando há "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"q"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — quantos setores a cidade tem no total. É o que distingue \"o filtro não casou\" de \"a cidade não tem organograma\""},"children":[]}]}]}],"example":614},"filteredBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Só quando há "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"q"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — o termo aplicado, ecoado"},"children":[]}]}]}],"example":"protocolo"},"sectors":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ObjectId do setor — é o que "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.form_tramites"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e o fluxograma guardam"},"children":[]}]}]}],"example":"69d9303d8b027102629d405a"},"tag":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador estável — é o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressee.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" de um campo de destinatário"},"children":[]}]}]}],"example":"protocologeral_baruerisp"},"name":{"type":"string","nullable":true,"example":"Protocolo Geral"},"acronym":{"type":"string","nullable":true,"example":"PG"},"parentId":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do setor pai; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" na raiz do organograma"},"children":[]}]}]}],"example":"69d9303d8b027102629d4059"},"level":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profundidade na árvore — 0 na raiz"},"children":[]}]}]}],"example":1},"blocked":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setor bloqueado — está no organograma, mas não deve receber processo novo"},"children":[]}]}]}],"example":false}}}}}},"id":"schema_226"},"schema_227":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"Mais de uma cidade chamada Chapecó/SC. Repita informando cityId (candidatos: 145, 778)"}}},"id":"schema_227"},"schema_228":{"kind":"json-schema","data":{"type":"string","example":"auth0|1234567890abcdef12345678"},"id":"schema_228"},"schema_229":{"kind":"json-schema","data":{"type":"object","properties":{"person":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações pessoais do usuário"},"children":[]}]}]}],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador do usuário"},"children":[]}]}]}],"example":"auth0|1234567890abcdef12345678"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tipo da conta do usuário"},"children":[]}]}]}],"example":"personal"},"document":{"type":"string","description":"Documento (CPF)","example":"12345678900"},"email":{"type":"string","format":"email","description":"E-mail principal","example":"usuario.parceiro@exemplo.com"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome completo do usuário"},"children":[]}]}]}],"example":"Maria Oliveira"},"phone":{"type":"string","description":"Telefone de contato","example":"11999998888"},"address":{"oneOf":[{"type":"string","example":"Rua das Flores, 100 - São Paulo/SP"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endereço estruturado quando disponível"},"children":[]}]}]}],"properties":{"cep":{"type":"string","example":"01001000"},"street":{"type":"string","example":"Praça da Sé"},"number":{"type":"string","example":"100"},"complement":{"type":"string","example":"Conjunto 12"},"neighborhood":{"type":"string","example":"Sé"},"city":{"type":"string","example":"São Paulo"},"state":{"type":"string","example":"SP"}}}]}}},"user":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações adicionais do usuário no Aprova"},"children":[]}]}]}],"properties":{"role":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cargo ou função do usuário"},"children":[]}]}]}],"example":"Analista"},"linked_sectors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setores vinculados ao usuário"},"children":[]}]}]}],"items":{"type":"object","properties":{"id":{"type":"string","example":"507f1f77bcf86cd799439011"},"name":{"type":"string","example":"Setor de Licenciamento"}}}},"assigned_permissions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permissões atribuídas ao usuário"},"children":[]}]}]}],"items":{"type":"object","properties":{"id":{"type":"string","example":"process:view"},"name":{"type":"string","example":"process:view"}}}},"account_status":{"type":"string","description":"Status atual da conta","example":"active"},"account_situation":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Situação da conta quando disponível"},"children":[]}]}]}],"properties":{"id":{"type":"string","example":"situation-01"},"name":{"type":"string","example":"Conta regular"}}},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de criação do usuário"},"children":[]}]}]}],"example":"2025-06-01T12:00:00.000Z"},"last_login":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data do último login"},"children":[]}]}]}],"example":"2025-11-05T19:52:42.883Z"},"last_registration_update":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data da última atualização cadastral"},"children":[]}]}]}],"example":"2025-10-20T08:15:30.000Z"},"redirect_to":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID da conta acolhedora quando aplicável"},"children":[]}]}]}],"example":null}}}}},"id":"schema_229"},"schema_230":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"Este usuário pertence a outra organização"}}},"id":"schema_230"},"schema_231":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"User not found"}}},"id":"schema_231"},"schema_232":{"kind":"json-schema","data":{"type":"object","required":["nP","codValid"],"properties":{"nP":{"type":"string","example":"337-25-pro-alv","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número do processo"},"children":[]}]}]}]},"codValid":{"type":"string","example":"ckusqxyx","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código validador"},"children":[]}]}]}]}}},"id":"schema_232"},"schema_233":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único do processo"},"children":[]}]}]}],"example":"507f1f77bcf86cd799439011"},"nP":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número do processo"},"children":[]}]}]}],"example":"123-25-PRO-EXE"},"cod_valid":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código validador do processo"},"children":[]}]}]}],"example":"abc12xyz"},"from":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações do criador do processo"},"children":[]}]}]}],"properties":{"userID":{"type":"string","example":"auth0|123456789abcdef012345678"}}},"configMetadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadados da configuração do processo"},"children":[]}]}]}],"properties":{"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Título da configuração"},"children":[]}]}]}],"example":"Alvará de Construção"},"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID da configuração"},"children":[]}]}]}],"example":"507f191e810c19729de860ea"}}},"lastVersion":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Última versão do processo com todos os dados e campos preenchidos"},"children":[]}]}]}],"properties":{"from":{"type":"object","properties":{"type":{"type":"string","example":"user"},"label":{"type":"string","example":"João da Silva Santos"},"value":{"type":"string","example":"auth0|123456789abcdef012345678"},"accessLevel":{"type":"string","example":"FULL"}}},"proprietario":{"type":"array","items":{"type":"object"},"example":[]},"destinatario":{"type":"array","items":{"type":"object","properties":{"sector_type":{"type":"string","example":"sector"},"value":{"type":"string","example":"setor_urbanismo"},"label":{"type":"string","example":"Setor de Urbanismo"},"id":{"type":"string","example":"507f191e810c19729de860ea"}}},"example":[{"sector_type":"sector","value":"setor_urbanismo","label":"Setor de Urbanismo","id":"507f191e810c19729de860ea"}]},"refinamento":{"type":"object","additionalProperties":true,"example":{"area_construcao":150.5}},"cpf_cnpj":{"type":"string","example":"123.456.789-00"},"created_at_iso":{"type":"string","format":"date-time","example":"2025-10-15T14:30:00.000Z"},"created_at":{"type":"string","example":"15/10/2025 11:30:00"},"hasSensitiveField":{"type":"boolean","example":true}},"additionalProperties":true},"createdAt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de criação do processo"},"children":[]}]}]}],"example":"15/10/2025 09:30:00"},"timeline":{"type":"array","description":"Linha do tempo com todos os eventos do processo","items":{"type":"object","properties":{"from":{"type":"object","properties":{"userId":{"type":"string","example":"auth0|123456789abcdef012345678"},"name":{"type":"string","example":"João da Silva Santos"},"asSector":{"type":"string","nullable":true,"example":null}}},"class":{"type":"string","description":"Classe do evento (user, prefeituraEncaminha, message, despacho, analise, deadline)","example":"user"},"type":{"type":"string","description":"Tipo do evento","example":"evento"},"data":{"type":"object","properties":{"action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição da ação executada"},"children":[]}]}]}],"example":"Processo criado"}}},"date":{"type":"string","example":"15/10/2025 09:30:00"},"created_at_iso":{"type":"string","format":"date-time","example":"2025-10-15T12:30:00.000Z"}},"additionalProperties":true},"example":[{"from":{"userId":"auth0|123456789abcdef012345678","name":"João da Silva Santos","asSector":null},"class":"user","type":"evento","data":{"action":"Processo criado"},"date":"15/10/2025 09:30:00","created_at_iso":"2025-10-15T12:30:00.000Z"},{"from":{"userId":"Desconhecido","name":"Desconhecido/Evento Automático"},"to":{"name":"Setor de Urbanismo","userId":"setor_urbanismo"},"class":"prefeituraEncaminha","type":"evento","data":{"action":"Processo encaminhado com acesso total para Setor de Urbanismo"},"date":"15/10/2025 09:30:15","created_at_iso":"2025-10-15T12:30:15.000Z"},{"class":"message","type":"evento","data":{"action":"Documento de Aprovação emitido"},"from":{"userId":"auth0|987654321fedcba987654321","name":"Maria Oliveira Costa"},"date":"16/10/2025 14:20:00","created_at_iso":"2025-10-16T17:20:00.000Z"}]}}},"id":"schema_233"},"schema_234":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Invalid NP"},"message":{"type":"string","example":"Número de processo inválido"}}},"id":"schema_234"},"schema_235":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Process not found"},"message":{"type":"string","example":"Processo não encontrado"}},"example":{"error":"Process not found","message":"Processo não encontrado"}},"id":"schema_235"},"schema_236":{"kind":"json-schema","data":{"type":"object","required":["version","city_id","config_metadata","config"],"properties":{"version":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dados da versão do processo (será salvo exatamente como recebido)"},"children":[]}]}]}],"additionalProperties":true,"example":{"from":{"type":"user","label":"João da Silva","value":"auth0|123456789abcdef012345678"},"proprietario":[],"destinatario":[],"refinamento":{}}},"city_id":{"type":"number","description":"ID da cidade","example":123},"config_metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadados de configuração do processo"},"children":[]}]}]}],"additionalProperties":true,"example":{"id":"507f191e810c19729de860ea","title":"Alvará de Construção"}},"config":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuração do formulário"},"children":[]}]}]}],"items":{"type":"object","additionalProperties":true},"example":[]},"step":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuração de etapas (opcional)"},"children":[]}]}]}],"additionalProperties":true},"destination":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuração de destino (opcional)"},"children":[]}]}]}],"additionalProperties":true},"bond":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuração de vínculo (opcional)"},"children":[]}]}]}],"additionalProperties":true},"tenance":{"type":"string","description":"Valor de tenance (opcional)","example":""},"_id":{"type":"string","description":"ID do rascunho (opcional)","example":"507f1f77bcf86cd799439012"},"resetCountEveryYear":{"type":"boolean","description":"Flag para resetar contagem a cada ano (opcional)","example":false},"from":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações do usuário remetente (opcional)"},"children":[]}]}]}],"properties":{"email":{"type":"string","example":"usuario@exemplo.com"},"userID":{"type":"string","example":"auth0|123456789abcdef012345678"},"alias":{"type":"object","additionalProperties":true}}},"form_tramites":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuração de formulários de trâmites (opcional)"},"children":[]}]}]}],"items":{"type":"object","additionalProperties":true}},"s3_token":{"type":"string","description":"Token S3 para upload de arquivos (opcional)","example":""},"status":{"type":"string","description":"Status do processo","example":""},"analises":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Análises do processo (opcional)"},"children":[]}]}]}],"items":{"type":"object","additionalProperties":true}},"anotacoesAnalista":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Anotações do analista (opcional)"},"children":[]}]}]}],"items":{"type":"object","additionalProperties":true}},"observacoes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Observações do processo (opcional)"},"children":[]}]}]}],"items":{"type":"object","additionalProperties":true}},"tramites":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trâmites do processo (opcional)"},"children":[]}]}]}],"items":{"type":"object","additionalProperties":true}},"notes":{"type":"array","description":"Notas do processo (opcional)","items":{"type":"object","additionalProperties":true}},"tags":{"type":"array","description":"Tags do processo (opcional)","items":{"type":"object","additionalProperties":true}}}},"id":"schema_236"},"schema_237":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único do processo criado"},"children":[]}]}]}],"example":"507f1f77bcf86cd799439011"},"nP":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número do processo gerado"},"children":[]}]}]}],"example":"123-25-PRO-EXE"},"cod_valid":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código validador do processo"},"children":[]}]}]}],"example":"abc12xyz"},"from":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações do criador do processo"},"children":[]}]}]}],"properties":{"userID":{"type":"string","example":"auth0|123456789abcdef012345678"},"email":{"type":"string","example":"usuario@exemplo.com"}}},"config_metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadados da configuração do processo"},"children":[]}]}]}],"properties":{"id":{"type":"string","example":"507f191e810c19729de860ea"},"title":{"type":"string","example":"Alvará de Construção"}}},"last_version":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Última versão do processo criado"},"children":[]}]}]}],"additionalProperties":true},"created_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de criação do processo"},"children":[]}]}]}],"example":"15/10/2025 09:30:00"},"city_id":{"type":"number","description":"ID da cidade do processo","example":123}}},"id":"schema_237"},"schema_238":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"version, city_id, config_metadata and config are required"}}},"id":"schema_238"},"schema_239":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Internal Server Error"},"message":{"type":"string","example":"Failed to create process"}}},"id":"schema_239"}},"exampleStore":{"paths/~1hub-api~1api-keys~1revoke/delete/responses/401/content/application~1json/example":{"value":["Não autorizado."],"id":"paths/~1hub-api~1api-keys~1revoke/delete/responses/401/content/application~1json/example"},"paths/~1hub-api~1process~1find-by-np/get/responses/200/content/application~1json/examples/Encontrado":{"value":{"city":{"index":145,"cidade":"Florianópolis","estado":"SC"},"process":{"id":"6a574cfaf63564c7c29d1ea0","nP":"664-24-FLN-HAB","codValid":"4wsuqzit"}},"key":"Encontrado","summary":"Processo resolvido","id":"paths/~1hub-api~1process~1find-by-np/get/responses/200/content/application~1json/examples/Encontrado"},"paths/~1hub-api~1process~1find-by-np/get/responses/200/content/application~1json/examples/Nao encontrado":{"value":{"city":{"index":145,"cidade":"Florianópolis","estado":"SC"},"process":null},"key":"Nao encontrado","summary":"Número do processo inexistente na cidade","id":"paths/~1hub-api~1process~1find-by-np/get/responses/200/content/application~1json/examples/Nao encontrado"},"paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Pagina com proxima":{"value":{"items":[{"id":"6a574cfaf63564c7c29d1ea0","nP":"664-26-FLN-HAB","codValid":"4wsuqzit","status":"REQUERENTE","typeId":"60df5787146b5035772c5bcd","typeTitle":"Habite-se","createdAt":"2026-07-15T09:03:54.879Z","finishedAt":null,"finished":false,"rejected":false,"lastVersion":null,"timeline":[]},{"id":"6a574d6ec801b5200269cecc","nP":"665-26-FLN-HAB","codValid":"3tz1bleh","status":"TRAMITE","typeId":"60df5787146b5035772c5bcd","typeTitle":"Habite-se","createdAt":"2026-07-15T09:05:50.464Z","finishedAt":"2026-07-15T09:05:59.566Z","finished":true,"rejected":false,"lastVersion":null,"timeline":[]}],"nextCursor":"6a574d6ec801b5200269cecc"},"key":"Pagina com proxima","summary":"Página com continuação","id":"paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Pagina com proxima"},"paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Ultima pagina":{"value":{"items":[{"id":"6a574d64c801b5200269cea0","nP":"666-26-FLN-HAB","codValid":"x7dyfh5j","status":"PREFEITURA","typeId":"60df5787146b5035772c5bcd","typeTitle":"Habite-se","createdAt":"2026-07-15T09:05:40.780Z","finishedAt":null,"finished":false,"rejected":false,"lastVersion":null,"timeline":[]}],"nextCursor":null},"key":"Ultima pagina","summary":"Fim da varredura","id":"paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Ultima pagina"},"paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Sem resultados":{"value":{"items":[],"nextCursor":null},"key":"Sem resultados","summary":"Período sem processos","id":"paths/~1hub-api~1process~1list/get/responses/200/content/application~1json/examples/Sem resultados"},"paths/~1hub-api~1process~1list/get/responses/400/content/application~1json/examples/Janela longa":{"value":{"error":"Bad Request","message":"A janela de datas não pode exceder 366 dias"},"key":"Janela longa","summary":"Janela acima do limite","id":"paths/~1hub-api~1process~1list/get/responses/400/content/application~1json/examples/Janela longa"},"paths/~1hub-api~1process~1list/get/responses/400/content/application~1json/examples/Include invalido":{"value":{"error":"Bad Request","message":"include inválido: foo. Valores aceitos: timeline, lastVersion"},"key":"Include invalido","summary":"Bloco desconhecido em include","id":"paths/~1hub-api~1process~1list/get/responses/400/content/application~1json/examples/Include invalido"},"paths/~1hub-api~1blueprint-post/post/requestBody/content/application~1json/example":{"value":{"name":"Despacho de Aprovação","form":{"formData":[{"fieldGroup":[{"fieldGroup":[{"type":"next-ck","key":"justificativa","templateOptions":{"label":"Justificativa","required":true,"hideLabel":false,"columns":"12","hiddenTemp":false,"readonly":false,"sensitiveField":false},"className":"col-12"},{"type":"next-input","key":"numero_processo","templateOptions":{"label":"Número do Processo","required":true,"hideLabel":false,"columns":"12","hiddenTemp":false,"readonly":false,"sensitiveField":false},"className":"col-12"},{"type":"next-upload","key":"anexos","templateOptions":{"label":"Anexos","required":false,"hideLabel":false,"columns":"12","extends":["PDF","PNG","JPG","JPEG"],"compactView":false,"hiddenTemp":false,"readonly":false,"sensitiveField":false},"className":"col-12"},{"type":"radio","key":"aprovado","templateOptions":{"label":"Aprovado?","required":true,"hideLabel":false,"columns":"12","hiddenTemp":false,"readonly":false,"sensitiveField":false,"options":[{"label":"Sim","value":"true"},{"label":"Não","value":"false"}]},"className":"col-12"}],"wrappers":["card-post"],"expressionProperties":{}}]}]}},"id":"paths/~1hub-api~1blueprint-post/post/requestBody/content/application~1json/example"},"paths/~1hub-api~1blueprint-post/post/responses/201/content/application~1json/example":{"value":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","cityId":42,"name":"Despacho de Aprovação","form":{"formData":[{"fieldGroup":[{"fieldGroup":[{"type":"next-ck","key":"justificativa","templateOptions":{"label":"Justificativa","required":true,"hideLabel":false,"columns":"12","hiddenTemp":false,"readonly":false,"sensitiveField":false},"className":"col-12"},{"type":"next-input","key":"numero_processo","templateOptions":{"label":"Número do Processo","required":true,"hideLabel":false,"columns":"12","hiddenTemp":false,"readonly":false,"sensitiveField":false},"className":"col-12"},{"type":"next-upload","key":"anexos","templateOptions":{"label":"Anexos","required":false,"hideLabel":false,"columns":"12","extends":["PDF","PNG","JPG","JPEG"],"compactView":false,"hiddenTemp":false,"readonly":false,"sensitiveField":false},"className":"col-12"},{"type":"radio","key":"aprovado","templateOptions":{"label":"Aprovado?","required":true,"hideLabel":false,"columns":"12","hiddenTemp":false,"readonly":false,"sensitiveField":false,"options":[{"label":"Sim","value":"true"},{"label":"Não","value":"false"}]},"className":"col-12"}],"wrappers":["card-post"],"expressionProperties":{}}]}]},"disabled":false,"allowedUserTypes":[],"statusList":[],"deadlineFormat":null,"deadlineValue":null,"createdAt":"2024-03-15T14:22:10.000Z","deletedAt":null,"deleted":false},"id":"paths/~1hub-api~1blueprint-post/post/responses/201/content/application~1json/example"},"paths/~1hub-api~1blueprint-post~1{id}/get/responses/200/content/application~1json/example":{"value":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","cityId":42,"name":"Despacho de Aprovação","form":{"formData":[{"fieldGroup":[{"fieldGroup":[{"type":"next-ck","key":"justificativa","templateOptions":{"label":"Justificativa","required":true},"className":"col-12"}],"wrappers":["card-post"],"expressionProperties":{}}]}]},"disabled":false,"allowedUserTypes":[],"statusList":[],"deadlineFormat":null,"deadlineValue":null,"createdAt":"2024-03-15T14:22:10.000Z","deletedAt":null,"deleted":false},"id":"paths/~1hub-api~1blueprint-post~1{id}/get/responses/200/content/application~1json/example"},"paths/~1hub-api~1blueprint-post~1{id}/put/requestBody/content/application~1json/example":{"value":{"name":"Despacho de Aprovação Revisado","form":{"formData":[{"fieldGroup":[{"fieldGroup":[{"type":"next-ck","key":"justificativa","templateOptions":{"label":"Justificativa","required":true,"hideLabel":false,"columns":"12","hiddenTemp":false,"readonly":false,"sensitiveField":false},"className":"col-12"},{"type":"next-input","key":"numero_processo","templateOptions":{"label":"Número do Processo","required":true,"hideLabel":false,"columns":"12","hiddenTemp":false,"readonly":false,"sensitiveField":false},"className":"col-12"},{"type":"radio","key":"aprovado","templateOptions":{"label":"Aprovado?","required":true,"hideLabel":false,"columns":"12","hiddenTemp":false,"readonly":false,"sensitiveField":false,"options":[{"label":"Sim","value":"true"},{"label":"Não","value":"false"}]},"className":"col-12"}],"wrappers":["card-post"],"expressionProperties":{}}]}]}},"id":"paths/~1hub-api~1blueprint-post~1{id}/put/requestBody/content/application~1json/example"},"paths/~1hub-api~1blueprint-post~1{id}/put/responses/200/content/application~1json/example":{"value":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","cityId":42,"name":"Despacho de Aprovação Revisado","form":{"formData":[{"fieldGroup":[{"fieldGroup":[{"type":"next-ck","key":"justificativa","templateOptions":{"label":"Justificativa","required":true,"hideLabel":false,"columns":"12","hiddenTemp":false,"readonly":false,"sensitiveField":false},"className":"col-12"},{"type":"next-input","key":"numero_processo","templateOptions":{"label":"Número do Processo","required":true,"hideLabel":false,"columns":"12","hiddenTemp":false,"readonly":false,"sensitiveField":false},"className":"col-12"},{"type":"radio","key":"aprovado","templateOptions":{"label":"Aprovado?","required":true,"hideLabel":false,"columns":"12","hiddenTemp":false,"readonly":false,"sensitiveField":false,"options":[{"label":"Sim","value":"true"},{"label":"Não","value":"false"}]},"className":"col-12"}],"wrappers":["card-post"],"expressionProperties":{}}]}]},"disabled":false,"allowedUserTypes":[],"statusList":[],"deadlineFormat":null,"deadlineValue":null,"createdAt":"2024-03-15T14:22:10.000Z","deletedAt":null,"deleted":false},"id":"paths/~1hub-api~1blueprint-post~1{id}/put/responses/200/content/application~1json/example"},"paths/~1hub-api~1blueprint-post~1{id}/patch/requestBody/content/application~1json/example":{"value":{"ops":[{"op":"test","path":"/form/formData/0/fieldGroup/0/fieldGroup/3/templateOptions/label","value":"Justificativa"},{"op":"replace","path":"/form/formData/0/fieldGroup/0/fieldGroup/3/templateOptions/label","value":"Justificativa do parecer"}]},"id":"paths/~1hub-api~1blueprint-post~1{id}/patch/requestBody/content/application~1json/example"},"paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch/requestBody/content/application~1json/example":{"value":{"enable":["TAXES"],"disable":["ACCEPTANCE"]},"id":"paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch/requestBody/content/application~1json/example"},"paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch/responses/200/content/application~1json/example":{"value":{"blueprintProcessId":"8f2b1c44-9d3e-4a55-b0c1-2e7f9a6d5b41","legacyId":"69aae29b8f070e4432a63036","availableTabs":["START","DISPATCH","RESUME","INTERNAL","TAXES"],"changed":{"enabled":["TAXES"],"disabled":["ACCEPTANCE"]}},"id":"paths/~1hub-api~1blueprint-process~1{id}~1tabs/patch/responses/200/content/application~1json/example"},"paths/~1hub-api~1blueprint-process~1{id}~1blueprint-posts/get/responses/200/content/application~1json/example":{"value":{"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":[{"id":"550e8400-e29b-41d4-a716-446655440000","name":"Despacho de Aprovação","disabled":false,"deleted":false,"allowedUserTypes":[],"deadlineFormat":null,"deadlineValue":null,"statuses":[{"id":"b1f0f5c2-6f5a-4c8e-9c9a-1d2e3f4a5b6c","name":"Deferido"}]}],"unresolved":[{"id":"9c1e7a2b-3d4f-4a5b-8c6d-7e8f9a0b1c2d","reason":"other_city","message":"despacho pertence a outra cidade (city 42)"}]},"id":"paths/~1hub-api~1blueprint-process~1{id}~1blueprint-posts/get/responses/200/content/application~1json/example"},"paths/~1hub-api~1type~1find/get/responses/200/content/application~1json/examples/Encontrada":{"value":{"city":{"index":145,"cidade":"Chapecó","estado":"SC"},"total":2,"forms":[{"id":"60df5787146b5035772c5bcd","title":"Habite-se"},{"id":"61011fb910c1570008792134","title":"Habite-se Parcial"}]},"key":"Encontrada","summary":"Cidade encontrada com formulários","id":"paths/~1hub-api~1type~1find/get/responses/200/content/application~1json/examples/Encontrada"},"paths/~1hub-api~1type~1find/get/responses/200/content/application~1json/examples/Nao encontrada":{"value":{"city":null,"total":0,"forms":[]},"key":"Nao encontrada","summary":"Cidade não encontrada","id":"paths/~1hub-api~1type~1find/get/responses/200/content/application~1json/examples/Nao encontrada"},"paths/~1hub-api~1type~1create/post/requestBody/content/application~1json/example":{"value":{"modelo":0,"cidade":"saopaulosp","config":{"title":"Alvará de Construção","sigla":"ALV"},"form":[],"step":{"config":[]}},"id":"paths/~1hub-api~1type~1create/post/requestBody/content/application~1json/example"},"paths/~1hub-api~1type~1create/post/responses/200/content/application~1json/example":{"value":{"_id":"69aae29b8f070e4432a63036","config":{"title":"Titulo novo assunto","descricao":"Descrição","cidade":"saopaulosp","approveActionText":"Deferir","markdown":"Acesse a aba Resumo para verificar o andamento do seu processo","sigla":"NEW","templates":[],"form_tramites":[],"fluxograma":{"fields":[]},"tenance":"Geral","devolverAoUltimo":true},"form":[{"wrappers":["stepper"],"fieldGroup":[{"fieldGroup":[{"newField":true,"type":"next-from","key":"from","templateOptions":{"label":"Remetente","required":true,"columns":"12","hiddenTemp":false,"readonly":true},"className":"col-12","expressionProperties":{}},{"newField":true,"type":"next-destinatario","key":"destinatario","templateOptions":{"label":"Destinatário","required":true,"columns":"12","hiddenTemp":false,"readonly":true,"addressee":{"type":"single","values":[]}},"className":"col-12","expressionProperties":{}},{"newField":true,"type":"next-input","key":"numero_processo","templateOptions":{"label":"Número do Processo","required":true,"columns":"12","hiddenTemp":false,"readonly":false,"sensitiveField":false},"className":"col-12","expressionProperties":{}},{"newField":true,"type":"next-ck","key":"descricao","templateOptions":{"label":"Descrição","required":false,"columns":"12","hiddenTemp":false,"readonly":false,"sensitiveField":false},"className":"col-12","expressionProperties":{}},{"newField":true,"type":"next-upload","key":"anexos","templateOptions":{"label":"Anexos","required":false,"columns":"12","extends":["PDF","PNG","JPG","JPEG"],"compactView":false,"hiddenTemp":false,"readonly":false,"sensitiveField":false},"className":"col-12","expressionProperties":{}}],"templateOptions":{"title":"Informações do Processo","subtitle":"","textHtml":"","editMode":false},"wrappers":["text-right","step"],"expressionProperties":{}}]}],"createdAt":"2026-03-06T00:00:00.000Z"},"id":"paths/~1hub-api~1type~1create/post/responses/200/content/application~1json/example"},"paths/~1hub-api~1type~1create/post/responses/400/content/application~1json/example":{"value":{"error":"Bad Request","message":"modelo is required"},"id":"paths/~1hub-api~1type~1create/post/responses/400/content/application~1json/example"},"paths/~1hub-api~1type~1create/post/responses/401/content/application~1json/example":{"value":{"error":"Unauthorized","message":"API Key is required"},"id":"paths/~1hub-api~1type~1create/post/responses/401/content/application~1json/example"},"paths/~1hub-api~1type~1edit~1{typeId}/patch/requestBody/content/application~1json/example":{"value":{"from":"davi-bot:ticket-259147","config":{"devolverAoUltimo":true,"title":"Titulo novo assunto","descricao":"Descrição","cidade":"saopaulosp","approveActionText":"Deferir","markdown":"Acesse a aba Resumo para verificar o andamento do seu processo","sigla":"NEW","templates":[],"form_tramites":[],"fluxograma":{"fields":[]}}},"id":"paths/~1hub-api~1type~1edit~1{typeId}/patch/requestBody/content/application~1json/example"},"paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/200/content/application~1json/example":{"value":{"_id":"69aae29b8f070e4432a63036","config":{"devolverAoUltimo":true,"title":"Titulo novo assunto","descricao":"Descrição","cidade":"saopaulosp","approveActionText":"Deferir","sigla":"NEW","tenance":"Geral"},"form":[{"wrappers":["stepper"],"fieldGroup":[{"fieldGroup":[{"newField":true,"type":"next-from","key":"from","templateOptions":{"label":"Remetente","required":true,"columns":"12","hiddenTemp":false,"readonly":true},"className":"col-12","expressionProperties":{}},{"newField":true,"type":"next-destinatario","key":"destinatario","templateOptions":{"label":"Destinatário","required":true,"columns":"12","hiddenTemp":false,"readonly":true,"addressee":{"type":"single","values":[]}},"className":"col-12","expressionProperties":{}},{"newField":true,"type":"next-input","key":"numero_processo","templateOptions":{"label":"Número do Processo","required":true,"columns":"12","hiddenTemp":false,"readonly":false,"sensitiveField":false},"className":"col-12","expressionProperties":{}},{"newField":true,"type":"next-ck","key":"descricao","templateOptions":{"label":"Descrição","required":false,"columns":"12","hiddenTemp":false,"readonly":false,"sensitiveField":false},"className":"col-12","expressionProperties":{}},{"newField":true,"type":"next-upload","key":"anexos","templateOptions":{"label":"Anexos","required":false,"columns":"12","extends":["PDF","PNG","JPG","JPEG"],"compactView":false,"hiddenTemp":false,"readonly":false,"sensitiveField":false},"className":"col-12","expressionProperties":{}}],"templateOptions":{"title":"Informações do Processo","subtitle":"","textHtml":"","editMode":false},"wrappers":["text-right","step"],"expressionProperties":{}}]}]},"id":"paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/200/content/application~1json/example"},"paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Nenhum campo valido":{"value":{"error":"Client Error","message":"Nenhum campo válido para atualizar. Campos permitidos: config, form, step, form_tramites"},"key":"Nenhum campo valido","summary":"Body sem nenhum campo da allowlist","id":"paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Nenhum campo valido"},"paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Campos conflitantes":{"value":{"error":"Client Error","message":"conflicting_fields: envie form_tramites no topo OU em config, não nos dois"},"key":"Campos conflitantes","summary":"Form_tramites no topo e dentro de config","id":"paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Campos conflitantes"},"paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Tipo invalido":{"value":{"error":"Client Error","message":"invalid_field_type: form_tramites deve ser um array"},"key":"Tipo invalido","summary":"Form_tramites que não é array","id":"paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/400/content/application~1json/examples/Tipo invalido"},"paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/401/content/application~1json/example":{"value":{"error":"Unauthorized","message":"API Key is required"},"id":"paths/~1hub-api~1type~1edit~1{typeId}/patch/responses/401/content/application~1json/example"},"paths/~1hub-api~1type~1patch~1{typeId}/patch/requestBody/content/application~1json/example":{"value":{"from":"ticket-solver:movidesk-259147: renomeia label da área construída","ops":[{"op":"test","path":"/form/0/fieldGroup/5/templateOptions/label","value":"Área construída"},{"op":"replace","path":"/form/0/fieldGroup/5/templateOptions/label","value":"Área construída (m²)"}]},"id":"paths/~1hub-api~1type~1patch~1{typeId}/patch/requestBody/content/application~1json/example"},"paths/~1hub-api~1type~1duplicate/post/requestBody/content/application~1json/examples/Mesmo ambiente":{"value":{"typeId":"60df5787146b5035772c5bcd"},"key":"Mesmo ambiente","summary":"Cópia na cidade do próprio assunto","id":"paths/~1hub-api~1type~1duplicate/post/requestBody/content/application~1json/examples/Mesmo ambiente"},"paths/~1hub-api~1type~1duplicate/post/requestBody/content/application~1json/examples/Outra cidade":{"value":{"typeId":"60df5787146b5035772c5bcd","cityId":145,"titulo":"Habite-se (cópia)","from":"davi-bot:ticket-259147"},"key":"Outra cidade","summary":"Cópia para a cidade destino","id":"paths/~1hub-api~1type~1duplicate/post/requestBody/content/application~1json/examples/Outra cidade"},"paths/~1hub-api~1type~1duplicate/post/responses/200/content/application~1json/example":{"value":{"_id":"6a5c19b18f070e4432a63099","config":{"title":"Habite-se (cópia)","cidade":"chapecosc","sigla":"HAB"},"form":[]},"id":"paths/~1hub-api~1type~1duplicate/post/responses/200/content/application~1json/example"},"paths/~1hub-api~1type~1duplicate/post/responses/400/content/application~1json/examples/typeId ausente":{"value":{"error":"Bad Request","message":"body must have required property 'typeId'"},"key":"typeId ausente","summary":"Body vazio","id":"paths/~1hub-api~1type~1duplicate/post/responses/400/content/application~1json/examples/typeId ausente"},"paths/~1hub-api~1type~1duplicate/post/responses/400/content/application~1json/examples/typeId invalido":{"value":{"error":"Bad Request","message":"body/typeId must match pattern \"^[a-fA-F0-9]{24}$\""},"key":"typeId invalido","summary":"Id fora do padrão de 24 caracteres hexadecimais","id":"paths/~1hub-api~1type~1duplicate/post/responses/400/content/application~1json/examples/typeId invalido"},"paths/~1hub-api~1template/get/responses/400/content/application~1json/example":{"value":{"error":"Bad Request","message":"name is required"},"id":"paths/~1hub-api~1template/get/responses/400/content/application~1json/example"},"paths/~1hub-api~1template/get/responses/401/content/application~1json/example":{"value":{"error":"Unauthorized","message":"API Key is required"},"id":"paths/~1hub-api~1template/get/responses/401/content/application~1json/example"},"paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/template_not_found":{"value":{"error":"Not Found","message":"Template 'NomeCidade/template.html' não encontrado"},"key":"template_not_found","summary":"Template não existe","id":"paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/template_not_found"},"paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/no_versions":{"value":{"error":"Not Found","message":"Template 'NomeCidade/template.html' não possui versões"},"key":"no_versions","summary":"Template sem versões","id":"paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/no_versions"},"paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/no_valid_html":{"value":{"error":"Not Found","message":"Template 'NomeCidade/template.html' não possui HTML válido para a versão 3"},"key":"no_valid_html","summary":"HTML vazio ou inválido","id":"paths/~1hub-api~1template/get/responses/404/content/application~1json/examples/no_valid_html"},"paths/~1hub-api~1template~1create/post/requestBody/content/application~1json/example":{"value":{"name":"MogidascruzesSP/Alvara.html","html":"<!DOCTYPE html><html><head><title>Alvará</title></head><body>...</body></html>","from":"ticket-solver:movidesk-259147: template novo"},"id":"paths/~1hub-api~1template~1create/post/requestBody/content/application~1json/example"},"paths/~1hub-api~1template~1create/post/responses/401/content/application~1json/example":{"value":{"error":"Unauthorized","message":"API Key is required"},"id":"paths/~1hub-api~1template~1create/post/responses/401/content/application~1json/example"},"paths/~1hub-api~1template~1edit/put/requestBody/content/application~1json/example":{"value":{"name":"MogidascruzesSP/Alvara.html","html":"<!DOCTYPE html><html><head><title>Alvará v2</title></head><body>...</body></html>","from":"ticket-solver:movidesk-259147: ajuste no cabeçalho"},"id":"paths/~1hub-api~1template~1edit/put/requestBody/content/application~1json/example"},"paths/~1hub-api~1template~1edit/put/responses/401/content/application~1json/example":{"value":{"error":"Unauthorized","message":"API Key is required"},"id":"paths/~1hub-api~1template~1edit/put/responses/401/content/application~1json/example"},"paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Organograma":{"value":{"city":{"index":246,"cidade":"Barueri","estado":"SP"},"total":2,"sectors":[{"id":"69d9303d8b027102629d405a","tag":"secretariamunicipaldeplanejamentourbano_baruerisp","name":"Secretaria Municipal de Planejamento e Urbanismo","acronym":"SPU","parentId":null,"level":0,"blocked":false},{"id":"69d9303d8b027102629d405b","tag":"gabinete_baruerisp","name":"Gabinete","acronym":"G","parentId":"69d9303d8b027102629d405a","level":1,"blocked":false}]},"key":"Organograma","summary":"Cidade com organograma montado","id":"paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Organograma"},"paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Sem setor":{"value":{"city":{"index":246},"total":0,"sectors":[]},"key":"Sem setor","summary":"Cidade existe, organograma ainda não montado","id":"paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Sem setor"},"paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Filtro sem resultado":{"value":{"city":{"index":76},"total":0,"cityTotal":614,"filteredBy":"protocolo","sectors":[]},"key":"Filtro sem resultado","summary":"O filtro não casou — a cidade tem organograma","id":"paths/~1hub-api~1sector~1list/get/responses/200/content/application~1json/examples/Filtro sem resultado"},"paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Ambigua":{"value":{"error":"Bad Request","message":"Mais de uma cidade chamada Chapecó/SC. Repita informando cityId (candidatos: 145, 778)"},"key":"Ambigua","summary":"Cidade duplicada no mesmo UF","id":"paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Ambigua"},"paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Nao informada":{"value":{"error":"Bad Request","message":"Informe cityId, ou cidade e uf"},"key":"Nao informada","summary":"Nem o índice nem o nome da cidade","id":"paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Nao informada"},"paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Nao encontrada":{"value":{"error":"Bad Request","message":"Cidade não encontrada: Narnia/SP"},"key":"Nao encontrada","summary":"Cidade inexistente","id":"paths/~1hub-api~1sector~1list/get/responses/400/content/application~1json/examples/Nao encontrada"}},"securitySchemeStore":{"Authorization":{"id":"Authorization","type":"apiKey","description":"Authorization","in":"header","paramName":"Authorization"},"InternalAuth":{"id":"InternalAuth","type":"apiKey","description":"Internal Authentication Key","in":"header","paramName":"x-api-key"}},"servers":[{"url":"https://api.producao.aprova.com.br"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/aprovahubapi","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/aprovahubapi.json?download"},{"url":"/_bundle/aprovahubapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Hub API - Aprova","description":"O Hub API é uma plataforma de abstração de APIs projetada para padronizar e simplificar a integração de sistemas de parceiros terceiros com o Aprova. O principal objetivo é criar um ponto de entrada único e seguro para as funcionalidades do Aprova. Utilizamos um sistema de autenticação robusto para garantir que o uso dos nossos serviços por terceiros seja seguro, controlado e intuitivo. Isso facilita o trabalho de desenvolvedores externos e reduz a complexidade da integração.\n\n## Como Obter sua Chave API\nPara começar a usar o Hub API, siga os passos abaixo para habilitar a funcionalidade e gerar suas chaves de acesso:\n\n**Passo 1: Ative a Permissão de Administrador**\n- Navegue até: *Outros > Administração Geral > Permissões > Todas as Permissões*\n- Ative a permissão `hubapi:admin`\n- Vincule essa permissão a um grupo de usuários administradores\n- Saia do sistema e entre novamente\n\n**Passo 2: Acesse o Gerenciador de Chaves**\n- Após ativar a permissão, um novo menu aparecerá\n- Navegue até: *Outros > Administração Geral > Gerenciar Ambiente > Chaves API - Hub API*\n\n**Passo 3: Crie sua Chave API**\n- Clique em **Criar Chave API**\n- Defina um nome único para identificar a chave\n- Copie e salve a chave exibida imediatamente\n\n**IMPORTANTE:**\nA chave API será exibida por completo apenas **uma vez**.\nApós sair da tela, por motivos de segurança, a chave completa **não será mostrada novamente**.\nCertifique-se de armazená-la em um local seguro.\n"}},"baseSlug":"/aprovahubapi","routesMapping":{}}