Exports

An item export is the process of copying a file from storage to a location accessible by the system.

Create export jobs

Start an export job for a single item

POST /item/(item-id)/export

Creates a new export job that will copy a file to a remote location.

Query Parameters:
 
  • uri – A URI to the destination of the file.
  • locationName – (New in 4.0.) The name of an Export Location (see Export locations )
  • tag – Finds a shape with the specified tag and uses that for export. If not specified, the system will attempt to use the original shape.
  • metadata
    • true - Metadata will also be exported to side-car XML file.
    • false (default) - No metadata is exported.
  • projection – Defines the projection to use when exporting the metadata (optional).
  • start – Defines a start Time codes for the media (optional).
  • end – Defines an end Time codes for the media (optional).
  • notification – See Notifications . (Optional)
  • notificationData – See Notifications . (Optional)
  • priority – The priority to assign to the job. Default is MEDIUM .
  • jobmetadata – Additional information for the job task. See Special job metadata values
  • useOriginalFilename – If set to true, the file(s) will be exported with their original filename if available.
  • template – Optional Export Template to use (see Export Templates).
  • allowMissing
    • true (default) - Job will be started and the missing files will be ignored.
    • false - Job will fail if there are missing files and the files could not be generated by transcoding. A shape tag should be specified.
Produces-xml-json:
 

JobDocument

Role:

_export

Semantics

Creates a new export job that will copy a file to a remote location. A shape tag can be specified to decide which shape that will be exported. If the URI ends with a “/” the URI is assumed to describe a folder and the file will retain its existing filename. Otherwise it is assumed that the URI describes a file and that filename will be used.

Note

FTP active mode

New in version 4.1.2.

For FTP exports, active mode can be forced by adding ?passive=false to the FTP URL. To set the client side ports used in active mode, set the configuration property ftpActiveModePortRange, the value should be a range, e.g. 42100-42200. To set the client IP used in active mode, set the configuration property ftpActiveModeIp.

Note

XMP rewrite

New in version 4.1.4.

By using the jobmetadata query parameter with rewriteXMP=false (remember to URL encode the =), any XMP metadata in the source file will not be updated with the XMP metadata of the item.

Example

Create a new export job that transfers the file of a shape with the tag flv.

POST /item/VX-250/export?tag=flv&uri=file:/home/user/video/myvideo.flv
<JobDocument xmlns="http://xml.vidispine.com/schema/vidispine">
   <jobId>VX-1293</jobId>
   <user>admin</user>
   <started>2010-05-07T14:05:51.826+02:00</started>
   <status>READY</status>
   <type>EXPORT</type>
   <priority>MEDIUM</priority>
</JobDocument>

Start an export job for a single shape

New in version 4.1.2.

POST /item/(item-id)/shape/(shape-id)/export

Create export job for shape.

Query Parameters:
 
  • uri – A URI to the destination of the file.
  • locationName – (New in 4.0.) The name of an Export Location (see Export locations )
  • tag – Finds a shape with the specified tag and uses that for export. If not specified, the system will attempt to use the original shape.
  • metadata
    • true - Metadata will also be exported to side-car XML file.
    • false (default) - No metadata is exported.
  • projection – Defines the projection to use when exporting the metadata (optional).
  • start – Defines a start Time codes for the media (optional).
  • end – Defines an end Time codes for the media (optional).
  • notification – See Notifications . (Optional)
  • notificationData – See Notifications . (Optional)
  • priority – The priority to assign to the job. Default is MEDIUM .
  • jobmetadata – Additional information for the job task. See Special job metadata values
  • useOriginalFilename – If set to true, the file(s) will be exported with their original filename if available.
  • template – Optional Export Template to use (see Export Templates).
  • allowMissing
    • true (default) - Job will be started and the missing files will be ignored.
    • false - Job won’t be started if there are missing files.
Produces-xml-json:
 

JobDocument

Role:

_export

Semantics

Creates a new export job that will copy a file from the specified shape to a remote location. If the URI ends with a “/” the URI is assumed to describe a folder and the file will retain its existing filename. Otherwise it is assumed that the URI describes a file and that filename will be used.

Start an export job for a collection or a library

POST /collection/(collection-id)/export
POST /library/(library-id)/export

Create export job for collection or library.

Query Parameters:
 
  • uri – A URI to the destination of the file.
  • locationName – (New in 4.0.) The name of an Export Location (see Export locations )
  • tag – Finds a shape with the specified tag and uses that for export. If not specified, the system will attempt to use the original shape.
  • metadata
    • true - Metadata will also be exported to side-car XML file.
    • false (default) - No metadata is exported.
  • projection – Defines the projection to use when exporting the metadata (optional).
  • start – Defines a start Time codes for the media (optional).
  • end – Defines an end Time codes for the media (optional).
  • notification – See Notifications . (Optional)
  • notificationData – See Notifications . (Optional)
  • priority – The priority to assign to the job. Default is MEDIUM .
  • jobmetadata – Additional information for the job task. See Special job metadata values
  • useOriginalFilename – If set to true, the file(s) will be exported with their original filename if available.
  • template – Optional Export Template to use (see Export Templates).
Produces-xml-json:
 

JobDocument

Role:

_export

Semantics

Creates a new export job that will copy all matching files in the collection/library to a remote location. A shape tag can be specified to decide which shapes that will be exported. The files will retain their original names and the URI should therefore point to the folder where the files should be placed.

Example

Create a new export job that transfers files in a certain collection that has shapes with the tag flv.

POST /collection/VX-10/export?tag=flv&uri=file:/home/user/video/
<JobDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <jobId>VX-1334</jobId>
  <user>admin</user>
  <started>2010-05-24T14:53:12.732+02:00</started>
  <status>READY</status>
  <type>EXPORT</type>
  <priority>MEDIUM</priority>
</JobDocument>