Saltar al contenido principal

Actualizar un tipo de pieza

PUThttps://carchost.fieldcontrol.com.br/part-types/{id}

Actualiza un tipo de pieza. Envíe solo los campos que van a cambiar.

Requiere los headers X-Api-Key, User-Agent y Content-Type: application/json. Límite: 1 solicitud por segundo (más información).

Solicitud​

Parámetros de ruta

idstringobligatorio

Identificador del tipo de pieza.

Ejemplo: YTFiMmMzZDQtZTVmNi03ODkwLWFiY2QtZWYxMjM0NTY3ODkwOjIyOTE1.

Headers

User-Agentstringobligatorio

Identificación de su aplicación.

Ejemplo: MinhaIntegracao/1.0.

Cuerpo de la solicitud

JSON, enviado con el header Content-Type: application/json.

namestring

Nombre del tipo de pieza. Debe ser único en la cuenta.

descriptionstring

Descripción del tipo de pieza.

archivedboolean

Se acepta, pero se ignora. Use los endpoints de archivar y desarchivar.

externalobject
Campos de external
idstring

Identificador del tipo de pieza en su sistema. Los textos de más de 100 caracteres se truncan.

Acepta: null.

customFieldslista de objetos

Campos personalizados. Cuando se envía, reemplaza todos los campos actuales y sus opciones.

Campos de customFields
idstring

UUID del campo. Si se omite, la API genera uno.

namestring

Nombre del campo.

typestringobligatorio

Tipo del campo. Ausente o fuera de esta lista resulta en error 500 y no se guarda nada.

Valores aceptados: question, multiple-choice, date, number.

requiredboolean

Indica si la respuesta es obligatoria.

Predeterminado: false.

positioninteger

Posición de visualización. El valor predeterminado es el orden en el array, a partir de 1.

optionslista de objetos

Opciones de respuesta, para campos multiple-choice.

Campos de options
idstring

UUID de la opción. Si se omite, la API genera uno.

valuestring

Texto de la opción.

positioninteger

Posición de visualización. El valor predeterminado es el orden en el array, a partir de 1.

Respuestas

  • 200

    Tipo de pieza actualizado.

  • 401

    Clave de API ausente (Missing API Key) o inválida (Invalid API Key). Consulte Autenticación.

  • 403

    Cuenta bloqueada (Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación.

  • 422

    Cuerpo inválido (resourceValidationErr), name ya usado en la cuenta o identificador de la URL inválido (property: @.id). Tipo de pieza inexistente: 422 resourceNotFound (no hay 404). Identificador inválido o de otra cuenta: uriValidationErr.

  • 429

    Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.

  • 500

    Error inesperado en el servidor.