Show Menu
TOPICS×

ExportJob

Job type to allow authorized export of previously uploaded files.
ExportJob does not support the following asset types:
  • Image Sets
  • Render Sets
  • Spin Sets
  • Media Sets
  • Multi-bitrate Sets
  • Video Sets
  • eCatalogs
  • Offer Sets
Name Type Description
assetHandleArray
types:HandleArray
List of assetHandle which are required to be exported. See HandleArray .
fmt
xsd:string
Specifies the type of export.Possible Values : [orig, convert]
  • If fmt=orig , the assets are exported as original
  • If fmt=convert , the assets are converted to the format specified in the is_modifer or macro input parameters
is_modifier
xsd:string
Specifies the ImageServer rendering URL string, which is appended to the ExportJob convert request.
Refer to the IS documentation for details about sending the IS modifiers.
macro
xsd:string
emailSetting
xsd:string
Choice of email setting. Possible values:
  • All
  • Error
  • ErrorAndWarning
  • JobCompletion
  • None
clientId
xsd:string
Specifies the IP address of the client or customer who initiated the export request.
Note: this parameter is not actively populated currently and is strictly reserved for future usage only.
For ExportJob requests where fmt=convert and both is_modifier and macro are provided, the destination file respects the format provided by macro . For example:
input_file = fileToExport.jpg
is_modifer = &fmt=png
macro=$test$ 
output_file = fileToExport.tiff