v1

latestOpenAPI 3.0.0Apache 2.02026-07-1784052.8 KB
Entities

Create a new entity

post/entities

Request body

namestring required

Name of the entity to add. Should be unique.

fieldsobject[] required
endpointsGeneratedobject
virtualboolean

Whether or not the entity is virtual. Default to false.

Example request

{
  "name": "todos",
  "fields": [
    {
      "name": "id_todos",
      "type": "number",
      "primary": true,
      "unique": true,
      "required": true,
      "autoIncrement": true
    },
    {
      "name": "name",
      "type": "text"
    }
  ],
  "endpointsGenerated": {
    "list": {
      "enabled": true,
      "url": "/todos"
    },
    "create": {
      "enabled": true,
      "url": "/todos"
    },
    "get": {
      "enabled": true,
      "url": "/todos/:id_todos"
    },
    "update": {
      "enabled": true,
      "url": "/todos/:id_todos"
    },
    "delete": {
      "enabled": false,
      "url": "/todos/:id_todos"
    }
  },
  "virtual": true
}

Response

Success