Consultar Campos Personalizados - Departamentos e Categorias

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


Endpoint

https://api.tomticket.com/v2.0/custom_field/department/list


Método HTTP

GET


Content Type

form-data


Autenticação

Authorization: Bearer {SEU-TOKEN-AQUI}


Parâmetros Query String

Os parâmetros Query String são enviadas diretamente na URL após o símbolo de "?" ao final do endpoint. Cada parâmetro e valor deve ser enviado com o nome dele e valor, separados pelo símbolo de "=", como por exemplo nomeParametro=ValorParametro. Para enviar mais de um parâmetro, deve separá-los, usando símbolo "&", como por exemplo nomeParametro1=ValorParametro1&nomeParametro2=ValorParametro2.


ChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximo
department_idIdentificador do departamento para buscar os campos personalizados vinculados nele.
Sim-String250
category_idIdentificador 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.
Não-String250

Retorno

Descrição do retorno em JSON.

ColunaDescrição da ColunaTipo
errorInforma 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.Boolean
messageDetalhes da operação, caso tenha ocorrido ou não um problema.String
successRetorna true caso a operação tenha sido concluída com sucesso.Boolean
sizeTotal de itens encontrados.Int
dataLista com os campos personalizados cadastrados.Array
data
ticket
Lista de campos personalizados usados em chamados externos.Array
data
ticket
   id
Identificador do campo personalizado.String
data
ticket
   label
Label do campo personalizado.String
data
ticket
   type
Informa 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)
Int
data
ticket
   options
Valores disponíveis do campo personalizado.Array
data
ticket
   mandatory
Informa se o preenchimento do campo é obrigatório.Boolean
data
ticket
   operation
Lista os tipos de operação em que este campo pode ser utilizado.Array
data
ticket
   operation
       open
Informa se o campo pode ser usado para a abertura de chamados.Boolean
data
ticket
   operation
       close
Informa se o campo pode ser usado para o encerramento de chamados.Boolean
data
ticket
   operation
       evaluation
Informa se o campo pode ser usado para a avaliação de chamados.Boolean
data
chat
Lista de campos personalizados usados em chats.Array
data
chat
   id
Identificador do campo personalizado.String
data
chat
   label
Label do campo personalizado.String
data
chat
   type
Informa 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)
Int
data
chat
   options
Valores disponíveis do campo personalizado.Array
data
chat
   mandatory
Informa se o preenchimento do campo é obrigatório.Boolean
data
chat
   operation
Lista os tipos de operação em que este campo pode ser utilizado.Array
data
chat
   operation
       open
Informa se o campo pode ser usado para a abertura de chats.Boolean
data
chat
   operation
       evaluation
Informa se o campo pode ser usado para a avaliação de chats.Boolean

Código de Retorno

Descrição do código HTTP de retorno.

CódigoDescrição
200Operação realizada com sucesso.
401Token ou valores enviados não autorizados para uso.
403Recurso não disponível.
404Recurso não encontrado.

Disponibilidade

Recurso Premium Recurso Enterprise


Was this article helpful?  
We appreciate your review.