Sync Group
syncGroup
Search for Sync Groups viewable by this user
Filter by syncGroup Id
Filter by partial Sync Group name
Filter by Owner ID
Filter by Folder ID
Specifies which field the results are sorted by. Used together with sortDir
Sort direction
successful operation
GET /api/syncgroups HTTP/1.1
Accept: */*
successful operation
[
{
"syncGroupId": 1,
"name": "text",
"createdDt": "text",
"modifiedDt": "text",
"modifiedBy": 1,
"modifiedByName": "text",
"ownerId": 1,
"owner": "text",
"syncPublisherPort": 1,
"syncSwitchDelay": 1,
"syncVideoPauseDelay": 1,
"leadDisplayId": 1,
"leadDisplay": "text",
"folderId": 1,
"permissionsFolderId": 1
}
]Get the Sync Group object specified by the provided syncGroupId
Numeric ID of the Sync Group to get
successful operation
Class SyncGroup
The ID of this Entity
The name of this Entity
The datetime this entity was created
The datetime this entity was last modified
The ID of the user that last modified this sync group
The name of the user that last modified this sync group
The ID of the owner of this sync group
The name of the owner of this sync group
The publisher port number
The delay (in ms) when displaying the changes in content
The delay (in ms) before unpausing the video on start.
The ID of the lead Display for this sync group
The name of the lead Display for this sync group
The id of the Folder this Sync Group belongs to
The id of the Folder responsible for providing permissions for this Sync Group
GET /api/syncgroup/{syncGroupId} HTTP/1.1
Accept: */*
successful operation
{
"syncGroupId": 1,
"name": "text",
"createdDt": "text",
"modifiedDt": "text",
"modifiedBy": 1,
"modifiedByName": "text",
"ownerId": 1,
"owner": "text",
"syncPublisherPort": 1,
"syncSwitchDelay": 1,
"syncVideoPauseDelay": 1,
"leadDisplayId": 1,
"leadDisplay": "text",
"folderId": 1,
"permissionsFolderId": 1
}Add a new Sync Group to the CMS
The Sync Group Name
The publisher port number on which sync group members will communicate - default 9590
The delay (in ms) when displaying the changes in content - default 750
The delay (in ms) before unpausing the video on start - default 100
Folder ID to which this object should be assigned to
successful operation
POST /api/syncgroup/add HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 94
"name='text'&syncPublisherPort=1&syncSwitchDelay=1&syncVideoPauseDelay=1&folderId=1"successful operation
{
"syncGroupId": 1,
"name": "text",
"createdDt": "text",
"modifiedDt": "text",
"modifiedBy": 1,
"modifiedByName": "text",
"ownerId": 1,
"owner": "text",
"syncPublisherPort": 1,
"syncSwitchDelay": 1,
"syncVideoPauseDelay": 1,
"leadDisplayId": 1,
"leadDisplay": "text",
"folderId": 1,
"permissionsFolderId": 1
}Adds the provided Displays to the Sync Group
The Sync Group to assign to
The Display Ids to assign
An optional array of Display IDs to unassign
successful operation
No content
POST /api/syncgroup/{syncGroupId}/members HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 41
"displayId=[1]&unassignDisplayId=[1]"successful operation
No content
Edit an existing Sync Group
The Sync Group to edit
The Sync Group Name
The publisher port number on which sync group members will communicate - default 9590
The delay (in ms) when displaying the changes in content - default 750
The delay (in ms) before unpausing the video on start - default 100
The ID of the Display that belongs to this Sync Group and should act as a Lead Display
Folder ID to which this object should be assigned to
successful operation
POST /api/syncgroup/{syncGroupId}/edit HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 112
"name='text'&syncPublisherPort=1&syncSwitchDelay=1&syncVideoPauseDelay=1&leadDisplayId=1&folderId=1"successful operation
{
"syncGroupId": 1,
"name": "text",
"createdDt": "text",
"modifiedDt": "text",
"modifiedBy": 1,
"modifiedByName": "text",
"ownerId": 1,
"owner": "text",
"syncPublisherPort": 1,
"syncSwitchDelay": 1,
"syncVideoPauseDelay": 1,
"leadDisplayId": 1,
"leadDisplay": "text",
"folderId": 1,
"permissionsFolderId": 1
}Delete an existing Sync Group identified by its Id
The syncGroupId to delete
successful operation
No content
DELETE /api/syncgroup/{syncGroupId}/delete HTTP/1.1
Accept: */*
successful operation
No content
Get the Display members of the specified Sync Group
The ID of the Sync Group to get members for
Filter by event ID - return will include Layouts Ids scheduled against each group member
successful operation
Class SyncGroup
The ID of this Entity
The name of this Entity
The datetime this entity was created
The datetime this entity was last modified
The ID of the user that last modified this sync group
The name of the user that last modified this sync group
The ID of the owner of this sync group
The name of the owner of this sync group
The publisher port number
The delay (in ms) when displaying the changes in content
The delay (in ms) before unpausing the video on start.
The ID of the lead Display for this sync group
The name of the lead Display for this sync group
The id of the Folder this Sync Group belongs to
The id of the Folder responsible for providing permissions for this Sync Group
GET /api/syncgroup/{syncGroupId}/displays HTTP/1.1
Accept: */*
successful operation
[
{
"syncGroupId": 1,
"name": "text",
"createdDt": "text",
"modifiedDt": "text",
"modifiedBy": 1,
"modifiedByName": "text",
"ownerId": 1,
"owner": "text",
"syncPublisherPort": 1,
"syncSwitchDelay": 1,
"syncVideoPauseDelay": 1,
"leadDisplayId": 1,
"leadDisplay": "text",
"folderId": 1,
"permissionsFolderId": 1
}
]Last updated
Was this helpful?