Create Entity

API documentation

When creating a new entity, the /api/v1/entities endpoints are available. It is important to know that, depending on the specific entity’s structure, the body of the request will differ. The endpoints related to entity creation are the following:

POST /api/v1/entities/

Creates a new Entity.

{
  "object_label": "test",
  "object_name": "test",
  "datasource": "main",
  "audited": true,
  "show_on_menu": true,
  "use_adapter": false,
  "importable": true,
  "read_only": false,
  "layout": "default",
  "layout_properties": [
    {}
  ],
  "relationships": [],
  "fields": [],
  "recursive_queries": []
}

POST /api/v1/entities/{entity}

Creates a new entity record.

{
  "domains": [
    {
      "id": 0,
      "name": "string",
      "active": true
    }
  ],
  "user": {
    "id": 0,
    "username": "string",
    "email": "string"
  },
  "body": {
    "version": "string",
    "data": {
      "additionalProp1": {}
    },
    "relationships": [
      {
        "name": "string",
        "data": [
          {}
        ]
      }
    ]
  }
}