Sitecore API catalog
/
Entities API
/
Entities

Entities API (v1.0)

Use the Entities API to retrieve, create, update, and delete entities. An entity is a set of data that belongs together (such as for a product, campaign, project, story, recipe, or asset).

Authentication

To use the Try it feature of the Entities API, you need:

  • The URL of your Content Hub server. You can get this from your Content Hub Administrator. Enter this URL in the {{server}} variable by hovering over the variable in the Try it pane and then clicking Edit.
  • An access token and the client ID. Both are sent with every request. You can create a token through the Content Hub interface or by requesting one to the API itself
    Note
    A Copy method is also available.
Download OpenAPI description
index.json
index.yaml
Overview
License closed source
Languages
Servers
https://{server}/

Entities

The Entities endpoint is used to manage entities.

Operations

Retrieve an entity using its ID

Request

Retrieves an entity using its ID and loads related data, including entity properties, member groups, renditions, permissions, and so on. You can also specify cultures for multi-language support.

Path
idinteger(int64)required

The ID for the entity, for example, 39752.

Query
culturestring

Culture of the entity you want to load, for example en-US . If no culture is provided, multi-language properties are not included. Use the cultures parameter to retrieve the entity in multiple cultures.

groupsstring

Member groups to include, for example, PreambleGroup,ChoiceGroup.

membersstring

Members to include, for example, PreambleThemeProperty,ChoiceThemeProperty.

renditionsstring

Renditions to include (comma-separated list), for example Thumbnail,Preview.

nestedRelationsArray of strings

Related entities to load directly instead of being referenced by a URL, for example ParentRelation,ChildRelation.

loadPermissionsboolean

Whether to include all permissions the user has on the entity, for example true or false.

Default false
culturesArray of strings

Cultures in which to load the entity. The culture parameter can still specify a culture, even if this parameter is missing, for example true or false.

curl -i -X GET \
  'https://your-server/api/entities/{id}?culture=string&cultures=string&groups=string&loadPermissions=false&members=string&nestedRelations=string&renditions=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
idinteger(int64)

The ID for the entity, for example 39752.

identifierstring or null

The identifier for the entity, for example, asset.VIPeventfruitbowl.

culturesArray of strings or null

The cultures associated with the entity, for example en-US.

propertiesobject or null

The properties of the entity.

relationsobject or null

The relations of the entity.

created_byobject(Link)

Represents a link to a resource.

created_onstring(date-time)

The date and time when the entity was created.

modified_byobject(Link)

Represents a link to a resource.

modified_onstring(date-time)

The date and time when the entity was last modified.

locked_byobject(Link)

Represents a link to a resource.

locked_onstring or null(date-time)

The date and time when the entity was locked.

entitydefinitionobject(Link)

Represents a link to a resource.

copyobject(Link)

Represents a link to a resource.

copyasyncobject(Link)

Represents a link to a resource.

permissionsobject(Link)

Represents a link to a resource.

requested_permissionsobject or null

The requested permissions with identification if a certain user has the permission.

lifecycleobject(Link)

Represents a link to a resource.

saved_selectionsobject(Link)

Represents a link to a resource.

rolesobject(Link)

Represents a link to a resource.

annotationsobject(Link)

Represents a link to a resource.

is_root_taxonomy_itemboolean or null

Gets or sets a value indicating whether the entity is a root taxonomy item.

is_path_rootboolean or null

Gets or sets a value indicating whether the entity is a path root.

inherits_securityboolean

Gets or sets a value indicating whether the entity inherits security.

is_system_ownedboolean

Gets or sets a value indicating whether the entity is system owned.

versioninteger(int64)

The version of the entity.

fullobject(Link)

Represents a link to a resource.

modulesArray of strings or null

The modules associated with the entity.

selfobject(Link)

Represents a link to a resource.

property name*anyadditional property
Response
application/json
{
  "id": 0,
  "identifier": "string",
  "cultures": [
    "string"
  ],
  "properties": {
    "property1": {},
    "property2": {}
  },
  "relations": {
    "property1": {},
    "property2": {}
  },
  "created_by": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "created_on": "2019-08-24T14:15:22Z",
  "modified_by": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "modified_on": "2019-08-24T14:15:22Z",
  "locked_by": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "locked_on": "2019-08-24T14:15:22Z",
  "entitydefinition": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "copy": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "copyasync": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "permissions": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "requested_permissions": {
    "property1": true,
    "property2": true
  },
  "lifecycle": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "saved_selections": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "roles": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "annotations": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "is_root_taxonomy_item": true,
  "is_path_root": true,
  "inherits_security": true,
  "is_system_owned": true,
  "version": 0,
  "full": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "modules": [
    "string"
  ],
  "self": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "property1": null,
  "property2": null
}

Update an entity using its ID

Request

Updates an entity with the new details provided, including properties, relations, associated members and groups, and so on. Properties or relations not included in the request will be set to null.

Path
idinteger(int64)\d+required

The ID of the entity to update, for example, 39752.

Query
culturestring

User culture for the entity, for example en-US, fr-CA.

groupsstring

Member groups to associate with the entity, for example PreambleGroup,ChoiceGroup.

membersstring

Members to associate with the entity, for example PreambleThemeProperty,ChoiceThemeProperty.

culturesArray of strings

Cultures to load, for example en-US. If provided, it overrides the culture parameter.

Bodyapplication/jsonrequired

The new details of the entity.

idinteger(int64)

The ID for the entity, for example 39752.

identifierstring or null

The identifier for the entity, for example, asset.VIPeventfruitbowl.

culturesArray of strings or null

The cultures associated with the entity, for example en-US.

propertiesobject or null

The properties of the entity.

relationsobject or null

The relations of the entity.

created_byobject(Link)

Represents a link to a resource.

created_onstring(date-time)

The date and time when the entity was created.

modified_byobject(Link)

Represents a link to a resource.

modified_onstring(date-time)

The date and time when the entity was last modified.

locked_byobject(Link)

Represents a link to a resource.

locked_onstring or null(date-time)

The date and time when the entity was locked.

entitydefinitionobject(Link)

Represents a link to a resource.

copyobject(Link)

Represents a link to a resource.

copyasyncobject(Link)

Represents a link to a resource.

permissionsobject(Link)

Represents a link to a resource.

requested_permissionsobject or null

The requested permissions with identification if a certain user has the permission.

lifecycleobject(Link)

Represents a link to a resource.

saved_selectionsobject(Link)

Represents a link to a resource.

rolesobject(Link)

Represents a link to a resource.

annotationsobject(Link)

Represents a link to a resource.

is_root_taxonomy_itemboolean or null

Gets or sets a value indicating whether the entity is a root taxonomy item.

is_path_rootboolean or null

Gets or sets a value indicating whether the entity is a path root.

inherits_securityboolean

Gets or sets a value indicating whether the entity inherits security.

is_system_ownedboolean

Gets or sets a value indicating whether the entity is system owned.

versioninteger(int64)

The version of the entity.

fullobject(Link)

Represents a link to a resource.

modulesArray of strings or null

The modules associated with the entity.

selfobject(Link)

Represents a link to a resource.

property name*anyadditional property
curl -i -X PUT \
  'https://your-server/api/entities/{id}?culture=string&cultures=string&groups=string&members=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "identifier": "string",
    "cultures": [
      "string"
    ],
    "properties": {
      "property1": {},
      "property2": {}
    },
    "relations": {
      "property1": {},
      "property2": {}
    },
    "created_by": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "created_on": "2019-08-24T14:15:22Z",
    "modified_by": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "modified_on": "2019-08-24T14:15:22Z",
    "locked_by": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "locked_on": "2019-08-24T14:15:22Z",
    "entitydefinition": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "copy": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "copyasync": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "permissions": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "requested_permissions": {
      "property1": true,
      "property2": true
    },
    "lifecycle": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "saved_selections": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "roles": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "annotations": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "is_root_taxonomy_item": true,
    "is_path_root": true,
    "inherits_security": true,
    "is_system_owned": true,
    "version": 0,
    "full": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "modules": [
      "string"
    ],
    "self": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "property1": null,
    "property2": null
  }'

Responses

Successful operation

Delete an entity using its ID

Request

Deletes an entity with the specified ID.

Path
idinteger(int64)\d+required

The unique ID of the entity to be deleted, for example, 39752.

curl -i -X DELETE \
  'https://your-server/api/entities/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Entity successfully deleted

Retrieve an entity using its identifier

Request

Retrieves an entity with the specified identifier, including related data such as properties, member groups, renditions, permissions, and so on.

Path
identifierstring^[a-zA-Z0-9]+$required

The identifier for the entity, for example, asset.VIPeventfruitbowl.

Query
culturestring

Culture in which to load the entity, for example en-US. If no culture is provided, multi-language properties are not included.

groupsstring

Member groups to include, for example PreambleGroup,ChoiceGroup.

membersstring

Members to include, for example PreambleThemeProperty,ChoiceThemeProperty.

renditionsstring

Renditions to include (comma-separated list), for example Thumbnail,Preview.

nestedRelationsArray of strings

Related entities to load directly instead of being referenced by a URL.

loadPermissionsboolean

Whether to include all permissions the user has on the entity.

Default false
curl -i -X GET \
  'https://your-server/api/entities/identifier/{identifier}?culture=string&groups=string&loadPermissions=false&members=string&nestedRelations=string&renditions=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
idinteger(int64)

The ID for the entity, for example 39752.

identifierstring or null

The identifier for the entity, for example, asset.VIPeventfruitbowl.

culturesArray of strings or null

The cultures associated with the entity, for example en-US.

propertiesobject or null

The properties of the entity.

relationsobject or null

The relations of the entity.

created_byobject(Link)

Represents a link to a resource.

created_onstring(date-time)

The date and time when the entity was created.

modified_byobject(Link)

Represents a link to a resource.

modified_onstring(date-time)

The date and time when the entity was last modified.

locked_byobject(Link)

Represents a link to a resource.

locked_onstring or null(date-time)

The date and time when the entity was locked.

entitydefinitionobject(Link)

Represents a link to a resource.

copyobject(Link)

Represents a link to a resource.

copyasyncobject(Link)

Represents a link to a resource.

permissionsobject(Link)

Represents a link to a resource.

requested_permissionsobject or null

The requested permissions with identification if a certain user has the permission.

lifecycleobject(Link)

Represents a link to a resource.

saved_selectionsobject(Link)

Represents a link to a resource.

rolesobject(Link)

Represents a link to a resource.

annotationsobject(Link)

Represents a link to a resource.

is_root_taxonomy_itemboolean or null

Gets or sets a value indicating whether the entity is a root taxonomy item.

is_path_rootboolean or null

Gets or sets a value indicating whether the entity is a path root.

inherits_securityboolean

Gets or sets a value indicating whether the entity inherits security.

is_system_ownedboolean

Gets or sets a value indicating whether the entity is system owned.

versioninteger(int64)

The version of the entity.

fullobject(Link)

Represents a link to a resource.

modulesArray of strings or null

The modules associated with the entity.

selfobject(Link)

Represents a link to a resource.

property name*anyadditional property
Response
application/json
{
  "id": 0,
  "identifier": "string",
  "cultures": [
    "string"
  ],
  "properties": {
    "property1": {},
    "property2": {}
  },
  "relations": {
    "property1": {},
    "property2": {}
  },
  "created_by": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "created_on": "2019-08-24T14:15:22Z",
  "modified_by": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "modified_on": "2019-08-24T14:15:22Z",
  "locked_by": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "locked_on": "2019-08-24T14:15:22Z",
  "entitydefinition": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "copy": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "copyasync": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "permissions": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "requested_permissions": {
    "property1": true,
    "property2": true
  },
  "lifecycle": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "saved_selections": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "roles": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "annotations": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "is_root_taxonomy_item": true,
  "is_path_root": true,
  "inherits_security": true,
  "is_system_owned": true,
  "version": 0,
  "full": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "modules": [
    "string"
  ],
  "self": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "property1": null,
  "property2": null
}

Update an entity using its identifier

Request

Updates an entity with the new details provided, including properties, relations, associated members and groups, and so on. Properties or relations not included in the request will be set to null.

Path
identifierstringrequired

The unique identifier of the entity to update, for example, asset.VIPeventfruitbowl.

Query
culturestring

User culture for the entity, for example en-US.

groupsstring

Member groups to associate with the entity, for example PreambleGroup,ChoiceGroup.

membersstring

Members to associate with the entity, for example PreambleThemeProperty,ChoiceThemeProperty.

Bodyapplication/jsonrequired

The new details of the entity to be updated.

idinteger(int64)

The ID for the entity, for example 39752.

identifierstring or null

The identifier for the entity, for example, asset.VIPeventfruitbowl.

culturesArray of strings or null

The cultures associated with the entity, for example en-US.

propertiesobject or null

The properties of the entity.

relationsobject or null

The relations of the entity.

created_byobject(Link)

Represents a link to a resource.

created_onstring(date-time)

The date and time when the entity was created.

modified_byobject(Link)

Represents a link to a resource.

modified_onstring(date-time)

The date and time when the entity was last modified.

locked_byobject(Link)

Represents a link to a resource.

locked_onstring or null(date-time)

The date and time when the entity was locked.

entitydefinitionobject(Link)

Represents a link to a resource.

copyobject(Link)

Represents a link to a resource.

copyasyncobject(Link)

Represents a link to a resource.

permissionsobject(Link)

Represents a link to a resource.

requested_permissionsobject or null

The requested permissions with identification if a certain user has the permission.

lifecycleobject(Link)

Represents a link to a resource.

saved_selectionsobject(Link)

Represents a link to a resource.

rolesobject(Link)

Represents a link to a resource.

annotationsobject(Link)

Represents a link to a resource.

is_root_taxonomy_itemboolean or null

Gets or sets a value indicating whether the entity is a root taxonomy item.

is_path_rootboolean or null

Gets or sets a value indicating whether the entity is a path root.

inherits_securityboolean

Gets or sets a value indicating whether the entity inherits security.

is_system_ownedboolean

Gets or sets a value indicating whether the entity is system owned.

versioninteger(int64)

The version of the entity.

fullobject(Link)

Represents a link to a resource.

modulesArray of strings or null

The modules associated with the entity.

selfobject(Link)

Represents a link to a resource.

property name*anyadditional property
curl -i -X PUT \
  'https://your-server/api/entities/identifier/{identifier}?culture=string&groups=string&members=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "identifier": "string",
    "cultures": [
      "string"
    ],
    "properties": {
      "property1": {},
      "property2": {}
    },
    "relations": {
      "property1": {},
      "property2": {}
    },
    "created_by": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "created_on": "2019-08-24T14:15:22Z",
    "modified_by": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "modified_on": "2019-08-24T14:15:22Z",
    "locked_by": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "locked_on": "2019-08-24T14:15:22Z",
    "entitydefinition": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "copy": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "copyasync": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "permissions": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "requested_permissions": {
      "property1": true,
      "property2": true
    },
    "lifecycle": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "saved_selections": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "roles": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "annotations": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "is_root_taxonomy_item": true,
    "is_path_root": true,
    "inherits_security": true,
    "is_system_owned": true,
    "version": 0,
    "full": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "modules": [
      "string"
    ],
    "self": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "property1": null,
    "property2": null
  }'

Responses

Entity successfully updated

Delete an entity using its identifier

Request

Deletes an entity with the specified identifier.

Path
identifierstringrequired

The unique identifier of the entity to be deleted, for example, asset.VIPeventfruitbowl.

curl -i -X DELETE \
  'https://your-server/api/entities/identifier/{identifier}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Entity successfully deleted

Retrieve a list of all entities for a specific entity definition

Request

Lists all entities for the specified entity definition.

Path
namestringrequired

Entity definition name to use when filtering the entities, for example M.Asset.

Query
skipinteger(int32)

Number of entities to skip before retrieving results, for example 1.

takeinteger(int32)

Number of entities to retrieve, for example 2.

culturestring

User culture in which to load the entities, for example en-US.

filterstring

Additional filters to apply when retrieving entities, for example status:active AND type:image.

groupsstring

Member groups to include in the retrieved entities, for example PreambleGroup,ChoiceGroup.

membersstring

Members to include in the retrieved entities, for example PreambleThemeProperty,ChoiceThemeProperty.

nestedRelationsArray of strings

Related entities to include fully loaded in the result, for example AssetRelation,ChildAssetRelation.

curl -i -X GET \
  'https://your-server/api/entitydefinitions/{name}/entities?culture=string&filter=string&groups=string&members=string&nestedRelations=string&skip=0&take=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
last_hit_dataArray of strings or null

The last returned hits, which are used to fetch the next page of results.

itemsArray of objects or null(EntityResource)

Gets or sets the list of items.

total_itemsinteger or null(int64)

Gets or sets the total number of items.

returned_itemsinteger or null(int64)

Gets or sets the number of returned items.

offsetinteger or null(int32)

Gets or sets the offset of the items.

nextobject(Link)

Represents a link to a resource.

previousobject(Link)

Represents a link to a resource.

identifierstring or null

Gets or sets the identifier of the resource.

selfobject(Link)

Represents a link to a resource.

property name*anyadditional property
Response
application/json
{
  "last_hit_data": [
    "string"
  ],
  "items": [
    { … }
  ],
  "total_items": 0,
  "returned_items": 0,
  "offset": 0,
  "next": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "previous": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "identifier": "string",
  "self": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "property1": null,
  "property2": null
}

Create an entity

Request

Creates an entity with the specified details, including associated members and groups. The link to the associated Entity Definition Resource is required. The self property is ignored and may be omitted.

If the request body contains an id, the request is treated as a possible UPSERT. If the id is omitted and only an identifier is provided, the request returns a conflict instead of updating the existing entity. The request then checks for the existence of the entity and if the response is positive, then it updates the entity based on the provided body elements. When an id is present, the header contains the same Location property as with a normal POST response. When an identifier is used, the header contains an X-Global-Identifier property with the updated identifier as its value.

Use the Upload API to upload assets to Content Hub.

Note
It is not possible to set relations while creating an entity unless the relations are nested. Additionally, this functionality is available only through the REST API and not through the Web Client SDK. For non-nested relations one call is made for each relation that is updated.

Query
culturestring

Culture for the entity, for example en-US.

groupsstring

Member groups to associate with the entity, for example PreambleGroup,ChoiceGroup.

membersstring

Members to associate with the entity, for example PreambleThemeProperty,ChoiceThemeProperty.

Bodyapplication/jsonrequired

Details of the entity to be added.

idinteger or null(int64)

Gets or sets the entity ID.

identifierstring or null

Gets or sets the entity identifier.

propertiesobject or null

Gets or sets the properties of the entity.

relationsobject or null

Gets or sets the relations of the entity.

is_root_taxonomy_itemboolean or null

Gets or sets a value indicating whether the entity is a root taxonomy item.

is_path_rootboolean or null

Gets or sets a value indicating whether the entity is a path root.

entitydefinitionobject(Link)

Represents a link to a resource.

is_system_ownedboolean

Gets or sets a value indicating whether the entity is system owned.

inherits_securityboolean

Gets or sets a value indicating whether the entity inherits security.

selfobject(Link)

Represents a link to a resource.

curl -i -X POST \
  'https://your-server/api/entities?culture=string&groups=string&members=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "identifier": "string",
    "properties": {
      "property1": {},
      "property2": {}
    },
    "relations": {
      "property1": {
        "parents": [
          {
            "properties": {
              "property1": {},
              "property2": {}
            },
            "renditions": {
              "property1": {},
              "property2": {}
            },
            "permissions": [
              "string"
            ],
            "identifier": "string",
            "href": "string",
            "filename_properties": [
              "string"
            ],
            "title": "string",
            "templated": false
          }
        ],
        "parent": {
          "properties": {
            "property1": {},
            "property2": {}
          },
          "renditions": {
            "property1": {},
            "property2": {}
          },
          "permissions": [
            "string"
          ],
          "identifier": "string",
          "href": "string",
          "filename_properties": [
            "string"
          ],
          "title": "string",
          "templated": false
        },
        "children": [
          {
            "properties": {
              "property1": {},
              "property2": {}
            },
            "renditions": {
              "property1": {},
              "property2": {}
            },
            "permissions": [
              "string"
            ],
            "identifier": "string",
            "href": "string",
            "filename_properties": [
              "string"
            ],
            "title": "string",
            "templated": false
          }
        ],
        "child": {
          "properties": {
            "property1": {},
            "property2": {}
          },
          "renditions": {
            "property1": {},
            "property2": {}
          },
          "permissions": [
            "string"
          ],
          "identifier": "string",
          "href": "string",
          "filename_properties": [
            "string"
          ],
          "title": "string",
          "templated": false
        },
        "inherits_security": true,
        "parent_total": 0,
        "child_total": 0,
        "self": {
          "href": "string",
          "filename_properties": [
            "string"
          ],
          "title": "string",
          "templated": false
        }
      },
      "property2": {
        "parents": [
          {
            "properties": {
              "property1": {},
              "property2": {}
            },
            "renditions": {
              "property1": {},
              "property2": {}
            },
            "permissions": [
              "string"
            ],
            "identifier": "string",
            "href": "string",
            "filename_properties": [
              "string"
            ],
            "title": "string",
            "templated": false
          }
        ],
        "parent": {
          "properties": {
            "property1": {},
            "property2": {}
          },
          "renditions": {
            "property1": {},
            "property2": {}
          },
          "permissions": [
            "string"
          ],
          "identifier": "string",
          "href": "string",
          "filename_properties": [
            "string"
          ],
          "title": "string",
          "templated": false
        },
        "children": [
          {
            "properties": {
              "property1": {},
              "property2": {}
            },
            "renditions": {
              "property1": {},
              "property2": {}
            },
            "permissions": [
              "string"
            ],
            "identifier": "string",
            "href": "string",
            "filename_properties": [
              "string"
            ],
            "title": "string",
            "templated": false
          }
        ],
        "child": {
          "properties": {
            "property1": {},
            "property2": {}
          },
          "renditions": {
            "property1": {},
            "property2": {}
          },
          "permissions": [
            "string"
          ],
          "identifier": "string",
          "href": "string",
          "filename_properties": [
            "string"
          ],
          "title": "string",
          "templated": false
        },
        "inherits_security": true,
        "parent_total": 0,
        "child_total": 0,
        "self": {
          "href": "string",
          "filename_properties": [
            "string"
          ],
          "title": "string",
          "templated": false
        }
      }
    },
    "is_root_taxonomy_item": true,
    "is_path_root": true,
    "entitydefinition": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "is_system_owned": true,
    "inherits_security": true,
    "self": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    }
  }'

Responses

Successful operation