Manually triggering content export

Request

To manually trigger content export from Content Exporter (CEX), send a GET request to:

https://<host>:<port>/exportcex/admin/v1/export/{type}/{scope}

This API supports delta export, but for VOD only. Live export supports export for a specified date range – see Live export.

Headers

• Content-Type: application/json

Mandatory arguments

• type – the type of export. Either full or delta. (delta is only valid when scope is VOD.)
  

• scope – which type of entity to export. Either live or VOD.

Other arguments

• contentProvider – the name of the folder containing the Algorithm Parameter Set (APS) properties file (in query params). If not specified, the default folder is used.

• propFile – the name of the Algorithm Parameter Set (APS) properties file (in query params). This file can contain multiple blocks, which means that you can have a single file for full VOD export, delta VOD export, and live export.
  The parameters that can be used in this file are as follows:
  
  • autoStartUp – always set to true.
    
  • destinationFolder – the SFTP location (URI) to which the export file(s) are saved
  • xmlValidationFileBeforeTransformation – the name of the XSD file to be used to validate the input, For example, Nagravision-Vod-Unified-Export-Specification-v5.x.xsd.
  • xmlValidationFileAfterTransformation – the name of the XSD file to be used to validate the output. For example, Export-Full-CMS-COD-Interface-v4.20.xsd.
    
  • xslTransformationFiles – the files specifying the XSLT transformations to be applied. For example, Unified_VOD_Export-5.x_To_4.20.xslt.
  • cron – the cron expression that specifies when and how often the export should be performed. This is not used for manually triggered exports.
    
  • ftpStepWiseMode – always set to false.
  • rootNodeIds (VOD export only) – the IDs of the root catalogue nodes for which the export is to be performed (comma-delimited).
  • exportFileName – the name of the exported file. This should always be set to one of the following, depending on the type of export:
    
    • VOD delta export – Export-Delta-Vod-{ROOTNODEID}-{FILENUMBER}-{TIMESTAMP}.xml
    • Full VOD export – ExportVod-{ROOTNODEID}-{FILENUMBER}-{TIMESTAMP}.xml
    • Full live export – ExportBtv-{CHANNELID}-{TIMESTAMP}.xml
  • isNotificationEnabled – whether notification is enabled. Always set to true.
  • globalProviderId – the provider name. This must be the same as in CPM.
  • cmsDataModel – the CMS data model that is being used. Either technicalModel or editorialModel.
  • maxParallelRequests (VOD only) – the maximum number of parallel requests. Recommended value: 5.
  • statusPerExportContext – set as follows:
    
    • For VOD: vod_export-1 
    • For live: live_export-1

Example

This GET request triggers a VOD delta export using the specified APS file:

https://<host>:<port>/exportcex/admin/v1/export/delta/vod??contentProvider=contentProvider1&propFile=delta_vod_APS1.properties

Response

A successful request returns an HTTP 202 status.

If an export for the specified scope is already running, it returns an HTTP 409 status.

See also

For full details of this API, see Content Exporter (CEX) API documentation v1.