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 e publicOperations, 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"],
  "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": [],
      "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
`updatedAt`	data	Momento (UTC) da alteração que substituiu os valores acima

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

─────────── PÁGINA 5 — `Consultando uma entidade de document específica pelo nome` ───────────

GET https://api.fbits.net/document/entities/by-name/{name}

Para consultar uma entidade de document pelo nome, utilize o endpoint Retorna uma entidade de document pelo nome.

Parâmetros para consulta:

name - nome da entidade (a busca não diferencia maiúsculas de minúsculas).

O retorno é idêntico ao da consulta por identificador, incluindo o history.

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}}}",
  "publicOperations": ["READ"],
  "createdAt": "2026-07-27T13:45:10.123Z",
  "updatedAt": "2026-07-27T13:45:10.123Z",
  "history": []
}

🚧
Quando não existe entidade com o nome informado, o retorno é 404.

Consultando uma entidade de document específica pelo ID

Parâmetros para consulta:

Response body:

Campos do histórico

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

─────────── PÁGINA 5 — `Consultando uma entidade de document específica pelo nome` ───────────

Parâmetros para consulta:

Response body:

Quando não existe entidade com o nome informado, o retorno é `404`.

Parâmetros para consulta:

Response body:

Campos do histórico

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

─────────── PÁGINA 5 — Consultando uma entidade de document específica pelo nome ───────────

Parâmetros para consulta:

Response body:

Quando não existe entidade com o nome informado, o retorno é 404.

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

─────────── PÁGINA 5 — `Consultando uma entidade de document específica pelo nome` ───────────

Quando não existe entidade com o nome informado, o retorno é `404`.