syncGroup

Search Sync Groups

Changed on

Search for Sync Groups viewable by this user

get/syncgroups

Request

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

Query parameters

syncGroupIdinteger

Filter by syncGroup Id

namestring

Filter by partial Sync Group name

ownerIdinteger

Filter by Owner ID

folderIdinteger

Filter by Folder ID

sortBy'syncGroupId' | 'name' | 'owner' | 'createdDt' | 'modifiedDt'

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

sortDir'asc' | 'desc'

Sort direction

Response

successful operation

syncGroupIdinteger

The ID of this Entity

namestring

The name of this Entity

createdDtstring

The datetime this entity was created

modifiedDtstring nullable

The datetime this entity was last modified

modifiedByinteger

The ID of the user that last modified this sync group

modifiedByNamestring

The name of the user that last modified this sync group

ownerIdinteger

The ID of the owner of this sync group

ownerstring

The name of the owner of this sync group

syncPublisherPortinteger

The publisher port number

syncSwitchDelayinteger

The delay (in ms) when displaying the changes in content

syncVideoPauseDelayinteger

The delay (in ms) before unpausing the video on start.

leadDisplayIdinteger

The ID of the lead Display for this sync group

leadDisplaystring

The name of the lead Display for this sync group

folderIdinteger

The id of the Folder this Sync Group belongs to

permissionsFolderIdinteger

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

Changes