documentUpdate

A mutation DocumentUpdate permite atualizar o conteúdo de um document existente.

A atualização substitui o document inteiro pelo value informado, que é validado contra o schema da entidade. A entidade do document é definida na criação e não pode ser alterada. A operação exige que a entidade declare UPDATE em publicOperations.

Parâmetros

Argumento	Tipo	Obrigatório	Descrição
id	String	Sim	Identificador do document, em hash, como retornado por `documents` ou `document`
value	Any	Sim	O document atualizado, como um objeto JSON. Limitado a 2.000 caracteres

Campos de retorno

Os campos de retorno são os do document atualizado.

Campo	Tipo	Descrição
id	String	Identificador do document, em hash
data	Any	O document atualizado, com os campos públicos projetados

Exemplo

mutation {
  documentUpdate(
    id: "eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDF9"
    value: { sku: "ABC-123", cor: "Vermelho", custo: 39.9 }
  ) {
    id
    data
  }
}

Mostrar resposta

{
  "data": {
    "documentUpdate": {
      "id": "eyJFbnRpdHkiOiJEb2N1bWVudFZhbHVlIiwiSWQiOjQ1MDF9",
      "data": {
        "sku": "ABC-123",
        "cor": "Vermelho"
      }
    }
  }
}

🚧
Limite de tamanho
O document é limitado a 2.000 caracteres de JSON, verificados antes da validação contra o schema. Documents gravados acima desse limite antes da sua introdução continuam podendo ser lidos e removidos, mas falham nesta mutation com WDC101 enquanto não forem reduzidos.

📘
O externalId do document é imutável: definido apenas na criação pela API Pública, ele nunca é alterado nem anulado por esta mutation, ainda que a atualização substitua o conteúdo por inteiro.

Updated 15 days ago