Sitecore API catalog/Entities API/
/
Create an entity

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 can 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, 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.

Security
OAuth2
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