Sitecore API catalog/Entity definitions API/
/
Calculate the impact of c...

Calculate the impact of changes to an entity definition

Request

Submits a modified version of an entity definition and returns an analysis of the impact those changes would have compared to the current definition. Used to preview the effects of schema changes before applying them.

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

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

Body

The updated details of the entity definition to compare against the original, for example, an instance of Stylelabs.M.Base.Web.Api.Models.EntityDefinitionResource containing the proposed changes.

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 POST \
  'https://your-server/api/entitydefinitions/{name}/impact' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+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 impact analysis was successfully calculated and returned