Export locations¶

It is possible to pre-define named export locations. When starting an export job, the location name can be passed as a parameter, the files will then be exported to the URI associated with the export location.

Managing export locations
Export location script
- Retrieve the export location script
- Update the export location script
Key-value metadata

Managing export locations ¶

List all export locations ¶

GET /export-location¶

List all defined export locations.

Produces:	application/xml, application/json – ExportLocationListDocument
Role:	_export

Update or create an export location ¶

PUT /export-location/(location-name)¶

Create a new export location, or if there already is one with that name, update it.

Accepts:	application/xml, application/json – ExportLocationDocument
Produces:	application/xml, application/json – ExportLocationDocument
Role:	_export

Example¶

Creating a new export location:

PUT /export-location/External_FTP
Content-Type: application/xml

<ExportLocationDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <method>
    <uri>ftp://user:password@10.2.23.25/export/</uri>
  </method>
</ExportLocationDocument>

New in version 25.2.

To add an export location on a VSA, set the vxaLocalPath value to the local path as reachable by the VSA.

PUT /export-location/External_FTP
Content-Type: application/xml

<ExportLocationDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <method>
    <uri>vxa://6EA7DC4E-92E2-4DDC-990E-4ADAAB958852/share1/</uri>
    <vxaLocalPath>/mnt/srv/export</vxaLocalPath>
  </method>
</ExportLocationDocument>

Deprecated since version 25.2.

Prior to version 25.2 you could specify the export location method URI in the uri value. This is deprecated and still supported but does not allow you to configure export locations on VSAs.

Please note that the uri value is returned for backwards compatiblity, but is ignored on POST and PUT when the method element is present.

PUT /export-location/External_FTP
Content-Type: application/xml

<ExportLocationDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <uri>ftp://user:password@10.2.23.25/export/</uri>
</ExportLocationDocument>

Retrieve an export location ¶

GET /export-location/(location-name)¶

Return information about the export location with the specified name.

Produces:	application/xml, application/json – ExportLocationDocument
Role:	_export

Delete an export location ¶

DELETE /export-location/(location-name)¶

Delete the export location with the specified name.

Role:	_export

Export location script ¶

Retrieve the export location script ¶

GET /export-location/(location-name)/script¶

Retrieves the script on an export location.

Status Codes:	404 Not found – If the location has no script.
Produces:	text/plain –
Role:	_export

Update the export location script ¶

PUT /export-location/(location-name)/script¶

Updates the script of an existing export location.

Accepts:	text/plain –
Produces:	text/plain – The script that was set.
Role:	_export

Key-value metadata ¶

Export locations support key-value metadata.