Pular para o conteúdo principal

Atualizar um tipo de equipamento

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

Atualiza um tipo de equipamento. O corpo segue as mesmas regras da criação.

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 equipamento.

Exemplo: NDFkNzk3MDctZDI3Yy00ZTM1LWJmZGQtYTNhMTUwNzEwNmNkOjIyOTE1.

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.

namestringobrigatório

Nome do tipo de equipamento. Deve ser único na conta, sem diferenciar maiúsculas e minúsculas.

De 3 a 100 caracteres.

archivedboolean

Arquiva o tipo de equipamento.

Padrão: false.

externalobject
Campos de external
idstring

Identificador do tipo de equipamento no seu sistema.

Até 100 caracteres.Aceita: null.

Respostas

  • 200

    Tipo de equipamento 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.

  • 404

    Recurso não encontrado. O corpo da resposta é vazio.

  • 409

    Já existe um tipo de equipamento com o mesmo nome na conta, incluindo arquivados (resourceAlreadyExists).

  • 422

    Corpo inválido (resourceValidationErr). Um identificador inválido ou de outra conta na URL também retorna este erro, com property: '@.id'.

  • 429

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

  • 500

    Erro inesperado no servidor.