Display Group
Display Groups
Filter by DisplayGroup Id
Filter by DisplayGroup Name
Filter by DisplayGroups containing a specific display
Filter by DisplayGroups containing a specific display in there nesting
Filter by DisplayGroups containing a specific dynamic criteria
Filter by tags
A flag indicating whether to treat the tags filter as an exact match
When filtering by multiple Tags, which logical operator should be used? AND|OR
Filter by whether the Display Group belongs to a Display or is user created
Should the list be refined for only those groups the User can Schedule against?
Filter by Folder ID
Specifies which field the results are sorted by. Used together with sortDir
Sort direction
a successful response
GET /api/displaygroup HTTP/1.1
Accept: */*
a successful response
[
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
]Add a new Display Group to the CMS
The Display Group Name
The Display Group Description
A comma separated list of tags for this item
Flag indicating whether this DisplayGroup is Dynamic
The filter criteria for this dynamic group. A comma separated set of regular expressions to apply
When filtering by multiple dynamic criteria, which logical operator should be used? AND|OR
The filter criteria for this dynamic group. A comma separated set of regular expressions to apply
When filtering by Tags, should we use exact match?
When filtering by Tags, which logical operator should be used? AND|OR
Folder ID to which this object should be assigned to
successful operation
POST /api/displaygroup HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 207
"displayGroup='text'&description='text'&tags='text'&isDynamic=1&dynamicCriteria='text'&logicalOperatorName='text'&dynamicCriteriaTags='text'&exactTags=1&logicalOperator='text'&folderId=1"successful operation
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}Get the Display Group object specified by the provided displayGroupId
Numeric ID of the Display Group to get
successful operation
Class DisplayGroup
The displayGroup Id
The displayGroup Name
The displayGroup Description
A flag indicating whether this displayGroup is a single display displayGroup
A flag indicating whether this displayGroup is dynamic
Criteria for this dynamic group. A comma separated set of regular expressions to apply
Which logical operator should be used when filtering by multiple dynamic criteria? OR|AND
Criteria for this dynamic group. A comma separated set of tags to apply
Flag indicating whether to filter by exact Tag match
Which logical operator should be used when filtering by multiple Tags? OR|AND
The UserId who owns this display group
The display bandwidth limit
A comma separated list of groups/users with permissions to this DisplayGroup
The datetime this entity was created
The datetime this entity was last modified
The id of the Folder this Display Group belongs to
The id of the Folder responsible for providing permissions for this Display Group
Optional Reference 1
Optional Reference 2
Optional Reference 3
Optional Reference 4
Optional Reference 5
GET /api/displaygroup/{id} HTTP/1.1
Accept: */*
successful operation
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}Edit an existing Display Group identified by its Id
The displayGroupId to edit.
The Display Group Name
The Display Group Description
A comma separated list of tags for this item
Flag indicating whether this DisplayGroup is Dynamic
The filter criteria for this dynamic group. A command separated set of regular expressions to apply
When filtering by multiple dynamic criteria, which logical operator should be used? AND|OR
The filter criteria for this dynamic group. A comma separated set of regular expressions to apply
When filtering by Tags, should we use exact match?
When filtering by Tags, which logical operator should be used? AND|OR
Folder ID to which this object should be assigned to
Reference 1
Reference 2
Reference 3
Reference 4
Reference 5
successful operation
Class DisplayGroup
The displayGroup Id
The displayGroup Name
The displayGroup Description
A flag indicating whether this displayGroup is a single display displayGroup
A flag indicating whether this displayGroup is dynamic
Criteria for this dynamic group. A comma separated set of regular expressions to apply
Which logical operator should be used when filtering by multiple dynamic criteria? OR|AND
Criteria for this dynamic group. A comma separated set of tags to apply
Flag indicating whether to filter by exact Tag match
Which logical operator should be used when filtering by multiple Tags? OR|AND
The UserId who owns this display group
The display bandwidth limit
A comma separated list of groups/users with permissions to this DisplayGroup
The datetime this entity was created
The datetime this entity was last modified
The id of the Folder this Display Group belongs to
The id of the Folder responsible for providing permissions for this Display Group
Optional Reference 1
Optional Reference 2
Optional Reference 3
Optional Reference 4
Optional Reference 5
PUT /api/displaygroup/{displayGroupId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 277
"displayGroup='text'&description='text'&tags='text'&isDynamic=1&dynamicCriteria='text'&logicalOperatorName='text'&dynamicCriteriaTags='text'&exactTags=1&logicalOperator='text'&folderId=1&ref1='text'&ref2='text'&ref3='text'&ref4='text'&ref5='text'"successful operation
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}Delete an existing Display Group identified by its Id
The displayGroupId to delete
successful operation
No content
DELETE /api/displaygroup/{displayGroupId} HTTP/1.1
Accept: */*
successful operation
No content
Adds the provided Displays to the Display Group
The Display Group to assign to
The Display Ids to assign
An optional array of Display IDs to unassign
successful operation
No content
POST /api/displaygroup/{displayGroupId}/display/assign HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 41
"displayId=[1]&unassignDisplayId=[1]"successful operation
No content
Removes the provided Displays from the Display Group
The Display Group to unassign from
The Display Ids to unassign
successful operation
No content
POST /api/displaygroup/{displayGroupId}/display/unassign HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 17
"displayId=[1]"successful operation
No content
Adds the provided DisplayGroups to the Display Group
The Display Group to assign to
The displayGroup Ids to assign
An optional array of displayGroup IDs to unassign
successful operation
No content
POST /api/displaygroup/{displayGroupId}/displayGroup/assign HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 51
"displayGroupId=[1]&unassignDisplayGroupId=[1]"successful operation
No content
Removes the provided DisplayGroups from the Display Group
The Display Group to unassign from
The DisplayGroup Ids to unassign
successful operation
No content
POST /api/displaygroup/{displayGroupId}/displayGroup/unassign HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 22
"displayGroupId=[1]"successful operation
No content
Adds the provided Media to the Display Group
The Display Group to assign to
The Media Ids to assign
Optional array of Media Id to unassign
successful operation
No content
POST /api/displaygroup/{displayGroupId}/media/assign HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 37
"mediaId=[1]&unassignMediaId=[1]"successful operation
No content
Removes the provided from the Display Group
The Display Group to unassign from
The Media Ids to unassign
successful operation
No content
POST /api/displaygroup/{displayGroupId}/media/unassign HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 15
"mediaId=[1]"successful operation
No content
Adds the provided Layouts to the Display Group
The Display Group to assign to
The Layouts Ids to assign
Optional array of Layouts Id to unassign
successful operation
No content
POST /api/displaygroup/{displayGroupId}/layout/assign HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 39
"layoutId=[1]&unassignLayoutId=[1]"successful operation
No content
Removes the provided from the Display Group
The Display Group to unassign from
The Layout Ids to unassign
successful operation
No content
POST /api/displaygroup/{displayGroupId}/layout/unassign HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 16
"layoutId=[1]"successful operation
No content
Send the collect now action to this DisplayGroup
The display group id
successful operation
No content
POST /api/displaygroup/{displayGroupId}/action/collectNow HTTP/1.1
Accept: */*
successful operation
No content
Clear all stats and logs on this Group
The display group id
successful operation
No content
POST /api/displaygroup/{displayGroupId}/action/clearStatsAndLogs HTTP/1.1
Accept: */*
successful operation
No content
Send a change layout action to the provided Display Group. This will be sent to Displays in that Group via XMR.
This can be either a Display Group or the Display specific Display Group
The ID of the Layout to change to. Either this or a campaignId must be provided.
The Layout specific campaignId of the Layout to change to. Either this or a layoutId must be provided.
The duration in seconds for this Layout change to remain in effect, after which normal scheduling is resumed.
Flag indicating whether the player should perform a collect before playing the Layout.
Whether to queue or replace with this action. Queuing will keep the current change layout action and switch after it is finished. If no active change layout action is present, both options are actioned immediately
successful operation
No content
POST /api/displaygroup/{displayGroupId}/action/changeLayout HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 83
"layoutId=1&campaignId=1&duration=1&downloadRequired=1&changeMode='text'"successful operation
No content
Send the revert to schedule action to this DisplayGroup
This can be either a Display Group or the Display specific Display Group
successful operation
No content
POST /api/displaygroup/{displayGroupId}/action/revertToSchedule HTTP/1.1
Accept: */*
successful operation
No content
Send the overlay layout action to this DisplayGroup, you can pass layoutId or layout specific campaignId
This can be either a Display Group or the Display specific Display Group
The ID of the Layout to change to. Either this or a campaignId must be provided.
The Layout specific campaignId of the Layout to change to. Either this or a layoutId must be provided.
The duration in seconds for this Overlay to remain in effect
Whether to queue or replace with this action. Queuing will keep the current change layout action and switch after it is finished. If no active change layout action is present, both options are actioned immediately
successful operation
No content
POST /api/displaygroup/{displayGroupId}/action/overlayLayout HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 63
"layoutId=1&campaignId=1&duration=1&downloadRequired=1"successful operation
No content
Send a predefined command to this Group of Displays
The display group id
The Command Id
successful operation
No content
POST /api/displaygroup/{displayGroupId}/action/command HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 15
"commandId=1"successful operation
No content
Copy an existing Display Group
The Display Group ID
The name for the copy
The description for the copy
Flag indicating whether to copy all display and display group members
Flag indicating whether to copy all layout and media assignments
Flag indicating whether to copy all tags
successful operation
POST /api/displaygroup/{displayGroupId}/copy HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 93
"displayGroup='text'&description='text'©Members=1©Assignments=1©Tags=1"successful operation
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}Select Folder for Display Group, can also be used with Display specific Display Group ID
The Display Group ID or Display specific Display Group ID
Folder ID to which this object should be assigned to
successful operation
Class DisplayGroup
The displayGroup Id
The displayGroup Name
The displayGroup Description
A flag indicating whether this displayGroup is a single display displayGroup
A flag indicating whether this displayGroup is dynamic
Criteria for this dynamic group. A comma separated set of regular expressions to apply
Which logical operator should be used when filtering by multiple dynamic criteria? OR|AND
Criteria for this dynamic group. A comma separated set of tags to apply
Flag indicating whether to filter by exact Tag match
Which logical operator should be used when filtering by multiple Tags? OR|AND
The UserId who owns this display group
The display bandwidth limit
A comma separated list of groups/users with permissions to this DisplayGroup
The datetime this entity was created
The datetime this entity was last modified
The id of the Folder this Display Group belongs to
The id of the Folder responsible for providing permissions for this Display Group
Optional Reference 1
Optional Reference 2
Optional Reference 3
Optional Reference 4
Optional Reference 5
PUT /api/displaygroup/{id}/selectfolder HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 14
"folderId=1"successful operation
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}Send the trigger webhook action to this DisplayGroup
The display group id
The trigger code that should be sent to the Player
successful operation
No content
POST /api/displaygroup/{displayGroupId}/action/triggerWebhook HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 22
"triggerCode='text'"successful operation
No content
Send criteria updates to the specified DisplayGroup or to all displays if displayGroupId is not provided.
The display group id
Successful operation
No content
Invalid criteria format
POST /api/displaygroup/criteria[/{displayGroupId}] HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 42
[
{
"metric": "text",
"value": "text",
"ttl": 1
}
]No content
Last updated
Was this helpful?