Post
/v{version}/Content/Upload/Spot/Initialize
This is the first step of uploading a spot to the server.
Security
API Key: api_key
Header parameter nameX-ApiKey
Api Key
API Key: session_id
Header parameter nameX-Session-Id
Session Id
Path parameters
version
stringRequired
The requested API version
Default"1.19"
Body parameters
Spot upload initialization request
object
Request model for initializing a new spot upload
AllowVariants
boolean
If true, the creation of variant is allowed.
Default: false.
DisplayName
string Required
Display name of the spot
Duration
integer (int32)
Duration of the spot in seconds
FileName
string Required
File name of the spot
FileSize
integer (int64) Required
Size of the spot in bytes
LocationId
integer (int32)
Unique ID of the location assigned to the spot
PlayerId
integer (int32)
Unique ID of the player assigned to the spot
SpotGroupId
integer (int32)
Unique ID of the spot group where the spot is placed in
SpotType
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"
]
Responses
200
OK
string (uuid)
Example00000000-0000-0000-0000-000000000000
400
Bad request
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403
Forbidden
500
Unexpected error
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties