Sitecore API catalog/Entity definitions API/
/
Update an entity definiti...

Update an entity definition

Request

Updates an entity definition with the details provided.

Security
OAuth2.0
Path
namestringrequired

The name of the entity definition to update, for example, M.Asset.

Bodyapplication/json

The updated details of the entity definition, for example, an instance of Stylelabs.M.Base.Web.Api.Models.EntityDefinitionResource containing the updated properties.

idinteger, (int64)
namestring or null
modified_onstring, (date-time)
created_onstring, (date-time)
display_templatestring or null
is_taxonomy_item_definitionboolean
is_path_enabled_definitionboolean
is_manual_sorting_allowedboolean
is_system_ownedboolean
is_built_inboolean
labelsobject or null
member_groupsArray of objects or null(MemberGroup)
entitiesobject(Link)

Represents a link to a resource.

related_pathsobject(Link)

Represents a link to a resource.

modified_byobject(Link)

Represents a link to a resource.

created_byobject(Link)

Represents a link to a resource.

permissionsArray of strings or null

All available permissions for the entity definition

selfobject(Link)

Represents a link to a resource.

curl -i -X PUT \
  'https://your-server/api/entitydefinitions/{name}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "name": "string",
    "modified_on": "2019-08-24T14:15:22Z",
    "created_on": "2019-08-24T14:15:22Z",
    "display_template": "string",
    "is_taxonomy_item_definition": true,
    "is_path_enabled_definition": true,
    "is_manual_sorting_allowed": true,
    "is_system_owned": true,
    "is_built_in": true,
    "labels": {
      "property1": "string",
      "property2": "string"
    },
    "member_groups": [
      {
        "name": "string",
        "content_group": "string",
        "labels": {
          "property1": "string",
          "property2": "string"
        },
        "members": [
          {
            "name": "string",
            "labels": {
              "property1": "string",
              "property2": "string"
            },
            "helptext": {
              "property1": "string",
              "property2": "string"
            },
            "is_conditional": true,
            "conditions": [
              {
                "member": "string"
              }
            ],
            "can_trigger_conditional_members": true,
            "is_system_owned": true,
            "is_secured": true,
            "can_write": true,
            "allow_updates": true
          }
        ],
        "is_system_owned": true,
        "is_conditional": true,
        "conditions": [
          {
            "member": "string"
          }
        ],
        "is_secured": true,
        "can_write": true
      }
    ],
    "entities": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "related_paths": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "modified_by": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "created_by": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    },
    "permissions": [
      "string"
    ],
    "self": {
      "href": "string",
      "filename_properties": [
        "string"
      ],
      "title": "string",
      "templated": false
    }
  }'

Responses

The entity definition was successfully updated