Consultando uma entidade de document específica pelo ID

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

Para consultar uma entidade de document pelo identificador, utilize o endpoint Retorna uma entidade de document específica.

Parâmetros para consulta:

id - identificador da entidade.

A consulta por identificador retorna também o history, com os valores anteriores de name, schema, publicOperations e allowAdditionalProperties, do mais recente para o mais antigo.

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}},\"required\":[\"sku\"]}",
  "publicOperations": ["READ"],
  "allowAdditionalProperties": true,
  "createdAt": "2026-07-27T13:45:10.123Z",
  "updatedAt": "2026-07-27T15:10:02.000Z",
  "history": [
    {
      "name": "ficha-tecnica",
      "schema": "{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"type\":\"object\",\"properties\":{\"sku\":{\"type\":\"string\",\"publicView\":true}}}",
      "publicOperations": [],
      "allowAdditionalProperties": false,
      "updatedAt": "2026-07-27T15:10:02.000Z"
    }
  ]
}

Campos do histórico

Campo	Tipo	Descrição
`name`	string	Nome anterior da entidade
`schema`	string	Schema anterior da entidade
`publicOperations`	array de string	Operações públicas anteriores
`allowAdditionalProperties`	booleano	Valor anterior de `allowAdditionalProperties`
`updatedAt`	data	Momento (UTC) da alteração que substituiu os valores acima

🚧
Quando a entidade não existe na loja, o retorno é 404.

📘
Versões registradas no histórico antes da introdução do campo allowAdditionalProperties são retornadas com false.

Updated 10 days ago