Uses getActiveJobs to track desktop uploads.
Name
Type
Required?
Description
autoColorCropOptions
types:AutoColorCropOptions
No
Options for automatic crops of images based on color.
autoSetCreationOptions
types:AutoSetCreateOptions
No
Array of automatic set generation scripts to apply to uploaded files.
autoTransparentCropOptions
types:AutoTransparentCropOptions
No
Removes white space from the edges of images, based on transparency.
colorManagementOptions
types:ColorManagementOptions
No
Options that you can specify during an upload. The set affects how the color is managed for the upload.
createMask
xsd:boolean
Yes
Whether to create a mask.
emailSetting
xsd:string
Yes
Choice of email settings.
inDesignOptions
types:InDesignOptions
No
Options for uploading InDesign files to the Image Server.
IllustratorOptions
types:IllustratorOptions
No
Options for uploading Illustrator files to the Image Server.
knockoutBackground
types:KnockoutBackgroundOptions
No
Mask the background for selected images. This lets you overlay them in other layers with a transparency outside of subject image. Optional.
See KnockoutBackgroundOptions.
manualCropOptions
types:ManualCropOptions
No
Options for manual crops of images.
mediaOptions
types:MediaOptions
No
Options that let you set a thumbnail image from the video.
See MediaOptions.
overwrite
xsd:boolean
Yes
Whether to overwrite files when uploading.
pdfOptions
types:PDFOptions
No
Options for uploading PDF files to the Image Server.
photoshopOptions
types:PhotoshopOptions
No
Options for uploading Photoshop files to the Image Server.
postHttpUrl
xsd:string
No
The URL where the files are being uploaded.
postScriptOptions
types:PostScriptOptions
No
Options for uploading Post Script files to the Image Server.
preserveCrop
xsd:boolean
No
Controls preservation of any existing crop definition. Default is true.
If you provide the manualCropOptions parameter and corresponding values, then the new values (excluding 0,0,0,0) are applied to the asset regardless of the preserveCrop value.
If you do not provide the manualCropOptions parameter, the value of preserveCrop is maintained. And, in case of true, the existing preserveCrop values are retained; in case of false, the preserveCrop values are removed.
Example:
<preserveCrop>false</preserveCrop>
<manualCropOptions>
  <left>190</left>
  <right>310</right>
  <top>160</top>
  <bottom>120</bottom>
</manualCropOptions>
preservePublishState
xsd:boolean
Yes
Controls whether the publish state of an existing asset is preserved when overwriting. If not set, the company default setting is used.
projectHandleArray
types:HandleArray
No
Array of project handles.
readyForPublish
xsd:boolean
Yes
Whether the files are marked ready for publishing.
unCompressOptions
types:UnCompressOptions
No
Extract and process the contents of uploaded TAR/ZIP files with these optional settings.
See UnCompressOptions.
unsharpMaskOptions
types:UnsharpMaskOptions
No
Options that let you control unsharp mask settings when creating an optimized pyramid TIF file. Use these settings to help improve image sharpness.
See UnsharpMaskOptions.
xmpKeywords
xsd:string
No
An additional metadata option for everything in the upload job.