Use the /sapi/publication endpoint to manage the publication configuration. An Online Video Platform (OVP) publication represents a set of video content and account settings, and provides an interface to the publication configuration, including custom metadata fields, CDN configuration, and miscellaneous key/value pairs.
Clients are able to manage multiple publications, but in most cases only manage one.
1.0 | Publication Object
1.1 | Example Publication Object
{
"id": "754",
"status": "active",
"type": "Publication",
"publisherid": "1",
"name": "yourcompanyname",
"label": "Your Company Name",
"baseurl": "//yourcompanyname.bbvms.com",
"baseuri": "/yourcompanyname/media",
"sourcepath": "/data/content/video/yourcompanyname/source",
"statspublication": "yourcompanyname",
"defaultMediaAssetPath": "https://d2lkpb6s11d5s3.cloudfront.net",
"logo": "/publications/yourcompanyname/yourLogo.png",
"defaultTimeZone": "Europe/Amsterdam",
"timeZone": "Europe/Amsterdam",
"reactTitle": "Your Company Name",
"reactLogoId": "4393687",
"reactHighlight": "fdac3f",
"customfields": {
"mediaclip": [
{
"name": "textfield",
"type": "string",
"itype": "string",
"label": "Textfield",
"priority": null,
"public": true,
"dataSource": null,
"dataSourceReturnTypes": null,
"content": "",
"extendable": false,
"visible": false,
"includeInStats": false
},
{
"name": "extra_description",
"type": "text",
"itype": "text",
"label": "Extra Description",
"priority": null,
"public": true,
"dataSource": null,
"dataSourceReturnTypes": null,
"content": "",
"extendable": false,
"visible": false,
"includeInStats": false
},
{
"name": "internal",
"type": "boolean",
"itype": "checkbox",
"label": "Internal Use Only",
"priority": null,
"public": true,
"dataSource": null,
"dataSourceReturnTypes": null,
"content": "",
"extendable": false,
"visible": false,
"includeInStats": false
}
]
},
"supportedMediaTypes": {
"video": ["MP4_IPOD", "MP4_MAIN", "MP4_HD", "MP4_HLS"],
"audio": ["AAC", "MP3", "WMA", "OGG"],
"document": ["jsonData", "EXCEL"]
},
"sharingPublications": [],
"reservedFieldnames": [
"type",
"title",
"description",
"author",
"copyright",
"deeplink",
"id",
"cat",
"useType",
"sourceType"
]
}1.2 | Attributes
It is beyond the scope of this documentation to discuss every property. Some of the basic properties:
| Property | Description |
|---|---|
| defaultMediaAssetPath | The base URL for all hosted on-demand media. |
| customfields | If configured for your publication, the custom metadata fields are listed here. |
| timeZone | Time zone setting for your publication. Used in reports and analytics. |
2.0 | Create/Update
Sending a request with the contents of the specified field name in the payload will update that field in the publication configuration.
It is often neither necessary nor useful to dynamically configure the publication settings. Please contact support for advice.
3.0 | Retrieve
Responds with a full configuration dump for the current publication.
Retrieves one specific configuration property.
Example:
Returns the base URL for on-demand media.
4.0 | Delete
Permanently removes a configuration field from the current publication.
It is not often necessary or even useful to remove publication settings yourself. Please contact support for advice.