displayGroup

Edit a Display Group

Changed on

Edit an existing Display Group identified by its Id

put/displaygroup/{displayGroupId}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/displaygroup/{displayGroupId}
  • Auth
    none declared

Path parameters

displayGroupIdinteger required

The displayGroupId to edit.

Request body application/x-www-form-urlencoded

displayGroupstring required

The Display Group Name

descriptionstring

The Display Group Description

tagsstring

A comma separated list of tags for this item

isDynamicinteger required

Flag indicating whether this DisplayGroup is Dynamic

dynamicCriteriastring

The filter criteria for this dynamic group. A command separated set of regular expressions to apply

logicalOperatorNamestring

When filtering by multiple dynamic criteria, which logical operator should be used? AND|OR

dynamicCriteriaTagsstring

The filter criteria for this dynamic group. A comma separated set of regular expressions to apply

exactTagsinteger

When filtering by Tags, should we use exact match?

logicalOperatorstring

When filtering by Tags, which logical operator should be used? AND|OR

folderIdinteger

Folder ID to which this object should be assigned to

ref1string

Reference 1

ref2string

Reference 2

ref3string

Reference 3

ref4string

Reference 4

ref5string

Reference 5

Response

successful operation

displayGroupIdinteger

The displayGroup Id

displayGroupstring

The displayGroup Name

descriptionstring

The displayGroup Description

isDisplaySpecificinteger

A flag indicating whether this displayGroup is a single display displayGroup

isDynamicinteger

A flag indicating whether this displayGroup is dynamic

dynamicCriteriastring

Criteria for this dynamic group. A comma separated set of regular expressions to apply

dynamicCriteriaLogicalOperatorstring

Which logical operator should be used when filtering by multiple dynamic criteria? OR|AND

dynamicCriteriaTagsstring

Criteria for this dynamic group. A comma separated set of tags to apply

dynamicCriteriaExactTagsinteger

Flag indicating whether to filter by exact Tag match

dynamicCriteriaTagsLogicalOperatorstring

Which logical operator should be used when filtering by multiple Tags? OR|AND

userIdinteger

The UserId who owns this display group

bandwidthLimitinteger

The display bandwidth limit

groupsWithPermissionsstring

A comma separated list of groups/users with permissions to this DisplayGroup

groupsWithPermissionsListstring[]

An array of groups/users with permissions to this DisplayGroup

createdDtstring

The datetime this entity was created

modifiedDtstring

The datetime this entity was last modified

folderIdinteger

The id of the Folder this Display Group belongs to

permissionsFolderIdinteger

The id of the Folder responsible for providing permissions for this Display Group

ref1string

Optional Reference 1

ref2string

Optional Reference 2

ref3string

Optional Reference 3

ref4string

Optional Reference 4

ref5string

Optional Reference 5

Changes

  • 622fb073aecdRevision changes
    • info

      added the optional property to the response with the status

  • 41c04de98ec5Revision changes
    • breaking

      added required request body

    • info

      added the media type application/json for the response with the status