Sitecore API catalog/Entity definitions API/
/
Retrieve an entity defini...

Retrieve an entity definition by name (V2)

Request

Retrieves an entity definition by its name (V2 endpoint).

Security
OAuth2.0
Path
namestring^[A-Za-z_][A-Za-z0-9_.-]*$required

The definition name, for example, M.Asset.

curl -i -X GET \
  'https://your-server/api/entitydefinitions/name/{name}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
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
is_lightbooleanread-only

Gets a value indicating whether the entity definition is a light definition.

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.

Response
{
  "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,
  "is_light": true,
  "labels": {
    "property1": "string",
    "property2": "string"
  },
  "member_groups": [
    { … }
  ],
  "entities": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "related_paths": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "modified_by": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "created_by": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "permissions": [
    "string"
  ],
  "self": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  }
}