Pular para o conteúdo principal

Atualizar um tipo de peça

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

Atualiza um tipo de peça. Envie só os campos que vão mudar.

Requer os headers X-Api-Key, User-Agent e Content-Type: application/json. Limite: 1 requisição por segundo (saiba mais).

Requisição​

Parâmetros de caminho

idstringobrigatório

Identificador do tipo de peça.

Exemplo: YTFiMmMzZDQtZTVmNi03ODkwLWFiY2QtZWYxMjM0NTY3ODkwOjIyOTE1.

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Corpo da requisição

JSON, enviado com o header Content-Type: application/json.

namestring

Nome do tipo de peça. Deve ser único na conta.

descriptionstring

Descrição do tipo de peça.

archivedboolean

Aceito, mas ignorado. Use os endpoints de arquivar e desarquivar.

externalobject
Campos de external
idstring

Identificador do tipo de peça no seu sistema. Textos com mais de 100 caracteres são truncados.

Aceita: null.

customFieldslista de objetos

Campos customizados. Quando enviado, substitui todos os campos atuais e suas opções.

Campos de customFields
idstring

UUID do campo. Se omitido, a API gera um.

namestring

Nome do campo.

typestringobrigatório

Tipo do campo. Ausente ou fora desta lista resulta em erro 500 e nada é gravado.

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

requiredboolean

Indica se a resposta é obrigatória.

Padrão: false.

positioninteger

Posição de exibição. Padrão é a ordem no array, a partir de 1.

optionslista de objetos

Opções de resposta, para campos multiple-choice.

Campos de options
idstring

UUID da opção. Se omitido, a API gera um.

valuestring

Texto da opção.

positioninteger

Posição de exibição. Padrão é a ordem no array, a partir de 1.

Respostas

  • 200

    Tipo de peça atualizado.

  • 401

    Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

  • 403

    Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

  • 422

    Corpo inválido (resourceValidationErr), name já usado na conta ou identificador da URL inválido (property: @.id). Tipo de peça inexistente: 422 resourceNotFound (não há 404). Identificador inválido ou de outra conta: uriValidationErr.

  • 429

    Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

  • 500

    Erro inesperado no servidor.