Skip to navigation

Listar campos customizados

Lista as definições de campos personalizados da conta.

Autenticação: Bearer Token da API WBudget. O acesso aos dados respeita as permissões do usuário.

A definição dos campos varia por conta. Consulte os identificadores e tipos retornados antes de enviar metadata nas operações de escrita. O exemplo é ilustrativo.

Resposta

HTTP 200. Os exemplos usam dados fictícios e mostram os campos principais; outros campos podem acompanhar a resposta. Campos sem valor podem ser nulos.

Campos principais de data (cada elemento da lista):

CampoTipoDescrição
idintegerID da definição.
entitystringEntidade que recebe o campo.
headerstringRótulo exibido.
typestringTipo do campo, por exemplo string.
meta_idstringIdentificador do campo.
bindingstringVínculo do campo na entidade.
visiblebooleanIndica visibilidade.
orderintegerOrdem de exibição.
{
"data": [
{
"id": 1,
"entity": "budget",
"header": "Referência externa",
"type": "string",
"meta_id": "referencia_externa",
"visible": true,
"order": 1
}
]
}

Consulte a introdução da collection para o formato de erros e a configuração das variáveis.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

200 — Sucesso — exemplo ilustrativo

datalist of objectsOptional