Pular para o conteúdo principal

21/07/2026

Documentação Swagger agora traz instruções de uso dos campos adicionais​

A documentação OpenAPI (Swagger) gerada para as fontes de dados publicadas no Estúdio de Aplicações (API Gateway) não trazia instruções de uso dos campos adicionais configurados pela entidade, quando existentes. Isso podia levar desenvolvedores a interpretar incorretamente como consultar esses campos em integrações e extensões.

A documentação Swagger de cada fonte de dados agora exibe, quando houver campos adicionais configurados, uma seção Campos Adicionais explicando como consultá-los.

novidade

Como consultar campos adicionais

Os campos adicionais não são retornados por padrão. Para incluí-los na resposta, utilize o parâmetro cpaFields.

Os campos adicionais são organizados em grupos. A seleção segue a notação de agrupamento por parênteses: camposAdicionais(grupo(campo1, campo2)).

Por exemplo, para receber os campos adicionais stato e engegov do grupo padrao, use:

cpaFields=camposAdicionais(padrao(stato,engegov))

Os campos selecionados são retornados dentro do objeto camposAdicionais em cada registro.

Exemplo de requisição completa

curl --request GET \
  --url 'https://obras.suite.betha.cloud/dados/v1/obras?fields=codObra%2Cid&cpaFields=camposAdicionais(padrao(stato%2Cengegov))' \
  --header 'Authorization: Bearer [TOKEN]' \
  --header 'User-Access: [USER-ACCESS]'

Como usar​

  1. Acesse a documentação Swagger da fonte de dados desejada, publicada no Estúdio de Aplicações (API Gateway).
  2. Quando houver campos adicionais configurados, a seção Campos Adicionais fica disponível junto à descrição do recurso.
info

A seção Campos Adicionais só aparece na documentação Swagger das fontes de dados que possuem campos adicionais configurados pela entidade.

caution

A disponibilidade de campos adicionais pode variar de acordo com a instituição. Consulte a respectiva entidade para verificar os requisitos específicos e os campos complementares disponíveis para cada cadastro.