Consultar Campos Personalizados - Departamentos e Categorias

Este método permite listar todos os campos personalizados da sua conta usados para chamados externos por departamento e categoria.

Endpoint

MétodoRotaContent-Type
GEThttps://api.tomticket.com/v2.0/custom_field/department/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.

Parâmetros da requisição

Parâmetros da requisição - Consultar Campos Personalizados - Departamentos e Categorias

CampoTipoObrigatórioTamanho máximoDescrição
department_idstringSim250Identificador do departamento para buscar os campos personalizados vinculados nele.
category_idstringNão250Identificador da categoria para buscar os campos personalizados vinculados nela. Caso não seja enviado, serão listados os campos personalizados vinculados ao departamento quando não é definida uma categoria.

JSON de saída

JSON de saída - Consultar Campos Personalizados - Departamentos e Categorias

CampoTipoDescrição
errorbooleanInforma se ocorreu um erro na operação.
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.
ticketarrayLista de campos personalizados usados em chamados externos.
idstringIdentificador do campo personalizado.
labelstringLabel do campo personalizado.
typeintegerInforma 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).
optionsarrayValores disponíveis do campo personalizado.
mandatorybooleanInforma se o preenchimento do campo é obrigatório.
operationarrayLista os tipos de operação em que este campo pode ser utilizado.
openbooleanInforma se o campo pode ser usado para a abertura de chamados.
closebooleanInforma se o campo pode ser usado para o encerramento de chamados.
evaluationbooleanInforma se o campo pode ser usado para a avaliação de chamados.
chatarrayLista de campos personalizados usados em chats.
idstringIdentificador do campo personalizado.
labelstringLabel do campo personalizado.
typeintegerInforma 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).
optionsarrayValores disponíveis do campo personalizado.
mandatorybooleanInforma se o preenchimento do campo é obrigatório.
operationarrayLista os tipos de operação em que este campo pode ser utilizado.
openbooleanInforma se o campo pode ser usado para a abertura de chats.
evaluationbooleanInforma se o campo pode ser usado para a avaliação de chats.

Possíveis erros

Status HTTPMensagemQuando ocorre
401Token ou valores enviados não autorizados para uso.Quando o token ou os valores enviados não estã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.