Get a list of media

  • Published on Jan 24, 2025
  • 1 minute(s) reading time
Prev Next
Get
/v{version}/Media

Media are implicitly filtered by effective spot groups and SOC tags.

Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
version
stringRequired

The requested API version

Default"1.18"
Responses
200

OK

Array of object
object

Media

ActiveVersion
object (V1.Models.MediaVersion)

Version of the media

Duration
integer (int32)

Duration of the media version in seconds

FileName
string

File name of the media version

FileVersion
integer (int32)

File version of the media version

UserCreateDate
string (date-time)

Creation date of the media version

Version
integer (int32)

Version of the media version

VersionId
integer (int32)

Unique ID of the media version

AllowArchiving
boolean

If true, the media allows archiving. Default: false.

Created
string (date-time)

Creation date in UTC

DraftVersion
object (V1.Models.MediaVersion)

Version of the media

Duration
integer (int32)

Duration of the media version in seconds

FileName
string

File name of the media version

FileVersion
integer (int32)

File version of the media version

UserCreateDate
string (date-time)

Creation date of the media version

Version
integer (int32)

Version of the media version

VersionId
integer (int32)

Unique ID of the media version

Id
integer (int32)

Unique ID of the media

IsArchived
boolean

If true, the media is archived. Default: false.

LocationId
integer (int32)

Unique ID of the location assigned to the media

MediaGroupId
integer (int32)

Unique ID of the media group containing the media

MediaType
string

Type of the media

Valid values[ "Unknown", "Video", "Flash", "Picture", "PowerPoint", "Pdf", "Shockwave", "Xml", "Mp3", "Html", "EPaper", "Draft", "Zip", "AndroidPackage", "AndroidSkin", "OverlayTrigger", "Qml" ]
Modified
string (date-time)

Modification date in UTC

Name
string

Name of the media

PlayerId
integer (int32)

Unique ID of the player assigned to the media

Type
string

Type of the spot

Valid values[ "Default", "Composer", "Trigger", "Ticker", "Url", "OverlayTrigger", "XmlDataSpot", "Audio", "Stream", "Zip", "WebsiteSpot", "HtmlComposerSpot", "WizardSpot", "Font", "WizardSpotMedia", "DashboardWidget", "DashboardWidgetMedia", "Qml", "ComposerPlayer", "RoomManager", "ConvertedSpot", "AscInterface", "AscPlayer" ]
400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403

Access denied

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties