Page Comparison

Panel

borderColor	#3D3D3D
bgColor	#F4F4F4
titleColor	#3D3D3D
borderWidth	0
titleBGColor	#3D3D3D
borderStyle	solid

ON THIS PAGE

Table of Contents

maxLevel	3
indent	20px

...

Simple Presentation: A simple, non-interactive presentation that uses default configuration files on the server. REST APIs can be used to make changes to the Presentation instance directly by modifying the entries in the zones array.
Complete Presentation: An interactive or non-interactive presentation that consists of configuration files that are uploaded by a client. The APIs are used to modify the files that belong to the presentation (using the files array): A client application must make edits to the presentation, then upload the payload of files to the /presentations/ endpoint.

/presentations/

GET

Retrieves a list of presentations on the network.

URL Parameters

marker: A value specifying which page to retrieve. This value is useful if the isTruncated entry in the response body of the previous GET call indicates that the number of Presentation instances exceeds the pageSize.
pageSize: The maximum number of Presentation instances that can be contained in the response body
filter: An expression for filtering search results.
sort: An expression for sorting the search results. The sort expression specifies the entry used for sorting and the ascending/descending (ASC/DESC) sorting order (e.g. "[presentation].[screenSettings].[videoMode] DESC")

Response Body

...

[int] id: A unique identifier for the file. This value is generated by the server when the file is uploaded.
[string] name: The filename
[string] path: The file URI on the server
[string] type: The file type, which can be "Media", "Stored" (i.e. non-media), or "Folder".
[int] size: The file size (in bytes)
[string] hash: The hash algorithm and the value that results from performing the hash algorithm on the file. The string is formatted as "{algorithm}:{value}" (e.g. "SHA1:6DB465879088280AAC52DC22B07ED0AD493A99D4").
[string] creationDate: A UTC timestamp indicating when the file was created. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
[string] lastModifiedDate: A UTC timestamp indicating when the file was last modified. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.

...

[string] videoMode: A video mode supported by the player model
[string] connector: A video output supported by the player model, which can be either "HDMI", "VGA", or "Component"
[string] orientation: The orientation of the presentation canvas, which can be either "Portrait" or "Landscape"
[string] backgroundColor: The background color of the presentation canvas. The color value is represented by the string “RGB: {R:XX}{G:XX}{B:XX)”, where “XX” is equivalent to a two-digit hexadecimal number (e.g. “RGB:4787C7”).
[string] overscan: The overscan display setting, which can be either "overscan", "overscanActionSafeArea", or "overscanTitleSafeArea"

...

[int] id: A unique identifier for the group
[string] name: The group name

...

POST

Posts a new presentation to the network.

Request Body

...

[string] videoMode: A video mode supported by the player model.
[string] connector: A video output supported by the player model, which can be either "HDMI", "VGA", or "Component"
[string] orientation: The orientation of the presentation canvas, which can be either "Portrait" or "Landscape"
[string] backgroundColor: The background color of the presentation canvas. The color value is represented by the string “RGB: {R:XX}{G:XX}{B:XX)”, where “XX” is equivalent to a two-digit hexadecimal number (e.g. “RGB:4787C7”).
[string] overscan: The overscan display setting, which can be either "Overscan", "OverscanActionSafeArea", or "OverscanTitleSafeArea"

...

[string] name: The filename
[string] type: The file type, which can be "Media", "Stored" (i.e. non-media), or "Folder".
[string] body: The file data as an encoded byte sequence.
[string] transferEncoding: The encoding scheme used to represent the file body. Currently accepted values are "Base64" and "None". If the value is "None" and the body is a JavaScript object rather than a string, the server will convert it to a string and store it as a JSON file.
[int] size: The file size (in bytes)
[string] creationDate: A UTC timestamp indicating when the file was created. The date/time should be formatted as yyyy-mm-ddThh:mm:ss.sssZ.
[string] lastModifiedDate: A UTC timestamp indicating when the file was last modified. The date/time should be formatted as yyyy-mm-ddThh:mm:ss.sssZ.

...

[PresentationContent[]] content: An array of PresentationContent object instances representing the zone playlist:

[int] contentId: A unique identifier for the Content instance
[int] id: A unique identifier for the PresentationContent instance, which represents the content file as it is implemented in the zone playlist
[string] name: The name of the content file
[string] stateName: The name of the playlist state that corresponds to the associated Content instance
[int] volume:(Audio/video files only) The volume of the audio/video file track, represented as an integer between 0 and 100
[string] displayDuration:(Image files only) The amount of time that the image will be displayed
[string] transition:(Image files only) The screen effect that is shown during transition between the previous presentation state and the current content state

...

[short] height: The height of the zone (in pixels)

Note

title	Note

Only a subset of the entries below must be specified, depending on the zone type. The associated zone types are listed for each entry.

...

Response Body

[int] id: A unique identifier for the Presentation instance.
[string] name: The presentation name
[string] type: The presentation type, which can be either "Simple" or "Complete" (see the endpoint overview above for more details).
[string] status: The authoring status of the Presentation entity. A "Draft" value indicates that the presentation is incomplete, lacking the autoplay-[PresentationName].xml or resources.txt file. A "Published" value indicates that the presentation has the necessary files to be published. This entry is applicable to complete presentations only.
[PresentationFile[]] files: An array of PresentationFile object instances. This entry is applicable to complete presentations only.
- [int] id: A unique identifier for the file. This value is generated by the server when the file is uploaded.
- [string] name: The filename
- [string] path: The file URI on the server
- [string] type: The file type, which can be "Media", "Stored" (i.e. non-media), or "Folder".
- [int] size: The file size (in bytes)
- [string] hash: The hash algorithm and the value that results from performing the hash algorithm on the file. The string is formatted as "{algorithm}:{value}" (e.g. "SHA1:6DB465879088280AAC52DC22B07ED0AD493A99D4").
- [string] creationDate: A UTC timestamp indicating when the file was created on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
- [string] lastModifiedDate: A UTC timestamp indicating when the file was last modified on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
[PresentationFile] autoplayFile: A PresentationFile object instance representing the autoplay XML file, which contains information related to presentation playback: states, zones, playlist data, etc. This entry is applicable to complete presentations only.
[PresentationFile] projectFile: A PresentationFile object instance representing the project file. This entry is applicable to complete presentations only.
[PresentationFile] resourcesFile: A PresentationFile object instance representing the resources file. This entry is applicable to complete presentations only.
[PresentationFile] userDefinedEventsFile: A PresentationFile object instance representing the user-defined events file. This entry is applicable to complete presentations only.
[string] creationDate: A UTC timestamp indicating when the presentation was created on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ
[string] lastModifiedDate: A UTC timestamp indicating when the presentation was last modified on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
[string] autorunVersion: The version of autorun used to create the presentation. If the presentation is authored via BSN APIs (i.e. a simple presentation), the autorun version is determined by the current standard autorun used by BSN. If the presentation was created on a client application and uploaded (i.e. a complete presentation), the autorun version is determined by the autorunVersion value specified with the POST/PUT request.
[string] deviceModel: The target BrightSign player model for the presentation.
[string] language: The target language of the presentation. This property currently has no effect on the operation of a presentation. The following are valid return values: "Unknown", "English", "French", "Italian", "German", "Spanish", "Swedish".
[ScreenSettings[]] screenSettings: An array of values indicating the screen settings of the presentation. This entry can also be Null for player models that do not support video output (i.e. the LS322).
- [string] videoMode: A video mode supported by the player model.
- [string] connector: A video output supported by the player model, which can be either "HDMI", "VGA", or "Component"
- [string] orientation: The orientation of the presentation canvas, which can be either "Portrait" or "Landscape"
- [string] backgroundColor: The background color of the presentation canvas. The color value is represented by the string “RGB: {R:XX}{G:XX}{B:XX)”, where “XX” is equivalent to a two-digit hexadecimal number (e.g. “RGB:4787C7”).
- [string] overscan: The overscan display setting, which can be either "overscan", "overscanActionSafeArea", or "overscanTitleSafeArea"
[Group[]] groups: An array of Group object instances representing groups that the presentation belongs to. Each Group instance can have the following values:
- [int] id: A unique identifier for the group
- [string] name: The group name
[Autorun[]] autorunPlugins: An array of Autorun object instances representing plugins attached to the presentation
[Permission[]] permissions: An array of Permission object instances representing permissions rules assigned to the presentation

DELETE

Removes a batch of presentations from the network.

Parameters

filter: An expression for filtering search results.

Response Body

The server returns code 200 upon success. Upon failure, it returns code 400 with an error message.

/presentations/count/

GET

Retrieves the number of presentations on the network matching the specified filter criteria. If no filter is included, this call returns the total number of presentations on the network.

Parameters

filter: An expression for filtering search results.

Response Body

The presentation count is returned as an integer value.

/presentations/operations/

GET

Returns Business Operations for presentations.

Response Body

[string] uid: A unique identifier for the Operation instance.
[string] singularName: The name of the operation in singular form. This value is useful for displaying in entity properties dialogs.
[string] pluralName: The name of the operation in plural form. This value is useful for displaying in User and Role properties dialogs.
[string] fullName: The name of the current operation along with its parent operations (if any). Since many operation names aren't unique, this value is useful for differentiating similar business operations.
[string] targetEntity: The object type affected by the operation (in this case, "Presentation")
[Operation{}] parent: An Operation instance indicating the operation from which permissions are inherited. This value will be Null if there is no parent operation.
[Operations[]] descendants: An array of Operation instances that inherit permissions from this operation. This value is Null if there are no descendant operations.
[Permissions[] permissions: An array of Permission instances indicating permissions associated with this operation

/presentations/{presentation_id||name}/

GET

Returns the Presentation instance with the specified ID or name.

Response Body

...

[int] id: A unique identifier for the file. This value is generated by the server when the file is uploaded.
[string] name: The filename
[string] path: The file URI on the server
[string] type: The file type, which can be "Media", "Stored" (i.e. non-media), or "Folder".
[int] size: The file size (in bytes)
[string] hash: The hash algorithm and the value that results from performing the hash algorithm on the file. The string is formatted as "{algorithm}:{value}" (e.g. "SHA1:6DB465879088280AAC52DC22B07ED0AD493A99D4").
[string] creationDate: A UTC timestamp indicating when the file was created. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
[string] lastModifiedDate: A UTC timestamp indicating when the file was last modified. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.

...

[string] videoMode: A video mode supported by the player model.
[string] connector: A video output supported by the player model, which can be either "HDMI", "VGA", or "Component"
[string] orientation: The orientation of the presentation canvas, which can be either "Portrait" or "Landscape"
[string] backgroundColor: The background color of the presentation canvas. The color value is represented by the string “RGB: {R:XX}{G:XX}{B:XX)”, where “XX” is equivalent to a two-digit hexadecimal number (e.g. “RGB:4787C7”).
[string] overscan: The overscan display setting, which can be either "overscan", "overscanActionSafeArea", or "overscanTitleSafeArea"

...

[PresentationContent[]] content: An array of PresentationContent object instances representing the zone playlist:

[int] contentId: A unique identifier for the Content instance
[int] id: A unique identifier for the PresentationContent instance, which represents the content file as it is implemented in the zone playlist
[string] name: The name of the content file
[string] stateName: The name of the playlist state that corresponds to the associated Content instance
[int] volume:(Audio/video files only) The volume of the audio/video file track, represented as an integer between 0 and 100
[string] displayDuration:(Image files only) The amount of time that the image will be displayed
[string] transition:(Image files only) The screen effect that is shown during transition between the previous presentation state and the current content state

...

[short] height: The height of the zone (in pixels)

Note

title	Note

Only a subset of the entries below will be returned, depending on the zone type. The associated zone types are listed for each entry.

...

[int] id: A unique identifier for the group
[string] name: The group name

...

PUT

Modifies the specified Presentation instance using the entries in the request body. PUT requests require a minimum set of entries; the required entries are noted below.

Note

title	Note

The deviceModel value cannot be modified after a Presentation instance is created.

Request Body

...

[string] videoMode: A video mode supported by the player model.
[string] connector: A video output supported by the player model, which can be either "HDMI", "VGA", or "Component"
[string] orientation: The orientation of the presentation canvas, which can be either "Portrait" or "Landscape"
[string] backgroundColor: The background color of the presentation canvas. The color value is represented by the string “RGB: {R:XX}{G:XX}{B:XX)”, where “XX” is equivalent to a two-digit hexadecimal number (e.g. “RGB:4787C7”).
[string] overscan: The overscan display setting, which can be either "Overscan", "OverscanActionSafeArea", or "OverscanTitleSafeArea"

...

[string] name: The filename
[string] type: The file type, which can be "Media", "Stored" (i.e. non-media), or "Folder".
[string] body: The file data as an encoded byte sequence.
[string] transferEncoding: The encoding scheme used to represent the file body. Currently accepted values are "Base64" and "None". If the value is "None" and the body is a JavaScript object rather than a string, the server will convert it to a string and store it as a JSON file.
[int] size: The file size (in bytes)
[string] creationDate: A UTC timestamp indicating when the file was created. The date/time should be formatted as yyyy-mm-ddThh:mm:ss.sssZ.
[string] lastModifiedDate: A UTC timestamp indicating when the file was last modified. The date/time should be formatted as yyyy-mm-ddThh:mm:ss.sssZ.

...

[PresentationContent[]] content: An array of PresentationContent object instances representing the zone playlist:

[int] contentId: A unique identifier for the Content instance
[int] id: A unique identifier for the PresentationContent instance, which represents the content file as it is implemented in the zone playlist

[string] name: The name of the content file
[string] stateName: The name of the playlist state that corresponds to the associated Content instance
[int] volume:(Audio/video files only) The volume of the audio/video file track, represented as an integer between 0 and 100
[string] displayDuration:(Image files only) The amount of time that the image will be displayed
[string] transition:(Image files only) The screen effect that is shown during transition between the previous presentation state and the current content state

...

[short] height: The height of the zone (in pixels)

Note

title	Note

Only a subset of the entries below must be specified, depending on the zone type. The associated zone types are listed for each entry.

...

DELETE

Removes the specified presentation from the network.

Response Body

The server returns code 200 upon success. Upon failure, it returns code 400 with an error messageThese endpoints allow for creation, modification, and retrieval of presentation objects.

Base URL for these endpoints: https://api.brightsignnetwork.com/2017/01/REST/Presentations

GET /

Retrieves a list of presentations on the network.

Parameters

filter string

An expression for filtering search results

sort string

An expression for sorting the search results. The sort expression specifies the entry used for sorting and the ascending/descending (ASC/DESC) sorting order (e.g. "[Device].[Serial] ASC")

marker string

A value specifying which page to retrieve. This value is useful if the isTruncated entry in the response body of the previous GET call indicates that the number of presentations exceeds the pageSize.

pageSize int

The maximum number of presentations that can be contained in the response body

______________________________________________________________

Response Body

Returns a paged list of Presentation Entity instances on a network. This will return not more than 100 entities along with the information necessary to return any other remaining pages.

POST /

Creates a new presentation on the network.

Request Body

The Presentation Entity

______________________________________________________________

Response Body

Returns a 201 status code and the new resource created and referenced by the Uri (given by the Location header field) in the response. The response includes the Presentation Entity .

DELETE /

Removes presentations, specified by a filter, from a network. This allows multiple presentations to be deleted at once.

Parameters

filter string

An expression for filtering search results

______________________________________________________________

Response Body

Returns the number of affected presentations as an integer value.

GET /Count/

Retrieves the number of presentations on the network matching the specified filter criteria. If no filter is included, this call returns the total number of presentations on the network.

Parameters

filter string

An expression for filtering search results

______________________________________________________________

Response Body

The presentation count is returned as an integer value.

GET /Operations/

Returns the operational permissions granted to roles for specific business operations

Response Body

Returns the Business Operations Entity

GET /{id:int}/

Returns the presentation instance with the specified id.

Parameters

id int

A unique identifier for the presentation instance

______________________________________________________________

Response Body

Returns the Presentation Entity

PUT /{id:int}/

Modifies the specified presentation instance.

Parameters

id int

A unique identifier for the presentation instance

______________________________________________________________

Request Body

The Presentation Entity

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

DELETE /{id:int}/

Removes the specified presentation from the network.

Parameters

id int

A unique identifier for the presentation instance

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns code 400 with an error message.

GET /{name}/

Returns the presentation instance with the specified name.

Parameters

name string

The name of the presentation instance

______________________________________________________________

Response Body

Returns the Presentation Entity

PUT /{name}/

Modifies the specified presentation instance.

Parameters

name string

The name of the presentation instance

______________________________________________________________

Request Body

The Presentation Entity

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

DELETE /{name}/

Removes the specified presentation from the network.

Parameters

name string

The name of the presentation instance

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns code 400 with an error message.

GET /{id:int}/Permissions/

Includes object permissions for a given presentation instance.

Parameters

id int

A unique identifier for the presentation instance

______________________________________________________________

Response Body

Returns the Permission Entity

POST /{id:int}/Permissions/

Adds permissions for the specified presentation instance.

Parameters

id int

A unique identifier for the presentation instance

______________________________________________________________

Request Body

The Permission Entity

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

DELETE /{id:int}/Permissions/

Removes permissions for the specified presentation instance.

Parameters

id int

A unique identifier for the presentation instance

______________________________________________________________

Request Body

The Permission Entity

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

GET /{name}/Permissions/

Includes object permissions for a given presentation instance.

Parameters

name string

The name of the presentation instance

______________________________________________________________

Response Body

Returns the Permission Entity

POST /{name}/Permissions/

Adds permissions for the specified presentation instance.

Parameters

name string

The name of the presentation instance

______________________________________________________________

Request Body

The Permission Entity

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

DELETE /{name}/Permissions/

Removes permissions for the specified presentation instance.

Parameters

name string

The name of the presentation instance

______________________________________________________________

Request Body

The Permission Entity

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

Page Comparison

Versions Compared

Old Version 32

New Version Current

Key

/presentations/

GET

URL Parameters

Response Body

POST

Request Body

Response Body

DELETE

Parameters

Response Body

/presentations/count/

GET

Parameters

Response Body

/presentations/operations/

GET

Response Body

/presentations/{presentation_id||name}/

GET

Response Body

PUT

Request Body

DELETE

Response Body

GET /

POST /

DELETE /

GET /Count/

GET /Operations/

GET /{id:int}/

PUT /{id:int}/

DELETE /{id:int}/

GET /{name}/

PUT /{name}/

DELETE /{name}/

GET /{id:int}/Permissions/

POST /{id:int}/Permissions/

DELETE /{id:int}/Permissions/

GET /{name}/Permissions/

POST /{name}/Permissions/

DELETE /{name}/Permissions/