displayGroup

Get Display Groups

Changed on
get/displaygroup

Request

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

Query parameters

displayGroupIdinteger

Filter by DisplayGroup Id

displayGroupstring

Filter by DisplayGroup Name

displayIdinteger

Filter by DisplayGroups containing a specific display

nestedDisplayIdinteger

Filter by DisplayGroups containing a specific display in there nesting

dynamicCriteriastring

Filter by DisplayGroups containing a specific dynamic criteria

tagsstring

Filter by tags

exactTagsinteger

A flag indicating whether to treat the tags filter as an exact match

logicalOperatorstring

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

isDisplaySpecificinteger

Filter by whether the Display Group belongs to a Display or is user created

forScheduleinteger

Should the list be refined for only those groups the User can Schedule against?

folderIdinteger

Filter by Folder ID

sortBy'displayGroupId' | 'displayGroup' | 'description' | 'isDynamic' | 'dynamicCriteria' | 'dynamicCriteriaTags' | 'ref1' | 'ref2' | 'ref3' | 'ref4' | 'ref5' | 'createdDt' | 'modifiedDt' | 'groupsWithPermissions'

Specifies which field the results are sorted by. Used together with sortDir

sortDir'asc' | 'desc'

Sort direction

Response

a successful response

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

  • fe497e811c7fRevision changes
    • info

      added the new optional query request parameter sortBy

    • info

      added the new optional query request parameter sortDir