Consultar Campos Personalizados - Todos

Este método permite listar todos os campos personalizados de sua conta.

Endpoint

MétodoRotaContent-Type
GEThttps://api.tomticket.com/v2.0/custom_field/general/listform-data

Autenticação

Este endpoint utiliza autenticação Bearer Token.

Authorization: Bearer SEU_TOKEN_AQUI

Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso.

JSON de saída

JSON de saída - Consultar Campos Personalizados - Todos

CampoTipoDescrição
errorbooleanInforma se ocorreu um erro na operação. Se o retorno for false, então significa que a operação ocorreu com sucesso e não ocorreram problemas. Caso o retorno seja true, ocorreu um erro e será necessário verificar o campo mensagem para identificar o problema.
messagestringDetalhes da operação, caso tenha ocorrido ou não um problema.
successbooleanRetorna true caso a operação tenha sido concluída com sucesso.
sizeintegerTotal de itens encontrados.
dataarrayLista com os campos personalizados cadastrados.
idstringIdentificador do campo personalizado.
labelstringLabel de exibição do campo personalizado.
mandatorybooleanInforma se o campo personalizado é obrigatório.
maskstringRetorna a máscara utilizada no campo, quando houver.
valuesarrayLista com os valores aceitos pelo campo personalizado.
visible_to_customerbooleanInforma se o campo está disponível para visualização pelo cliente.
typebooleanInforma o tipo do campo. Opções disponíveis: 1 - Campo de Texto; 2 - Área de Texto; 3 - Caixa de Opções (Input=Select, ComboBox); 4 - Opções (Input=Radio, Ragio Group); 5 - Caixa de Verificação (Checkbox); 6 - Seleção Múltipla (Listbox).

Possíveis erros

Status HTTPMensagemQuando ocorre
401Token ou valores enviados não autorizados para uso.Quando o token ou os valores enviados não são autorizados.
403Recurso não disponível.Quando o recurso não está disponível.
404Recurso não encontrado.Quando o recurso não é encontrado.

 


Este artigo foi útil?  
Agradecemos sua avaliação.