/sapi/publication

A Blue Billywig Online Video Platform publication represents a set of video content and settings for one customer, website or playout platform. It’s accessible via a dedicated host name that’s typically in the format “PUBLICATION.bbvms.com”.

The /sapi/publication endpoint provides an interface to the Publication configuration:

• Custom metadata fields
• CDN configuration
• Miscellaneous key/value pairs

1.0 | Object structure

The below structure is a JSON representation of a Publication object. It’s beyond the scope of this documentation to discuss every property, so here are some basics:

defaultMediaAssetPath: the base URL for all hosted on demand media

customFields: if available for your publication the configured fields are shown here.

timeZone: Time zone setting for your publication. Used in reports and analytics.

{
id: "325",
status: "active",
type: "Publication",
publisherid: "5",
name: "ovp",
label: "Online Video Platform",
baseurl: "//ovp.bbvms.com",
baseuri: "/ovp/media",
sourcepath: "/data/content/video/ovp/source",
hascmsystems: "true",
statsserver: "http://ovp.bbvms.com/Stats/",
statspublication: "ovp",
defaultMediaAssetPath: "//d736l0py1kx0s.cloudfront.net",
disablePositions: "false",
logo: "/publications/ovp/1407417683609224.jpg",
vmsjs: "true",
forceOVP6: "true",
timeZone: "Europe/Amsterdam",
customfields:
{
mediaclip: [ ],
mediacliplist: [ ],
banner: [ ]
},
postupdate: [ ],
zoneconfig: [ ],
supportedMediaTypes:
{
video:
[
"MP4_IPOD",
"MP4_MAIN",
"MP4_HD",
"MP4_TIMELINE",
"IMAGESEQUENCE",
"MP4_3GP",
"MP4_HLS",
"WEBM",
"FLV_VP6",
"MPEG2",
"MP2_TS"
],
audio:
[
"AAC",
"MP3",
"WMA",
"OGG"
],
document:
[
"jsonData",
"EXCEL"
]
},
sharingPublications: [ ]
}

PUT /sapi/publication/FIELDNAME

With the contents of said FIELDNAME in the payload of the request will update the requested field in the Publication configuration.

3.0 | Retrieve

GET /sapi/publication

Will respond with a configuration dump for the current publication.

GET /sapi/publication/FIELDNAME

Will retrieve one specific configuration property

Example:

GET /sapi/publication/defaultMediaAssetPath

Will get the base URL for on demand media.

4.0 | Delete

DELETE /sapi/publication/FIELDNAME

Permanently remove a configuration field from the current publication.