Listar metadados dos campos adicionais disponíveis para a Requisição de Admissão
Changed onEste endpoint retorna o catálogo de campos adicionais (personalizados) cadastrados na entidade Funcionário e válidos para uso na Requisição de Admissão — nome, tipo de dado, obrigatoriedade, tamanho máximo e opções válidas (para campos de lista). Use este endpoint para descobrir programaticamente quais campos podem ser enviados no array camposAdicionais do endpoint POST /v2/funcionarios/admissao, e em qual formato, sem precisar consultar manualmente o Dicionário de Dados.
Apenas campos ativos e com prefixo AD_ são retornados. Campos dos tipos Hora, Binário e Texto Longo (CLOB) — incluindo as variações Arquivo, Múltiplo Arquivo e Texto com Formatação HTML — não são suportados no fluxo de admissão e não aparecem na resposta.
Caso o cliente não possua nenhum campo adicional cadastrado, a resposta é 200 com camposAdicionais vazio e totalCampos igual a 0.
Request
- Base URLhttps://api.sankhya.com.br
- URLhttps://api.sankhya.com.br/v1/funcionarios/metadados-campos-adicionais
- AuthAPI key in header Authorization
Query parameters
Número da página de resultados. Começa em 1. Valores menores que 1 são tratados como 1.
Quantidade de campos adicionais retornados por página. Valores menores que 1 são tratados como o padrão (50).
Response
Lista de campos adicionais retornada com sucesso.
Example response
{
"camposAdicionais": [
{
"nomeCampo": "AD_APELIDO",
"descricao": "Apelido do funcionário",
"tipo": "TEXTO",
"tamanhoMaximo": 50,
"opcoes": [
{
"valor": "A",
"descricao": "Admitido"
}
]
}
],
"totalCampos": 1,
"page": 1,
"pageSize": 50
}Changes
- info
endpoint added
- info