Pular para o conteúdo principal

Anexar um arquivo à ordem

POSThttps://carchost.fieldcontrol.com.br/orders/{id}/attachments

Anexa a uma ordem de serviço um arquivo já enviado. A resposta de sucesso usa o status 200.

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 da ordem de serviço.

Exemplo: NDJiMWQ0YzQtOWNmOC00NWE2LTg2MjItYjNjNzZjZjk0MmM4OjIyOTE1.

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.

pathstringobrigatório

URL do arquivo.

Mínimo de 5 caracteres.

titlestringobrigatório

Nome do arquivo, com extensão: .pdf, .doc, .docx, .xls, .xlsx, .ppt, .pptx, .jpg, .jpeg, .heic, .webp, .png, .mp4, .avi, .mov, .kml, .txt, .csv, .xml ou .zip.

Mínimo de 2 caracteres.

sizenumberobrigatório

Tamanho em bytes, até 50 MB.

De 0 a 52428800.

typestringobrigatório

Tipo MIME, por exemplo application/pdf, image/jpeg, image/png, video/mp4, text/csv ou application/zip. Vídeos ficam em processing até a compressão terminar.

Respostas

  • 200

    Anexo criado.

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

  • 422

    Corpo inválido (resourceValidationErr): extensão do title ou type não aceitos, ou size acima de 50 MB. Identificador da ordem inválido: uriValidationErr.

  • 429

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

  • 500

    Erro inesperado no servidor.