API de Movidesk - Mantenimiento y manipulación de campos adicionales

Importante: Nuestras API tienen un límite de 10 solicitudes por minuto para garantizar un uso saludable. Si tienes un escenario específico que requiere un aumento en el uso, contacta a nuestro equipo de atención para un análisis de viabilidad. Más información sobre horarios y límites de las API

https://api.movidesk.com/public/v1/ticketCustomFieldValue/

Tickets

  URL: /ticketCustomFieldValue
  Métodos: POST

Esta API utiliza solo el método POST, la operación debe indicarse en la URL, como se muestra en los ejemplos a continuación.

Descripción de la Aplicación:

La API desarrollada ofrece tres endpoints para la modificación de valores de campos adicionales, centralizados en el recurso: public\v1\ticketCustomFieldValue\{operación}.

La operación puede ser una de: InsertValues, UpdateValues y DeleteValues.

Cada recurso es responsable de insertar nuevos datos, actualizar datos existentes y eliminar datos, respectivamente.

InsertValues

Permite insertar nuevos valores dentro de un campo adicional.

Soporte para: Lista de Valores

Contrato:
Body:

{
   "customfieldid": "número";
   "customfieldvalues": ["cadena"]
}

Layout

Propiedad	Tipo	Descripción	Obligatorio	Ejemplo
customfieldid	Numérico	Identificador del campo adicional que será modificado	✓	5
customfieldvalues	Lista de cadenas	Lista de valores que serán insertados	✓	["Option A", "Option B"]

Errores Impeditivos:

¡Formato del cuerpo inválido! -> Si el formato de la solicitud es incorrecto (faltan parámetros o campos incompletos)

Campo con ID {id} no encontrado -> Si no se encuentra un campo adicional con el ID proporcionado.

Respuesta:

La API devolverá una nueva lista indicando el estado de cada valor insertado, con una propiedad success si no se encuentra ningún problema, o una propiedad Message indicando lo que salió mal:
El valor {value} ya existe como una opción para el campo {name}. -> Si se inserta un valor que ya existe en el campo con el ID proporcionado.

UpdateValues.

Permite editar valores dentro de un campo adicional.

Soporte Para: Lista de Valores

Contrato:
Body:

{ 
   "customfieldid": "number",  
   "customfieldvalues": [
    {
       "oldname": "string",
       "newname": "string"
    }
  ]
}

Layout

Propiedad	Tipo	Descripción	Obligatorio	Ejemplo
customfieldid	Numérico	Identificador del campo adicional que será modificado	✓	5
customfieldvalues	Lista de cadenas	Lista de valores que serán modificados	✓	[{"oldname": "Option A", "newname": "Main Option"}]

Errores Críticos:

Invalid body format! -> Si el formato de la solicitud es incorrecto (faltan parámetros o campos incompletos) o no tiene valores dentro del parámetro customfieldvalues.

Field with ID {id} not found -> Si no se encuentra un campo adicional con el ID proporcionado.

Retorno:

La API devolverá una nueva lista indicando el estado de cada valor insertado, con una propiedad success si no se encuentra ningún problema, o una propiedad Message indicando lo que salió mal:

The value {oldName} does not exists on the custom field {name}. → Si no se encuentra un campo con el valor name para ser modificado.

The value {newName} already exists on the custom field {name}. → Si el valor al que se está intentando cambiar ya existe dentro del campo con el ID proporcionado.

DeleteValues.

Permite eliminar valores dentro de un campo adicional.

Soporte Para: Lista de Valores

Contrato:

body: 
{ 
    "customfieldid": number, 
    "customfieldvalues": [string] 
}

Diseño

Propiedad	Tipo	Descripción	Obligatorio	Ejemplo
customfieldid	Numérico	Identificador del campo adicional que será modificado	✓	5
customfieldvalues	Lista de cadenas	Lista de valores que serán eliminados	✓	["Option A", "Option B"]

Errores Críticos:

Invalid body format! -> Si el formato de la solicitud es incorrecto (faltan parámetros o campos incompletos) o no tiene valores dentro del parámetro customfieldvalues.
Field with ID {id} not found -> Si no se encuentra un campo adicional con el ID proporcionado.

Retorno:

La API retornará una nueva lista indicando el estado de cada valor insertado, con una propiedad success si no se encuentra ningún problema, o una propiedad Message indicando lo que salió mal:

Could not delete {name}, the field {field} will be empty! If this is intentional, a manual delete must be done. → Si se intenta eliminar el último valor de un campo con el ID proporcionado, como regla general, no se permiten campos sin valores.
The value {name} does not exist on the custom field {field}. → Si no se encuentra un valor name para eliminar en el campo con el ID proporcionado.

Inserción de Valores
Método: POST

POST: /InsertValues
Parámetros: token

Ejemplo:
POST:https://api.movidesk.com/public/v1/ticketCustomFieldValue/InsertValues/?token=ec3d4562-5438-41aa-8af6-dc7708e0c75a

Cuerpo:

 {
    "customfieldid": "125529",
    "customfieldvalues": ["Opción A", "Opción B", "Opción C"]
}

Retorno:

{
    "values": [
     {
       "name": "Opción A",
       "success": true,
       "message": ""
     },
     {
       "name": "Opción B",
       "success": true,
       "message": ""
     },
     {
       "name": "Opción C",
       "success": true,
       "message": ""
     }
   ]
}

Actualización de Valores
Método: POST

POST: /UpdateValues
Parámetros: token

Ejemplo:

POST:https://api.movidesk.com/public/v1/ticketCustomFieldValue/UpdateValues/?token=ec3d4562-5438-41aa-8af6-dc7708e0c75a

Cuerpo:

{
    "customfieldid": "125529",
    "customfieldvalues": [
     {
       "oldname": "OPCIÓN A",
       "newname": "OPCIÓN 1"
     },
     {
       "oldname": "OPCIÓN B",
       "newname": "OPCIÓN 2"
     },
     {
      "oldname": "OPCIÓN C",
      "newname": "OPCIÓN 3"
     }
   ]
}

Retorno:

{
    "values": [
      {
        "name": "OPCIÓN A",
        "success": true,
        "message": ""
      },
      {
        "name": "OPCIÓN B",
        "success": true,
        "message": ""
      },
      {
        "name": "OPCIÓN C",
        "success": true,
        "message": ""
      }
   ]
}

Eliminación de Valores
Método: POST

POST: /DeleteValues
Parámetros: token

Ejemplo:
POST:https://api.movidesk.com/public/v1/ticketCustomFieldValue/DeleteValues/?token=ec3d4562-5438-4138-8af6-dc7708e0c75a

Cuerpo:

{
    "customfieldid": "125529",
    "customfieldvalues": 
[
    "Opción 1",
    "Opción 2",
    "Opción 3"
   ]
}

Retorno:

{
    "values": [
      {
        "name": "Opción 1",
        "success": true,
        "message": ""
      },
      {
        "name": "Opción 2",
        "success": true,
        "message": ""
      },
      {
        "name": "Opción 3",
        "success": true,
        "message": ""
      }
   ]
}

Institucional

Contenido

El Software

Módulos extras

Hola, ¿cómo podemos ayudarte?

Tickets