Atualizar o ID externo de uma requisição de material

Este endpoint permite atualizar o identificador externo (id_related ou code_related) de uma requisição de material (ordem de saída) no Fracttal One. A atualização é realizada no campo annotations da ordem de saída, permitindo associar ou modificar o valor externo que será refletido na plataforma para fins de integração ou rastreabilidade com outros sistemas. É permitida apenas a modificação dos campos id_related ou code_related da anotação da requisição.

O parâmetro na URL id é o ID do movimento da requisição. Você pode consultá-lo em Consultar as requisições de material de um OS, no campo id.

Parâmetros do body

Envie as seguintes informações no body da requisição.

ParâmetroTipoObrigatórioDescrição
propertyTextoSimNome da propriedade que será atualizada (id_related ou code_related).
valueTextoSimValor que será atribuído à propriedade informada.

Parâmetros de saída

ParâmetroTipoDescrição
idInteiroID do movimento.
annotationsArrayObjeto JSON com as anotações atualizadas da ordem de saída.

Dentro de annotations:

  • id_related: valor atualizado da propriedade id_related (string).
  • code_related: valor atualizado da propriedade code_related (string).

Ambos os campos dentro de annotations refletem os valores atuais após a atualização.

Exemplo

Requisição: PUT https://app.fracttal.com/api/outputs_orders_annotation/38226244

Body:

{
  "property": "code_related",
  "value": "test1234"
}

Resposta:

{
  "success": true,
  "message": "200",
  "data": {
    "id": 38226228,
    "annotations": {
      "id_related": "test1234",
      "code_related": "test1234"
    }
  },
  "total": 1
}
Path Params
string
required
Response
200
Language
LoadingLoading…