Atualizando uma entidade de document específica

PUT https://api.fbits.net/document/entities/{id}

Para atualizar uma entidade de document, utilize o endpoint Atualiza uma entidade de document.

É possível atualizar o nome, o schema e as operações públicas da entidade. A atualização é total: os campos não informados assumem o valor padrão — publicOperations ausente equivale a nenhuma operação pública.

Parâmetros para atualização:

id - identificador da entidade;
name - novo nome da entidade;
schema - novo JSON Schema da entidade;
publicOperations - novas operações públicas da entidade (opcional).

Request body:

{
  "name": "ficha-tecnica",
  "schema": "{\"type\":\"object\",\"properties\":{\"sku\":{\"type\":\"string\",\"publicView\":true},\"peso\":{\"type\":\"number\"},\"origem\":{\"type\":\"string\"}},\"required\":[\"sku\"]}",
  "publicOperations": ["READ", "CREATE"]
}

Response body:

{
  "id": 12,
  "name": "ficha-tecnica",
  "schema": "{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"type\":\"object\",\"properties\":{\"sku\":{\"type\":\"string\",\"publicView\":true},\"peso\":{\"type\":\"number\",\"publicView\":false},\"origem\":{\"type\":\"string\",\"publicView\":false}},\"required\":[\"sku\"]}",
  "publicOperations": ["CREATE", "READ"],
  "createdAt": "2026-07-27T13:45:10.123Z",
  "updatedAt": "2026-07-27T15:10:02.000Z"
}

📘
Cada atualização registra os valores anteriores no histórico da entidade, consultável pelas leituras por identificador e por nome.

🚧
Alterar o schema de uma entidade que já possui documents gravados não revalida os documents existentes. A validação passa a valer para as próximas criações e atualizações.

Updated about 4 hours ago