Export locations¶
New in version 4.0.
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¶
Listing available export locations¶
-
GET
/export-location
¶ List all defined export locations.
Produces: - application/xml, application/json – ExportLocationListDocument
Role: _export
Creating/updating 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">
<uri>ftp://user:password@10.2.23.25/export/</uri>
</ExportLocationDocument>
Get information about 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
Deleting an export location¶
-
DELETE
/export-location/
(location-name)¶ Delete the export location with the specified name.
Role: _export
Export location script¶
Get 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