Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
76 lines (52 sloc) 1.84 KB

Create entity

Service Side API

The API class that is needed for entity, entity meta and field creation is EntityManager with its CreateEntity method. To initiate this, you need to be in Administrator role. You can create an entity with a code similar to:

var userEntity = new InputEntity();
userEntity.Name = "user";
userEntity.Label = "User";
userEntity.LabelPlural = "Users";
userEntity.System = true;
userEntity.Color = "#f44336";
userEntity.IconName = "ti-user";
EntityResponse response = new EntityManager().CreateEntity(userEntity);

Web API

Authorization

To initiate this web request, you need to be in Administrator role.

HTTP request
POST https://<YOUR_DOMAIN>/api/v3/en_US/meta/entity
Query parameters

No query parameters are required with this method.

Request body

You need to post a InputEntity object as a request body.

Request response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": false,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "fieldName",
      "value": "evaluated value",
      "message": "Error message"
    }
  ],
  "object": {
	/// The newly created entity
  }
}

Web interface

Important: This page describes a process of creating an entity using the WebVella SDK Plugin web interface

Step 1: Navigate to the SDK Application
Step 2: Select from the Objects top menu -> Entities

Entity list

Step 3: Press the "Create Entity" button on the top right corner

Entity list

Step 4: Press the green "Create Entity" button
You can’t perform that action at this time.