Entities

Update an entity using its ID

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.

put/api/entities/{id}

Request

Path parameters

idinteger required

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

Query parameters

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.

culturesstring[]

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

Request body

idinteger

The ID for the entity, for example 39752.

identifierstring nullable

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

culturesstring[] nullable

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

propertiesobject nullable

The properties of the entity.

relationsobject nullable

The relations of the entity.

created_onstring date-time

The date and time when the entity was created.

modified_onstring date-time

The date and time when the entity was last modified.

locked_onstring date-time nullable

The date and time when the entity was locked.

requested_permissionsobject nullable

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

is_root_taxonomy_itemboolean nullable

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

is_path_rootboolean nullable

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

The version of the entity.

modulesstring[] nullable

The modules associated with the entity.

Response

Successful operation

Changes

No recorded changes to this operation across all 1 revision of this API.