Editar Chamado

Este método permite alterar os dados de um chamado existente.

Endpoint

MétodoRotaContent-Type
POSThttps://api.tomticket.com/v2.0/ticket/updatemultipart/form-data

Autenticação

A autenticação da versão 2.0 da API é feita por Bearer Token Authentication. Para acessar este recurso, inclua o token de acesso no cabeçalho Authorization, precedido pela palavra Bearer e separado por um espaço.

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

Os parâmetros devem ser enviados via POST, no formato multipart/form-data. O parâmetro ticket_id é obrigatório. Os demais parâmetros são opcionais e devem respeitar as regras de negócio descritas neste artigo.

Parâmetros da requisição - Alterar Chamado

CampoTipoObrigatórioTamanho máximoDescrição
ticket_idstringSim250Identificador do chamado que será alterado.
customer_idstringNão250Identificador do cliente.
department_idstringNão250Identificador do departamento. A alteração deve respeitar as regras de vínculo entre departamento e categoria descritas neste artigo.
category_idstringNão250Identificador da categoria. Envie um valor vazio para remover a categoria do chamado, definindo-a como NULL. A alteração deve respeitar as regras de vínculo entre departamento e categoria descritas neste artigo.
subjectstringNão250Assunto do chamado.
custom_field_openarrayNão-Lista de campos personalizados de abertura do chamado, indexada pelo identificador de cada campo. Envie os valores como custom_field_open[ID]. Esses campos podem ser editados independentemente do status do chamado.
ID-DO-CAMPO-01string--Valor do Campo 01. Ex.: custom_field_open[ID-DO-CAMPO-01]
ID-DO-CAMPO-02string--Valor do Campo 02. Ex.: custom_field_open[ID-DO-CAMPO-02]
ID-DO-CAMPO-Nstring--Valor do Campo N. Ex.: custom_field_open[ID-DO-CAMPO-N]
custom_field_closearrayNão-Lista de campos personalizados de encerramento do chamado, indexada pelo identificador de cada campo. Envie os valores como custom_field_close[ID]. Esses campos só podem ser editados quando o chamado estiver finalizado.
ID-DO-CAMPO-01string--Valor do Campo 01. Ex.: custom_field_close[ID-DO-CAMPO-01]
ID-DO-CAMPO-02string--Valor do Campo 02. Ex.: custom_field_close[ID-DO-CAMPO-02]
ID-DO-CAMPO-Nstring--Valor do Campo N. Ex.: custom_field_close[ID-DO-CAMPO-N]

Os identificadores dos campos personalizados estão disponíveis na Listagem de Campos Personalizados. O identificador deve ser utilizado como índice do respectivo parâmetro, por exemplo: custom_field_open[abc01] ou custom_field_close[abc02].

Regras de negócio

Departamento

O parâmetro department_id pode ser enviado sem category_id somente quando não houver nenhuma categoria vinculada ao departamento. Caso contrário, será retornado um erro.

Para alterar o departamento e deixar o chamado sem categoria, envie department_id e inclua também category_id com valor vazio. Nesse caso, a categoria do chamado será definida como NULL.

Categoria

O parâmetro category_id pode ser enviado sem department_id quando seu valor estiver vazio ou quando a categoria informada estiver vinculada ao departamento atual do chamado.

Se a nova categoria não estiver vinculada ao departamento atual, será necessário enviar também o department_id do novo departamento ao qual a categoria está vinculada. Caso contrário, será retornado um erro.

Campos personalizados de abertura do chamado

Os campos enviados em custom_field_open podem ser editados independentemente do status do chamado.

Os campos que tiverem sido vinculados em algum momento ao departamento e à categoria do chamado permanecerão vinculados permanentemente ao chamado e continuarão disponíveis para edição.

Campos personalizados de encerramento do chamado

Os campos enviados em custom_field_close podem ser editados somente quando o chamado estiver com o status finalizado.

Os campos que tiverem sido vinculados em algum momento ao departamento e à categoria do chamado permanecerão vinculados permanentemente ao chamado. A edição desses campos continuará disponível desde que o chamado esteja finalizado.

JSON de saída

JSON de saída - Alterar Chamado

CampoTipoDescrição
errorbooleanInforma se ocorreu um erro na operação. Quando false, a operação foi realizada com sucesso. Quando true, consulte o campo message 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.

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.

Observações


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