Sign in
displayGroup

Get Display Groups

get/displaygroup

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

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

Changed in 5 of the 52 revisions of this API.147

  • fe497e811c7f2See the full diff
    • ○

      added the new optional query request parameter sortBy

      new-optional-request-parameter

    • ○

      added the new optional query request parameter sortDir

      new-optional-request-parameter

  • 41c04de98ec51See the full diff
    • ○

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

      response-media-type-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6d18f62f77823See the full diff
    • ○

      added the new optional query request parameter exactTags

      new-optional-request-parameter

    • ○

      added the new optional query request parameter logicalOperator

      new-optional-request-parameter

    • ○

      added the new optional query request parameter tags

      new-optional-request-parameter

  • 9ddbdc81e86a1See the full diff
    • ○

      added the new optional query request parameter folderId

      new-optional-request-parameter

  • 8e127539510414See the full diff
    • ▲

      removed the media type application/json for the response with the status 200

      response-media-type-removed

    • ●

      deleted the query request parameter exactTags

      request-parameter-removed

    • ●

      deleted the query request parameter folderId

      request-parameter-removed

    • ●

      deleted the query request parameter logicalOperator

      request-parameter-removed

    • ●

      deleted the query request parameter tags

      request-parameter-removed

    This revision also has 77 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog