Create entity

post

https://data.api.exabel.com/v1/entityTypes/{entityTypeId}/entities

It is also possible to create an entity by calling UpdateEntity with allowMissing set to true.

Path Params

entityTypeId

string

required

The ID of an entity type, e.g. entityTypeIdentifier or namespace.entityTypeIdentifier. The namespace must be empty (being global) or a namespace accessible to the customer. The entity type identifier must match the regex \w[\w-]{0,63}.

Body Params

The entity to create.

name

string

required

Unique resource name of the entity, e.g. entityTypes/entityTypeIdentifier/entities/entityIdentifier or entityTypes/namespace1.entityTypeIdentifier/entities/namespace2.entityIdentifier. The namespaces must be empty (being global) or one of the predetermined namespaces the customer has access to. If namespace1 is not empty, it must be equal to namespace2. The entity identifier must match the regex \w[\w-]{0,63}.

displayName

string

Used when showing the entity in the Exabel app. Required when creating an entity.

description

string

Used when showing the entity in the Exabel app.

properties

object

Additional properties of this entity. This is currently not used in the Exabel app, but may be in future.

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.

defaultAn unexpected error response.