Inserindo uma entidade de document
POST https://api.fbits.net/document/entities
Parâmetros para criação:
-
name- nome da entidade, único na loja e com até 100 caracteres;schema- JSON Schema (draft 2020-12) dos documents da entidade, com raiztype: objecte ao menos uma propriedade emproperties;publicOperations- operações públicas da entidade:CREATE,READ,UPDATE,DELETE(opcional);allowAdditionalProperties- permite que os documents da entidade tenham propriedades não declaradas emproperties(opcional, padrãofalse).
{
"name": "ficha-tecnica",
"schema": "{\"type\":\"object\",\"properties\":{\"sku\":{\"type\":\"string\",\"publicView\":true},\"peso\":{\"type\":\"number\"}},\"required\":[\"sku\"]}",
"publicOperations": ["READ"],
"allowAdditionalProperties": true
}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-27T13:45:10.123Z"
}
É bom saber:Com
allowAdditionalProperties: true, um document desta entidade pode conter propriedades que não estão noschema, em qualquer profundidade. Comfalseou ausente, a gravação de um document com propriedade não declarada retorna400indicando o caminho da propriedade (ex.:/peso,/cfg/extra,/tags/0/extra). Subschemas que não declaram nenhuma propriedade (ex.:{"type":"object"}) são trechos livres e aceitam qualquer conteúdo, independentemente desse campo.
Updated 10 days ago

