Adobe® Experience Cloud

IPS API
 Contents

About Scene7 Image Production System API...............................................................17

Deprecated calls.............................................................................................................18

IPS Web Service WSDL versions....................................................................................19

Operations methods......................................................................................................24
Operation parameters...................................................................................................................................................26
addCompany..............................................................................................................................................................................................26
addCompanyMembership....................................................................................................................................................................27
addGroupMembers..................................................................................................................................................................................28
addGroupMembership...........................................................................................................................................................................28
addProjectAssets.......................................................................................................................................................................................29
addTagFieldValues...................................................................................................................................................................................31
addUser........................................................................................................................................................................................................31
batchGetAssetPublishContexts...........................................................................................................................................................33
batchSetAssetMetadata.........................................................................................................................................................................34
batchSetFontFields..................................................................................................................................................................................36
batchSetIccProfileFields.........................................................................................................................................................................37
batchSetImageFields...............................................................................................................................................................................39
batchSetThumbAsset..............................................................................................................................................................................40
cdnCacheInvalidation.............................................................................................................................................................................42
checkAssetNames.....................................................................................................................................................................................43
checkLogin..................................................................................................................................................................................................44
copyImage...................................................................................................................................................................................................45
createAssetSet...........................................................................................................................................................................................47
createDerivedAsset..................................................................................................................................................................................48
createFolder................................................................................................................................................................................................50
createImageSet..........................................................................................................................................................................................51
createMetadataField................................................................................................................................................................................52

Last updated 2/27/2019 IPS API

 Contents

createProject..............................................................................................................................................................................................54
createPropertySet.....................................................................................................................................................................................55
createPropertySetType...........................................................................................................................................................................56
createTemplate..........................................................................................................................................................................................57
createViewerPreset..................................................................................................................................................................................58
createVignettePublishFormat..............................................................................................................................................................59
deleteAsset..................................................................................................................................................................................................62
deleteAssets................................................................................................................................................................................................63
deleteAssetMetadata..............................................................................................................................................................................65
deleteFolder................................................................................................................................................................................................66
deleteGroup................................................................................................................................................................................................67
deleteImageFormat.................................................................................................................................................................................67
deleteImageMap.......................................................................................................................................................................................68
deleteJob.....................................................................................................................................................................................................69
deleteMetadataField...............................................................................................................................................................................70
deleteProject..............................................................................................................................................................................................71
deletePropertySet.....................................................................................................................................................................................71
deletePropertySetType...........................................................................................................................................................................72
deleteTagFieldValues..............................................................................................................................................................................73
deleteVignettePublishFormat..............................................................................................................................................................74
deleteZoomTarget...................................................................................................................................................................................74
emptyAssetsFromTrash..........................................................................................................................................................................75
executeJob..................................................................................................................................................................................................77
forceRepublishAssets..............................................................................................................................................................................78
generatePassword....................................................................................................................................................................................79
getActiveJobs.............................................................................................................................................................................................79
getActivePublishContext.......................................................................................................................................................................80
getAllCompanies......................................................................................................................................................................................81
getAllUsers..................................................................................................................................................................................................82
getAssetCounts.........................................................................................................................................................................................83
getAssetJobLogs.......................................................................................................................................................................................84
getAssetMetadataFields.........................................................................................................................................................................85
getAssetPublishHistory..........................................................................................................................................................................86
getAssets......................................................................................................................................................................................................87

Last updated 2/27/2019 IPS API

 getAssetsByName.....................................................................................................................................................................................88
getAssociatedAssets................................................................................................................................................................................90
getAutoCropRect......................................................................................................................................................................................94
getCompanyInfo.......................................................................................................................................................................................95
getCompanyMembers............................................................................................................................................................................96
getCompanyMembership.....................................................................................................................................................................97
getCompanySettings..............................................................................................................................................................................98
getDiskUsage.............................................................................................................................................................................................99
getDistinctMetadataValues................................................................................................................................................................100
getFolders.................................................................................................................................................................................................102
getFolderTree..........................................................................................................................................................................................103
getGenerationInfo.................................................................................................................................................................................106
getGroupMembers................................................................................................................................................................................107
getGroupMembership..........................................................................................................................................................................108
getGroups.................................................................................................................................................................................................109
getImageFormats...................................................................................................................................................................................109
getImageRenderingPublishSettings...............................................................................................................................................110
getImageServingPublishSettings.....................................................................................................................................................111
getImageSetMembers..........................................................................................................................................................................111
getJobLogs...............................................................................................................................................................................................112
getJobLogDetails...................................................................................................................................................................................114
getMetadataFields.................................................................................................................................................................................116
getOriginalFilePaths..............................................................................................................................................................................117
getPhotoshopPath.................................................................................................................................................................................118
getPhotoshopPathNames...................................................................................................................................................................119
getProjects................................................................................................................................................................................................120
getProperty...............................................................................................................................................................................................121
getPropertySets......................................................................................................................................................................................122
getPropertySetType..............................................................................................................................................................................123
getPropertySetTypes............................................................................................................................................................................124
getPublishContexts...............................................................................................................................................................................126
getScheduledJobs..................................................................................................................................................................................127
getSearchStrings....................................................................................................................................................................................128
getSystemProperties.............................................................................................................................................................................129

Last updated 2/27/2019 IPS API

 Contents

getTagFieldValues..................................................................................................................................................................................130
getUniqueMetadataValues.................................................................................................................................................................131
getUserChars............................................................................................................................................................................................132
getUserInfo...............................................................................................................................................................................................133
getUsers.....................................................................................................................................................................................................134
getViewerConfigSettings....................................................................................................................................................................136
getVignettePublishFormats...............................................................................................................................................................137
getXMPPacket.........................................................................................................................................................................................137
getZipEntries............................................................................................................................................................................................138
moveAsset................................................................................................................................................................................................139
moveAssets...............................................................................................................................................................................................140
moveFolder..............................................................................................................................................................................................142
pauseJob...................................................................................................................................................................................................143
removeAssetPermissions.....................................................................................................................................................................143
removeCompanyMembership..........................................................................................................................................................144
removeFolderPermissions..................................................................................................................................................................145
removeGroupMembers.......................................................................................................................................................................146
removeGroupMembership.................................................................................................................................................................147
removeProjectAssets............................................................................................................................................................................148
renameAsset............................................................................................................................................................................................149
renameFolder..........................................................................................................................................................................................151
renameProject.........................................................................................................................................................................................152
replaceImage...........................................................................................................................................................................................152
restoreAssetsFromTrash......................................................................................................................................................................153
resumeJob................................................................................................................................................................................................155
saveGroup.................................................................................................................................................................................................156
saveImageFormat...................................................................................................................................................................................156
saveImageMap........................................................................................................................................................................................158
saveMetadataField.................................................................................................................................................................................159
saveZoomTarget.....................................................................................................................................................................................161
searchAssets.............................................................................................................................................................................................162
searchAssetsByMetadata.....................................................................................................................................................................165
setAssetsContextState..........................................................................................................................................................................169
setAssetMetadata...................................................................................................................................................................................170

Last updated 2/27/2019 IPS API

 setAssetPermissions..............................................................................................................................................................................171
setAssetPublishState.............................................................................................................................................................................172
setAssetsPublishState...........................................................................................................................................................................173
setAssetSetDefinition...........................................................................................................................................................................175
setCompanyMembership....................................................................................................................................................................176
setCompanySettings.............................................................................................................................................................................177
setFolderPermissions............................................................................................................................................................................178
setGroupMembers.................................................................................................................................................................................179
setGroupMembership..........................................................................................................................................................................180
setImageMaps.........................................................................................................................................................................................181
setImageSetMembers...........................................................................................................................................................................182
setImageRenderingPublishSettings................................................................................................................................................183
setImageServingPublishSettings......................................................................................................................................................183
setPassword..............................................................................................................................................................................................183
setProjectAssets......................................................................................................................................................................................185
setTagFieldValues..................................................................................................................................................................................186
setUrlModifier..........................................................................................................................................................................................187
setUserInfo................................................................................................................................................................................................188
setViewerConfigSettings.....................................................................................................................................................................189
setZoomTargets......................................................................................................................................................................................190
stopJob.......................................................................................................................................................................................................191
submitJob.................................................................................................................................................................................................192
updateAssetPermissons.......................................................................................................................................................................195
updateAssetSet.......................................................................................................................................................................................196
updateFolderPermissions...................................................................................................................................................................196
updateImageSet.....................................................................................................................................................................................197
updateMetadataField...........................................................................................................................................................................198
updatePropertySet................................................................................................................................................................................200
updateTagFieldValues..........................................................................................................................................................................201
updateViewerConfigSettings.............................................................................................................................................................202
updateVignettePublishFormat..........................................................................................................................................................203
updateXMPPacket..................................................................................................................................................................................206

Data types.....................................................................................................................208

Last updated 2/27/2019 IPS API

 Contents

AcoInfo.............................................................................................................................................................................208
ActiveJob.........................................................................................................................................................................208
ActiveJobArray...............................................................................................................................................................210
AnimatedGifInfo............................................................................................................................................................210
Asset..................................................................................................................................................................................210
AssetArray........................................................................................................................................................................213
AssetContextStateUpdate.........................................................................................................................................213
AssetContextStateUpdateArray..............................................................................................................................213
AssetCount......................................................................................................................................................................213
AssetCountArray...........................................................................................................................................................214
AssetJobLog....................................................................................................................................................................214
AssetJobLogArray.........................................................................................................................................................214
AssetMetadataFields...................................................................................................................................................215
AssetMetadataFieldsArray.........................................................................................................................................215
AssetMove.......................................................................................................................................................................215
AssetMoveArray............................................................................................................................................................215
AssetOperationFault....................................................................................................................................................216
AssetOperationFaultArray.........................................................................................................................................216
AssetPublishContexts..................................................................................................................................................216
AssetPublishContextArray.........................................................................................................................................216
AssetSetInfo....................................................................................................................................................................217
AssetSummary...............................................................................................................................................................217
AssetSummaryArray....................................................................................................................................................218
AudioInfo.........................................................................................................................................................................218
AutoColorCropOptions...............................................................................................................................................218
AutomatedSetGenerationJob..................................................................................................................................218
AutoSetCreationOptions............................................................................................................................................219
AutoTransparentCropOptions.................................................................................................................................220
BatchMetadataUpdate................................................................................................................................................220
BatchMetadataUpdateArray.....................................................................................................................................220
CabinetInfo......................................................................................................................................................................220

Last updated 2/27/2019 IPS API

 ColorManagementOptions.......................................................................................................................................221
Company..........................................................................................................................................................................221
CompanyArray...............................................................................................................................................................222
CompanyMember.........................................................................................................................................................222
CompanyMemberArray..............................................................................................................................................222
CompanyMembership................................................................................................................................................222
CompanyMembershipArray.....................................................................................................................................223
CompanyMembershipUpdate.................................................................................................................................223
CompanyMembershipUpdateArray......................................................................................................................223
CompanyMetadataInfo...............................................................................................................................................223
CompanyMetadataInfoArray....................................................................................................................................224
CompanySettings.........................................................................................................................................................224
ConfigSetting.................................................................................................................................................................225
ConfigSettingArray.......................................................................................................................................................225
ContextStateUpdate....................................................................................................................................................225
ContextStateUpdateArray.........................................................................................................................................226
CreateVideoSitemapJob.............................................................................................................................................226
CssInfo...............................................................................................................................................................................226
CuePointInfo...................................................................................................................................................................227
DiskUsage........................................................................................................................................................................227
DiskUsageArray.............................................................................................................................................................227
EmailConfirmation.......................................................................................................................................................227
EmailArray.......................................................................................................................................................................228
ExcludeByproductArray..............................................................................................................................................228
ExcludeByproductCondition....................................................................................................................................228
ExcludeMasterVideoFromAVS.................................................................................................................................229
ExcelInfo...........................................................................................................................................................................229
ExportJob.........................................................................................................................................................................229
FlashInfo...........................................................................................................................................................................230
Folder................................................................................................................................................................................231
FolderArray......................................................................................................................................................................231

Last updated 2/27/2019 IPS API

 Contents

FontFieldUpdate...........................................................................................................................................................231
FontFieldUpdateArray................................................................................................................................................232
FontInfo............................................................................................................................................................................232
GenerationAttribute....................................................................................................................................................232
GenerationAttributeArray..........................................................................................................................................232
GenerationInfo...............................................................................................................................................................233
GenerationInfoArray....................................................................................................................................................233
Group................................................................................................................................................................................233
GroupArray......................................................................................................................................................................233
HandleArray....................................................................................................................................................................234
IccProfileFieldUpdate..................................................................................................................................................234
IccProfileFieldUpdateArray.......................................................................................................................................234
IccProfileInfo...................................................................................................................................................................234
IllustratorInfo..................................................................................................................................................................235
IllustratorOptions..........................................................................................................................................................235
ImageFieldUpdate........................................................................................................................................................235
ImageFieldUpdateArray.............................................................................................................................................236
ImageFormat..................................................................................................................................................................236
ImageFormatArray.......................................................................................................................................................236
ImageInfo.........................................................................................................................................................................236
ImageMap........................................................................................................................................................................238
ImageMapArray.............................................................................................................................................................238
ImageMapDefinition....................................................................................................................................................239
ImageMapDefinitionArray.........................................................................................................................................239
ImageRenderingPublishJob......................................................................................................................................239
ImageServingPublishJob...........................................................................................................................................239
ImageSetMember.........................................................................................................................................................240
ImageSetMemberArray..............................................................................................................................................240
ImageSetMemberUpdate..........................................................................................................................................240
ImageSetMemberUpdateArray...............................................................................................................................241
InDesignInfo...................................................................................................................................................................241

Last updated 2/27/2019 IPS API

 JavascriptInfo.................................................................................................................................................................241
JobLog..............................................................................................................................................................................241
JobLogArray....................................................................................................................................................................242
JobLogDetail...................................................................................................................................................................243
JobLogDetailArray........................................................................................................................................................243
JobLogDetailAux...........................................................................................................................................................243
JobLogDetailAuxArray................................................................................................................................................244
Keywords.........................................................................................................................................................................244
KeywordsArray...............................................................................................................................................................244
KnockoutBackgroundOptions.................................................................................................................................244
LayerViewInfo.................................................................................................................................................................245
ManualCropOptions....................................................................................................................................................246
Mask...................................................................................................................................................................................246
MaskArray........................................................................................................................................................................247
MaskInfo...........................................................................................................................................................................247
MasterVideoInfo............................................................................................................................................................247
MediaOptions.................................................................................................................................................................247
Metadata..........................................................................................................................................................................248
MetadataArray...............................................................................................................................................................249
MetadataCondition......................................................................................................................................................249
MetadataConditionArray...........................................................................................................................................250
MetadataDelete.............................................................................................................................................................250
MetadataDeleteArray..................................................................................................................................................250
MetadataField................................................................................................................................................................251
MetadataFieldArray.....................................................................................................................................................251
MetadataPublishJobType..........................................................................................................................................251
MetadataUpdate...........................................................................................................................................................252
MetadataUpdateArray................................................................................................................................................253
MPEvent...........................................................................................................................................................................253
MPEventArray.................................................................................................................................................................254
OperationFault...............................................................................................................................................................254

Last updated 2/27/2019 IPS API

 Contents

OperationFaultArray....................................................................................................................................................254
OptimizeImagesJob.....................................................................................................................................................255
PdfInfo...............................................................................................................................................................................255
PDFOptions.....................................................................................................................................................................255
PdfSettingsInfo..............................................................................................................................................................255
Permission.......................................................................................................................................................................256
PermissionArray............................................................................................................................................................256
PermissonSet..................................................................................................................................................................256
PermissionSetArray......................................................................................................................................................257
PermissionUpdate........................................................................................................................................................257
PermissionUpdateArray.............................................................................................................................................257
PerspectiveQuad...........................................................................................................................................................257
PhotoshopOptions.......................................................................................................................................................258
PhotoshopLayerOptions............................................................................................................................................258
PostScriptInfo.................................................................................................................................................................259
PostScriptOptions.........................................................................................................................................................259
PowerPointInfo..............................................................................................................................................................259
PremierExpressRemixInfo..........................................................................................................................................260
Project...............................................................................................................................................................................260
ProjectArray....................................................................................................................................................................260
Property............................................................................................................................................................................260
PropertyArray.................................................................................................................................................................261
PropertySet.....................................................................................................................................................................261
PropertySetArray...........................................................................................................................................................261
PropertySetType...........................................................................................................................................................261
PropertySetTypeArray.................................................................................................................................................262
PsdInfo..............................................................................................................................................................................262
PublishContext..............................................................................................................................................................262
PublishContextArray....................................................................................................................................................263
PublishHistory................................................................................................................................................................263
PublishHistoryArray.....................................................................................................................................................263

Last updated 2/27/2019 IPS API

 PublishStateUpdate.....................................................................................................................................................264
PublishStateUpdateArray..........................................................................................................................................264
RenderSceneInfo...........................................................................................................................................................264
ReprocessAssetsJob.....................................................................................................................................................264
RipPdfsJob.......................................................................................................................................................................267
RTFInfo..............................................................................................................................................................................268
ScheduledJob.................................................................................................................................................................268
ScheduledJobArray......................................................................................................................................................270
SearchFilter.....................................................................................................................................................................270
SearchStrings..................................................................................................................................................................271
SearchStringsArray.......................................................................................................................................................272
ServerDirectoryPublishJob........................................................................................................................................272
SetMetadataFault.........................................................................................................................................................272
SetMetadataFaultArray...............................................................................................................................................273
SetPropertySetPermissions.......................................................................................................................................273
SvgInfo..............................................................................................................................................................................273
StringArray......................................................................................................................................................................273
SwcInfo.............................................................................................................................................................................274
SystemFieldCondition.................................................................................................................................................274
SystemFieldConditionArray......................................................................................................................................275
TagCondition..................................................................................................................................................................275
TagConditionArray.......................................................................................................................................................275
TagConditionArray.......................................................................................................................................................276
TagFieldValues...............................................................................................................................................................276
TagFieldValuesArray....................................................................................................................................................276
TagValueUpdate............................................................................................................................................................276
TagValueUpdateArray.................................................................................................................................................277
TagValueUpdateFault.................................................................................................................................................277
TagValueUpdateFaultArray.......................................................................................................................................277
TaskItemProgress..........................................................................................................................................................277
TaskItemProgressArray...............................................................................................................................................278

Last updated 2/27/2019 IPS API

 Contents

TaskProgress...................................................................................................................................................................278
TaskProgressArray........................................................................................................................................................279
TemplateInfo..................................................................................................................................................................279
ThumbAssetUpdate.....................................................................................................................................................279
ThumbAssetUpdateArray..........................................................................................................................................279
ThumbnailOptions.......................................................................................................................................................280
UnCompressOptions...................................................................................................................................................280
UnsharpMaskOptions..................................................................................................................................................281
UploadDirectoryJob.....................................................................................................................................................282
UploadPostJob...............................................................................................................................................................285
UploadUrl.........................................................................................................................................................................287
UploadUrlArray..............................................................................................................................................................288
UploadUrlsJob................................................................................................................................................................288
UrlArray.............................................................................................................................................................................290
User....................................................................................................................................................................................290
UserArray.........................................................................................................................................................................290
VideoCaptionInfo..........................................................................................................................................................291
VideoInfo..........................................................................................................................................................................291
VideoPublishJob............................................................................................................................................................291
ViewerPresetInfo...........................................................................................................................................................292
ViewerSwfInfo................................................................................................................................................................292
VignetteInfo....................................................................................................................................................................292
WatermarkInfo...............................................................................................................................................................293
WindowCoveringInfo..................................................................................................................................................293
WordInfo..........................................................................................................................................................................293
XmlInfo.............................................................................................................................................................................294
XmpKeywords................................................................................................................................................................294
XslInfo...............................................................................................................................................................................294
ZipEntry............................................................................................................................................................................294
ZipEntryArray.................................................................................................................................................................295
ZipInfo...............................................................................................................................................................................295

Last updated 2/27/2019 IPS API

 ZoomTarget....................................................................................................................................................................295
ZoomTargetArray.........................................................................................................................................................296
ZoomTargetDefinition................................................................................................................................................296
ZoomTargetDefinitionArray.....................................................................................................................................296

String constants............................................................................................................297
Active Job States...........................................................................................................................................................297
Asset Search System Fields.......................................................................................................................................297
Asset Overwrite Modes...............................................................................................................................................297
Asset Sort Fields............................................................................................................................................................298
Asset Types......................................................................................................................................................................298
AutoCrop Corner...........................................................................................................................................................299
Color Management Modes........................................................................................................................................299
Color Spaces...................................................................................................................................................................300
Email Settings.................................................................................................................................................................300
Font Styles.......................................................................................................................................................................301
Font Types.......................................................................................................................................................................301
Generation Info..............................................................................................................................................................301
Illustrator Processes.....................................................................................................................................................301
Job Log File Types........................................................................................................................................................302
Job Log Sort Fields.......................................................................................................................................................302
Job Log Types.................................................................................................................................................................303
Job Trigger States.........................................................................................................................................................305
Job Types.........................................................................................................................................................................305
Metadata Field Types..................................................................................................................................................306
Numeric/Date Comparison Operators..................................................................................................................306
PDF Processes................................................................................................................................................................306
Permission Types..........................................................................................................................................................307
Photoshop Anchor Modes.........................................................................................................................................307
Photoshop Layer Naming Modes...........................................................................................................................307
PostScript Colorspace Modes...................................................................................................................................307

Last updated 2/27/2019 IPS API

 Contents

Profile Classes.................................................................................................................................................................308
Publish State...................................................................................................................................................................308
Property Set Types........................................................................................................................................................308
Publish Context.............................................................................................................................................................308
Publish Types..................................................................................................................................................................308
Region Shape.................................................................................................................................................................309
Search Match Modes...................................................................................................................................................309
Sort Directions...............................................................................................................................................................309
String Comparison Operators..................................................................................................................................309
Trash State.......................................................................................................................................................................310
User Char Filter Fields..................................................................................................................................................310
User Roles........................................................................................................................................................................310
User Sort Fields..............................................................................................................................................................311
Viewer Type....................................................................................................................................................................311

Faults.............................................................................................................................312
authenticationFault.....................................................................................................................................................312
authorizationFault........................................................................................................................................................312
ipsApiFault......................................................................................................................................................................313

Change log....................................................................................................................314
Version 6.0.......................................................................................................................................................................314
Operations: New and Modified.........................................................................................................................................................314
Data Types: New and Modified.........................................................................................................................................................315

Version 4.5.......................................................................................................................................................................316
Operations: New and Modified.........................................................................................................................................................316
Data Types: New and Modified.........................................................................................................................................................316
Restricted Use..........................................................................................................................................................................................317

Version 4.4.......................................................................................................................................................................319
Operations: New and Modified.........................................................................................................................................................319
Data Types: New and Modified.........................................................................................................................................................319
String Constants: New and Modified..............................................................................................................................................320

Last updated 2/27/2019 IPS API

 Version 4.2.......................................................................................................................................................................320
Data Types: New and Modified.........................................................................................................................................................320

Version 4.0.......................................................................................................................................................................321
New Additions and Changes..............................................................................................................................................................321

Version 3.8.......................................................................................................................................................................328
Operations: New and Modified.........................................................................................................................................................328
Data Types: New and Modified.........................................................................................................................................................328
String Constants: New and Modified..............................................................................................................................................328

Version 3.7.......................................................................................................................................................................329
Operations: New and Modified.........................................................................................................................................................329
Data Types: New and Modified.........................................................................................................................................................330
String Constants: New and Modified..............................................................................................................................................330

Uploading assets by way of HTTP POSTs to the UploadFile Servlet........................332

Last updated 2/27/2019 IPS API

About Scene7 Image Production System API 17

About Scene7 Image Production System API

The Scene7 IPS (Image Production System) Web Service API enables external applications and third-party developers to
programmatically access IPS assets and functionality.
This reference guide contains and defines all the services, methods, and data types used by the IPS Web Service API. It has been
specifically tested for compatibility with Java (using the Apache Axis2 library), Adobe Flex, and Microsoft .NET.

Standards and protocols

The IPS API uses standard SOAP and HTTP protocols and is compatible with any client that conforms to these standards.
Additional testing helps ensure the API is compatible with Java (using the Apache Axis2 library), Adobe Flex, and Microsoft
.NET.
Deprecated calls 18

Deprecated calls
Image Production System API calls and their associated parameters that are no longer used.
• addMediaPortalEvent – Deprecated from Operations. This call let you add a Media Portal Event to IPS.
• getMediaPortalEvent – Deprecated from Operations. This call let you get media portal events that matched specified
criteria.
• getCdnCacheInvalidationStatus – Deprecated from Operations. This API is now deprecated because the
cdnCacheInvalidation API invalidates the cache almost immediately (~5 seconds). As such, polling for invalidation status
is no longer required.
IPS Web Service WSDL versions 19

IPS Web Service WSDL versions

The IPS Web Service is supported by a set of WSDL (Web Services Description Language) documents that are accessed from
any IPS installation on which the IPS Web Service component is installed. Each IPS API release includes a new WSDL file that
references a versioned target XML namespace. Prior WSDL namespace versions are also supported to allow for backwards
compatibility with existing applications.

WSDL access
Access the Scene7 WSDLs as shown below.
https://<IPS_hostname:<IPS_port>/<IPS_webapp>/
webservice/IpsApi[-<API_version>].wsdl

The default value for <IPS_webapp> is scene7.

Service location

The service URL is specified in the service section of the IPS Web Service WSDL document. The service URL is generally of the
form:
https://<IPS_hostname>:<IPS_port>/<IPS_webapp>/
services/IpsApiService

Access URLs for Scene7 regions

Geographic location Production URL Staging URL (use for pre-production

development and testing)

North America https://s7sps1apissl.scene7.com/scene7/ https://s7sps1apissl-staging.scene7.com/scene7/

Europe, Middle East, Asia https://s7sps3apissl.scene7.com/scene7/ https://s7sps3apissl-staging.scene7.com/scene7/

Japan/Asia Pacific https://s7sps5apissl.scene7.com/scene7/ https://s7sps5apissl-staging.scene7.com/scene7/

Supported WSDLs
Remember, you may need to modify your code if you want to use features in the latest version of the IPS API. The IPS API
supports WSDLs for the following versions:

API release version WSDL API namespace

6.8/2014R1 IpsApi-2014-04-03.wsdl http://www.scene7.com/IpsApi/xsd/2014-04-03

6.6/2013R1 IpsApi-2013-02-15.wsdl http://www.scene7.com/IpsApi/xsd/2013-02-15

6.0/2012R1 IpsApi-2012-02-14.wsdl http://www.scene7.com/IpsApi/xsd/2012-02-14

4.5 IpsApi-2010-01-31.wsdl http://www.scene7.com/IpsApi/xsd/2010-01-31

4.4 IpsApi-2009-07-31.wsdl http://www.scene7.com/IpsApi/xsd/2009-07-31

IPS Web Service WSDL versions 20

API release version WSDL API namespace

4.2 IpsApi-2008-09-10.wsdl http://www.scene7.com/IpsApi/xsd/2008-09-10

4.0 IpsApi-2008-01-15.wsdl http://www.scene7.com/IpsApi/xsd/2008-01-15

Pre-4.0 IpsApi.wsdl http://www.scene7.com/IpsApi/xsd

Existing applications that need to be modified to use new features must upgrade to the latest API version and may need to make
changes to existing code. See the change log for details.

SOAP
Bindings

The IPS API Web Service supports a SOAP binding only.

Supported transports

The IPS API SOAP binding supports HTTP transport only. Make all SOAP requests using the HTTPS POST method.

SOAP action header

To process a request, set the SOAPAction HTTP header to the name of the requested operation. The operation name attribute
in the WSDL binding section specifies the name.

Message format

The document/literal style is used for all input and output messages with types based on the XML Schema definition language
(http://www.w3.org/TR/xmlschema-0/) and specified in the WSDL file. All types require qualified names using the target
namespace value specified in the WSDL file.

Request authentication

The preferred method for passing authentication credentials in API requests is to use the authHeader element as defined in
the IPS API WSDL.
<element name="authHeader">
<complexType>
<sequence>
<element name="user" type="xsd:string"/>
<element name="password" type="xsd:string"/>
<element name="locale" type="xsd:string" minOccurs="0"/>
<element name="appName" type="xsd:string" minOccurs="0"/>
<element name="appVersion" type="xsd:string" minOccurs="0"/>
<element name="gzipResponse" type="xsd:boolean" minOccurs="0"/>
<element name="faultHttpStatusCode" type="xsd:int" minOccurs="0"/>
</sequence>
</complexType>
</element>

Fields

Name Description

user Valid IPS user email.

IPS Web Service WSDL versions 21

Name Description

password Password for user account.

locale Optional locale for request. See Locale for details.

appName Calling application name. This parameter is optional, but it is recommended that you
include it in all requests.

appVersion Calling application version.

gzipResponse Optional flag to enable or disable gzip compression of response XML. By default, responses
are gzip-compressed if the HTTP Accept-Encoding header indicates support for gzip.

faultHttpStatusCode Optional parameter to override the HTTP status code for fault responses. By default, fault
responses return HTTP status code 500 (Internal Server Error). Some client platforms,
including Adobe Flash, are unable to read the response body unless a status code of 200
(OK) is returned.

The authHeader element is always defined in the namespace http://www.scene7.com/IpsApi/xsd, regardless of API
version.

The following is an example of using the authHeader element in a request SOAP header:
<soap:Header xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<authHeader xmlns="http://www.scene7.com/IpsApi/xsd">
<user>user@scene7.com</user>
<password>mypassword</password>
<appName>MyApp</appName>
<appVersion>1.0</appVersion>
</authHeader>
</soap:Header>

Other request authentication methods

If for some reason it is not possible for your client application to pass the authHeader SOAP header, API requests can also
specify credentials using HTTP Basic authentication (as specified in RFC 2617).

For HTTP Basic authentication, the HTTP header section of each SOAP POST request must include a header of the form:

Authorization: Basic base64(<IPS_user_email>:<password>)

Where base64() applies the standard Base64 encoding, <IPS_user_email> is the email address of a valid IPS user, and
<password> is the user's password.

Send the Authorization header preemptively with the initial request. If no authentication credentials are included in the request,
IpsApiService does not respond with a status code of 401 (Unauthorized). Instead, a status code of 500 (Internal
Server Error) is returned with a SOAP fault body stating that the request could not be authenticated.

Before IPS 3.8, authentication via SOAP header was implemented using the AuthUser and AuthPassword elements in the
namespace http://www.scene7.com/IpsApi. For example:
<soap:Header xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<AuthUser xmlns="http://www.scene7.com/IpsApi">user@scene7.com</AuthUser>
IPS Web Service WSDL versions 22

<AuthPassword xmlns="http://www.scene7.com/IpsApi">mypassword</AuthPassword>
</soap:Header>

This style is still supported for backwards compatibility but has been deprecated in favor of the authHeader element.

Request authorization

After the caller's credentials are authenticated, the request is checked to ensure that the caller is authorized to perform the
requested operation. Authorization is based on the user role of the caller and may also require checking the target company,
target user, and other operation parameters. In addition, Image Portal users must belong to a Group with the required permissions
to perform certain folder and asset operations. The Operations reference section details the authorization requirements for each
operation.

Sample SOAP request and response

The following example shows a complete addCompany operation, including HTTP headers:
POST /scene7/services/IpsApiService HTTP/1.1
User-Agent: Axis/2.0
SOAPAction: addCompany
Content-Type: text/xml; charset=UTF-8

<?xml version='1.0' encoding='UTF-8'?>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<authHeader xmlns="http://www.scene7.com/IpsApi/xsd">
<user>user@scene7.com</user>
<password>mypassword</password>
<appName>MyApp</appName>
<appVersion>1.0</appVersion>
</authHeader>
</soapenv:Header>
<soapenv:Body>
<ns1:addCompanyParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<ns1:companyName>Sample Company</ns1:companyName>
<ns1:expires>2008-07-31T12:00:00-06:00</ns1:expires>
</ns1:addCompanyParam>
</soapenv:Body>
</soapenv:Envelope>

And the corresponding response:

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: text/xml;charset=UTF-8
Transfer-Encoding: chunked
Date: Fri, 21 Jul 2006 20:47:55 GMT

<?xml version='1.0' encoding='utf-8'?><soapenv:Envelope

xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<ns1:addCompanyReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<ns1:companyInfo>
<ns1:companyHandle>2</ns1:companyHandle>
<ns1:name>Sample Company</ns1:name>
<ns1:rootPath>SampleCompany/</ns1:rootPath>
<ns1:expires>2008-07-31T18:00:00.000Z</ns1:expires>
</ns1:companyInfo>
</ns1:addCompanyReturn>
</soapenv:Body>
</soapenv:Envelope>

SOAP faults
IPS Web Service WSDL versions 23

When an operation encounters an exception condition, a SOAP fault is returned as the body of the SOAP message in place of
the normal response. For example, if a non-admin user attempts to send the previous addCompany request, the following
response is returned:
HTTP/1.1 500 Internal Server Error
Server: Apache-Coyote/1.1
Content-Type: text/xml;charset=UTF-8
Transfer-Encoding: chunked
Date: Fri, 21 Jul 2006 16:36:20 GMT
Connection: close

<?xml version='1.0' encoding='utf-8'?>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header />
<soapenv:Body>
<soapenv:Fault>
<faultcode>soapenv:Client</faultcode>
<faultstring>AuthorizationException</faultstring>
<detail>
<ns1:authorizationFault xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<code xmlns="http://www.scene7.com/IpsApi/xsd">20003</code>
<reason xmlns="http://www.scene7.com/IpsApi/xsd">User does not
have permission to access operation 'addCompany'</reason>
</ns1:authorizationFault>
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
Operations methods 24

Operations methods
This section describes the common operation parameters handled by the IPS Web Service API.
For a complete description of each operation parameter, seeOperation parameters.

Handles: About
Handles reference IPS objects returned by certain API operations. You can also pass handles as parameters to subsequent
operation calls. Handles are string data types (xsd:string).

Handles are intended for use during a single application session only. Furthermore, you should make handles persistent because
their format can change between IPS releases. When you write interactive applications, you implement session timeouts and
discard all handles between sessions, particularly after an IPS upgrade. When you write non-interactive applications, call the
appropriate operations to retrieve handles each time the application is run. The following Java/Axis2 code samples show incorrect
and correct code execution:

Incorrect Handle Code

This code sample is incorrect because it contains a hard-coded value (555) for the company handle.
SearchAssetsParam searchParam = new SearchAssetsParam(); searchParam.setCompanyHandle("555");//
INCORRECT
searchParam.setFolder("myFolder");
SearchAssetsReturn retVal = ipsApi.searchAssets(searchParam, authHeader);

Correct Handle Code

This code sample is correct because it calls getCompanyInfo to return valid handle. It does not rely on a hard-coded value.
Use this method–or other IPS API equivalent–to return the required handle.
GetCompanyInfoParam companyInfoParam = new GetCompanyInfoParam();
companyInfoParam.setCompanyName("My Company"); GetCompanyInfoReturn companyInfoReturn =
ipsApi.getCompanyInfo(companyInfoParam, authHeader);
String companyHandle = companyInfoReturn.getCompanyInfo().getCompanyHandle();
SearchAssetsParam searchParam = new SearchAssetsParam();
searchParam.setCompanyHandle(companyHandle); //CORRECT
searchParam.setFolder("myFolder");
SearchAssetsReturn retVal = ipsApi.searchAssets(searchParam, authHeader);

Common Handle Types

companyHandle

Most operations require you to set a company context by passing in a companyHandle parameter. The company handle is a
pointer returned by certain operations such as getCompanyInfo, addCompany, and getCompanyMembership.

userHandle

The userHandle parameter is an optional parameter for operations that target a specific user. By default, these operations
target the calling user (the user whose credentials are passed in for authentication). However, admin users with the proper
permissions can specify a different user. For example, the setPassword operation normally sets the password of the authenticated
user, but an admin can use the userHandle parameter to set the password for a different user.

For operations that require a company context (using the companyHandle parameter), both the authenticated and target users
must be members of the specified company. For operations that do not require a company context, the authenticated and target
users must both be members of at least one common company.

The following operations can retrieve user handles:

Operations methods 25

• getUsers
• getAllUsers
• getUserInfo
• getCompanyMembers
• getGroupMembers
• addUser

accessUserHandle and accessGroupHandle

By default, operations that require access permissions (read, write, delete) operate in the permission context of the calling user.
Certain operations allow you to modify this context with the accessUserHandle or accessGroupHandle parameter. The
accessUserHandle parameter allows an admin to impersonate another user. The accessGroupHandle parameter allows
the caller to operate in the context of a specific user group.

responseFieldArray and excludeFieldArray

Some operations allow the caller to restrict which fields are included in the response. Limiting fields can help reduce the time
and memory required to process the request and reduce the size of the response data. The caller can request a specific list of
fields by passing a responseFieldArray parameter, or with an enumerated a list of excluded fields via the excludeFieldArray
parameter.

Both responseFieldArray and excludeFieldArray specify fields by using a node path separated by /. For example, to
specify that searchAssets returns only the name, last modified date, and metadata for each asset refer to the following:
<responseFieldArray>
<items>assetArray/items/name</items>
<items>assetArray/items/lastModified</items>
<items>assetArray/items/metadataArray</items>
</responseFieldArray>

Similarly, to return all fields (except for permissions):

<excludeFieldArray>
<items>assetArray/items/permissions</items>
</excludeFieldArray>

Note that the node paths are relative to the return node root. If you specify a complex type field without any of its sub-elements
(for example, assetArray/items/imageInfo), then all of its sub-elements are included. If you specify one or more sub-elements
in a complex type field (for example, assetArray/items/imageInfo/originalPath), then only those sub-elements are
included.

If you do not include responseFieldArray or excludeFieldArray in a request, all fields are returned.

Locale

Since IPS 4.0, the IPS API supports setting the locale context of an operation by passing the authHeader locale parameter. If
the locale parameter is not present, the HTTP header Accept-Language will be used. If this header is also not present, the
default locale for the IPS server will be used.

Certain operations also take explicit locale parameters, which may be different than the operation locale context. For example,
the submitJob operation takes a locale parameter that sets the locale used for job logging and email notification.

Locale parameters use the format <language_code>[-<country_code>]

Where the language code is a lower-case, two-letter code specified by ISO-639 and the optional country code is an upper-case,
two-letter code specified by ISO-3266. For example, the locale string for US English is en-US.
Operations methods 26

Operation parameters

addCompany
Adds a company to the system.
Sends the name of the company to be added to the system and optionally sends whether the company expires.

When this operation is invoked, the system gets a companyInfo type that contains a company handle and descriptive fields. If
the company name requested already exists in the system, it throws an ipsApiFault.

Authorized User Types

• IpsAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (addCompanyParam)

Name Type Required Description

companyName xsd:string Yes The name of the company to

add.

expires xsd:dateTime No The expiration date of the

company. Provide the time
zone with the request for this
field. Time zones are adjusted
to Central Time.

Output (addCompanyReturn)

Name Type Required Description

companyInfo xsd:string Yes Handle to and name, root

path, expiration date, and time
of the new company.

Examples
This example demonstrates a request to add a company to the IPS system and the response detailing the information about the
added company that is needed to perform other operations.
Operations methods 27

Request
<ns1:addCompanyParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyName>Planetary</ns1:companyName>
</ns1:addCompanyParam>

Response
<ns1:addCompanyReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyInfo>
<ns1:companyHandle>137</ns1:companyHandle>
<ns1:name>Planetary</ns1:name>
<ns1:rootPath>Planetary/</ns1:rootPath>
<ns1:expires>2101-01-31T23:00:00.030Z</ns1:expires>
</ns1:companyInfo>
</ns1:addCompanyReturn>

addCompanyMembership
Adds a user to one or more companies.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (addCompanyMembershipParam)

Name Type Required Description

userHandle xsd:string No The handle to the user whose

membership you want to add.

membershipArray types:CompanyMembershipUpdateArray Yes An array of companies that

you're adding the user to.

Output (addCompanyMembershipReturn)

The IPS API does not return a response for this operation.

Examples
This example uses companyHandleArray to add a user to a single company.

Request
<ns1:addCompanyMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:userHandle>621|jduvar@adobe.com</ns1:userHandle>
<ns1:companyHandleArray>
</ns1:items>47</ns1:items>
</ns1:companyHandleArray>
</ns1:addCompanyMembershipParam>

Response

None.
Operations methods 28

addGroupMembers
Adds users from a specific company to a specific group.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (addGroupMembersParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company.

groupHandle xsd:string Yes The group handle.

userHandleArray types:HandleArray Yes An array of handles to users

who you want to add to a
group.

Output (addGroupMembersParam)

The IPS API does not return a response for this operation.

Examples
This example uses addGroupMembersParam to add a user to a single company. The IPS API does not return a response for
this operation.

Request
<ns1:addGroupMembersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:groupHandle>225</ns1:groupHandle>
<ns1:userHandleArray><ns1:items>70|kmagnusson@adobe.com</ns1:items></ns1:userHandleArray>
</ns1:addGroupMembersParam>

Response

None.

addGroupMembership
Adds a user to an array of groups.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
Operations methods 29

Parameters
Input (addGroupMembershipParam)

Name Type Required Description

userHandle xsd:string
No Handle to the user whose
group membership you want
to add.

groupHandleArray xsd:HandleArray
Yes Array of handles to the groups
you want the company to
belong to.

Output (addGroupMembershipParam)

The IPS API does not return a response for this operation.

Examples
This example adds a group to a company with groupHandleArray. This example uses one group only.

Request
<ns1:addGroupMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:groupHandleArray><ns1:items>225</ns1:items></ns1:groupHandleArray>
</ns1:addGroupMembershipParam>

Response

None.

addProjectAssets
Adds one or more assets to a project.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (addProjectAssetsParam)
Operations methods 30

Name Type Required Description

companyHandle xsd:string Yes Handle to the company

associated with the current
project.

projectHandle xsd:string Yes Handle to the project you're

adding assets to.

projectHandleArray xsd:HandleArray Yes Array of assets you're adding

to the current project.

Output (addProjectAssetsParam)

Name Type Required Description

successCount xsd:int Yes The number of assets added

successfully.

warningCount xsd:int Yes The number of warnings

generated when the operation
attempted to add assets to a
project.

errorCount xsd:int Yes The number of errors

generated when the operation
attempted to add assets to a
project.

warningDetailHandle xsd:AssetOperationFaultArray No Array of warnings generated

by assets when the operation
attempted to add them to a
project.

companyHandle xsd:AssetOperationFaultArray No Array of errors generated by

assets when the operation
attempted to add them to a
project.

Examples
This example adds a single asset (referenced by its handle) in an asset handle array to a project specified in the request. The
operation completed successfully when the response successCount returns 1.

Request
<addProjectAssetsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<projectHandle>p|6|ProjectTestAPI</projectHandle>
<assetHandleArray>
<items>a|732|1|535</items>
</assetHandleArray>
</addProjectAssetsParam>
Operations methods 31

Response
<addProjectAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<successCount>1</successCount>
<warningCount>0</warningCount>
<errorCount>0</errorCount>
</addProjectAssetsReturn>

addTagFieldValues
Adds new tag values to the dictionary of an existing tag field.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (addTagFieldValuesParam)

Name Type Required Description

companyHandle xsd:string Yes The handle of the company

containing the tag field.

fieldHandle xsd:string Yes The handle of the tag field to

be modified.

valueArray xsd:string Yes An array of tag values to add

to the field's existing
dictionary.

Output (addTagFieldValuesParam)

The IPS API does not return a response for this operation.

Examples
Request
<addTagFieldValuesParam xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
<companyHandle>c|3</companyHandle>
<fieldHandle>m|3|ASSET|SingleFixedTag</fieldHandle>
<valueArray>
<items>Pineapple</items>
<items>Banana</items>
</valueArray>
</addTagFieldValuesParam>

Response

None.

addUser
Creates a user account and adds that account to one or more companies.
Operations methods 32

When adding a user to multiple companies, specify those companies by their company handles in companyHandleArray. This
operation returns the handle to user you just added.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (addUserParam)

Name Type Required Description

firstName xsd:string Yes The user's first name.

lastName xsd:string Yes The user's last name.

email xsd:string Yes The user's email address.

defaultRole xsd:string Yes Sets the role for a user in each

company they belong to. Note,
however, the IpsAdmin role
overrides other per-company
settings.

password xsd:string Yes Sets the user's password

passwordExpires xsd:dateTime No Sets the password expiration

period. Provide the time zone
when passing in the request.
Time zones are adjusted to
Central Time.

isValid xsd:boolean Yes Determines if the user is valid.

membershipArray xsd:CompanyMembershipUpdateArray Yes An array of company handles.

Output (addUserParam)

Name Type Required Description

userHandle xsd:string Yes The handle to the user.

Examples
The IPS API returns a user handle element that specifies the new user.

Request
<ns1:addUserParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:firstName>Joe</ns1:firstName>
<ns1:lastName>User</ns1:lastName>
<ns1:email>juser@adobe.com</ns1:email>
<ns1:defaultRole>TrialSiteUser</ns1:role>
Operations methods 33

<ns1:password>passw0rd</ns1:password>
<ns1:isValid>true</ns1:isValid>
<ns1:companyHandleArray>
<ns1:items>47</ns1:items>
</ns1:companyHandleArray>
</ns1:addUserParam>

Response
<ns1:addUserReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:userHandle>525s|juser@scene7.com</ns1:userHandle>
</ns1:addUserReturn>

batchGetAssetPublishContexts
Returns the publish contexts for assets marked for publication.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Note:
• The user must have read access to return the assets.
• All users have access to the shared company.

Parameters
Input (batchGetAssetPublishContextsParam)

Name Type Required Description

companyHandle xsd:string Yes Handle to the company.

assetHandleArray types:HandleArray Yes A list of assets you want to

query for active (marked for
publish) contexts.

Output (batchGetAssetPublishContextsReturn)

Name Type Required Description

assetPublishContextsArray types:assetPublishContextsArray Yes An array of publish contexts

in which each asset is marked
for publish.
Operations methods 34

Examples
Request
<batchGetAssetPublishContextsParam xmlns="http://www.scene7.com/IpsApi/xsd/2011-11-04">
<companyHandle>c|301</companyHandle>
<assetHandleArray>
<items>a|27007</items>
<items>a|27008</items>
</assetHandleArray>
</batchGetAssetPublishContextsParam>

Response
<batchGetAssetPublishContextsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2011-11-04">
<assetPublishContextsArray>
<items>
<assetHandle>a|27007</assetHandle>
<publishContextArray>
<items>
<contextHandle>pc|3002</contextHandle>
<contextName>ImageServing</contextName>
<contextType>ImageServing</contextType>
</items>
</publishContextArray>
</items>
<items>
<assetHandle>a|27008</assetHandle>
<publishContextArray>
<items>
<contextHandle>pc|3004</contextHandle>
<contextName>Video</contextName>
<contextType>Video</contextType>
</items>
<items>
<contextHandle>pc|3001</contextHandle>
<contextName>ImageRendering</contextName>
<contextType>ImageRendering</contextType>
</items>
</publishContextArray>
</items>
</assetPublishContextsArray>
</batchGetAssetPublishContextsReturn>

batchSetAssetMetadata
Sets asset metadata using batch mode.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (batchSetAssetMetadataParam)
Operations methods 35

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

whose metadata you want to
set in a batch operation.

updateArray types:BatchMetadataUpdateArray Yes The array of metadata updates

applied to the assets.

Output (batchSetAssetMetadataParam)

Name Type Required Description

successCount xsd:int Yes The number of successfully set

metadata.

warningCount xsd:int Yes The number of warnings

generated when the operation
attempted to set metadata.

errorCount xsd:int Yes The number of errors

generated when the operation
attempted to set metadata.

warningDetailArray types:AssetOperationFaultArray No The array of details associated

with the assets generating
warnings when the operation
attempted to batch set
metadata for the assets.

errorDetailArray types:AssetOperationFaultArray No The array of details associated

with the assets that generating
erros when the operation
attempted to batch set
metadata for the assets.

Examples
Request
<batchSetAssetMetadataParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<updateArray>
<items>
<assetHandleArray>
<items>a|743|1|538</items>
<items>a|744|1|539</items>
</assetHandleArray>
<updateArray>
<items>
<fieldHandle>m|6|IMAGE|saveMetadataField</fieldHandle>
<value>400</value>
</items>
</updateArray>
</items>
<items>
<assetHandleArray>
<items>a|732|1|535</items>
Operations methods 36

<items>a|739|1|537</items>
</assetHandleArray>
<updateArray>
<items>
<fieldHandle>m|6|IMAGE|saveMetadataField</fieldHandle>
<value>300</value>
</items>
</updateArray>
</items>
</updateArray>
</batchSetAssetMetadataParam>

Response
<batchSetAssetMetadataReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<successCount>4</successCount>
<warningCount>0</warningCount>
<errorCount>0</errorCount>
</batchSetAssetMetadataReturn>

batchSetFontFields
Sets font metadata fields.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (batchSetFontFieldsParam)

Name Type Required Description

companyHandle xsd:string Yes Handle to the company that

contains the fonts.

updateArray types:FontFieldUpdateArray Yes Array of font field updates.

Output (batchSetFontFieldsParam)

Name Type Required Description

successCount xsd:int Yes The number of successfully set

font fields.

warningCount xsd:int Yes Number of warnings generated

when the operation attempted
to set font fields.

errorCount xsd:int Yes Number of errors generated

when the operation attempted
to set font fields.
Operations methods 37

Name Type Required Description

warningDetailArray types:AssetOperationFaultArray No The array of details associated

with the assets that generated
warnings when the operation
attempted to apply the
updates.

errorDetailArray types:AssetOperationFaultArray No The array of details associated

with the assets that generated
errors when the operation
attempted to apply the
updates.

Examples
Request
<batchSetFontFieldsParam xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
<companyHandle>c|1</companyHandle>
<updateArray>
<items>
<assetHandle>a|450|14|19</assetHandle>
<fontName>Bookman Old Style Font Name</fontName>
<postscriptName>Bookman Old Style PostScript</postscriptName>
<rtfName>Bookman Old Style RTF</rtfName>
<fontFamily>Bookman Old Style Family</fontFamily>
<style>BoldItalic</style>
<typeName>Open Type</typeName><type>OTF</type>
</items>
</updateArray>
</batchSetFontFieldsParam>

Response
<batchSetFontFieldsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
<successCount>1</successCount>
<warningCount>0</warningCount>
<errorCount>0</errorCount>
</batchSetFontFieldsReturn>

batchSetIccProfileFields
Sets ICC profile metadata fields.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (batchSetIccProfileFields)
Operations methods 38

Name Type Required Description

companyHandle xsd:string Yes Handle to the company that

contains the ICC profiles.

update array xsd:string Yes Array of ICC profile updates.

Output (batchSetIccProfileFields)

Name Type Required Description

successCount xsd:int Yes The number of successfully set

ICC profile fields.

warningCount xsd:int Yes The number of warnings

generated when the operation
attempted to set the ICC
profile fields.

errorCount xsd:int Yes The number of errors

generated when the operation
attempted to set the ICC
profile fields.

warningDetailArray types:AssetOperationFaultArray No The array of details associated

with the assets that generated
warnings when the operation
attempted to apply the
updates.

errorDetailArray types:AssetOperationFaultArray No The array of details associated

with the assets that generated
errors when the operation
attempted to apply the
updates.

Examples
Request
<batchSetIccProfileFieldsParam xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
<companyHandle>c|1</companyHandle>
<updateArray>
<items>
<assetHandle>a|1808|13|169</assetHandle>
<class>Output</class>
<colorSpace>CMYK</colorSpace>
<pcsType>Luv</pcsType>
</items>
</updateArray>
</batchSetIccProfileFieldsParam>

Response
<batchSetIccProfileFieldsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
<successCount>1</successCount>
<warningCount>0</warningCount>
Operations methods 39

<errorCount>0</errorCount>
</batchSetIccProfileFieldsReturn>

batchSetImageFields
Sets image-specific fields for one or more image assets.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (batchSetImageFields)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

that contains the image assets.

updateArray types:ImageFieldUpdateArray Yes The array of image field

updates.

Output (batchSetImageFields)

Name Type Required Description

successCount xsd:int Yes The number of successfully set
image fields.
warningCount xsd:int Yes The number of warnings
generated when the operation
attempted to set the image
fields.
errorCount xsd:int Yes The number of errors
generated when the operation
attempted to set the image
fields.
warningDetailArray types:AssetOperationFaultArray No The array of details associated
with the assets that generated
warnings when the operation
attempted to apply the
updates.
errorDetailArray types:AssetOperationFaultArray No The array of details associated
with the assets that generated
errors when the operation
attempted to apply the
updates.
Operations methods 40

Examples
This example sets data in the fields of two images in an update array. In the array, the images are specified by their asset handles
and contain resolution in pixels, x- and y-position anchor coordinates, and user data. The response indicates that fields for both
images were set successfully.

Request
<batchSetImageFieldsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|21</companyHandle>
<updateArray>
<items>
<assetHandle>a|140626|1|102524</assetHandle>
<resolution>72</resolution>
<anchorX>50</anchorX>
<anchorY>100</anchorY>
<userData>nada1</userData>
</items>
<items>
<assetHandle>a|96680|1|64865</assetHandle>
<resolution>150</resolution>
<anchorX>100</anchorX>
<anchorY>50</anchorY>
<userData>nada2</userData>
</items>
</updateArray>
</batchSetImageFieldsParam>

Response
<batchSetImageFieldsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<successCount>2</successCount>
<warningCount>0</warningCount>
<errorCount>0</errorCount>
</batchSetImageFieldsReturn>

batchSetThumbAsset
Sets the thumbnail image for one or more assets.

Thumbnail Asset Types

Allowed thumbnail asset types consist of the following:
• Image
• AdjustedView
• Mask
• Template
• PsdTemplate

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser
Operations methods 41

Note: The user must have read/write access to the target asset and read access to the thumb asset.

Parameters
Input (batchSetThumbAssetParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

that contains the assets.

updateArray types:ThumbAssetUpdateArray Yes The array of updates.

Output (batchSetThumbAssetParam)

Name Type Required Description

successCount xsd:int Yes The number of successfully set

thumbnails.

warningCount xsd:int Yes The number of warnings

generated when the operation
attempted to set the
thumbnails.

errorCount xsd:int Yes The number of errors

generated when the operation
attempted to set the
thumbnails.

warningDetailArray types:AssetOperationFaultArray No The array of details associated

with the assets that generated
warnings when the operation
attempted to apply the
updates.

errorDetailArray types:AssetOperationFaultArray No The array of details associated

with the assets that generated
errors when the operation
attempted to apply the
updates.

Examples
Request
<batchSetThumbAssetParam xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
<companyHandle>c|3</companyHandle>
<updateArray>
<items>
<assetHandle>a|234</assetHandle>
<thumbAssetHandle>a|189</thumbAssetHandle>
</items>
</updateArray>
Operations methods 42

Response
<batchSetThumbAssetReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
<successCount>1</successCount>
<warningCount>0</warningCount>
<errorCount>0</errorCount>
</batchSetThumbAssetReturn>

cdnCacheInvalidation
Forwards the supplied list of URLs to the Scene7 CDN (Content Distribution Network) provider to invalidate their existing
cache of HTTP responses.

cdnCacheInvalidation: About
CDN cache invalidation forces all HTTP requests for these URLs to be revalidated against the current published data on the
Scene7 network once this invalidation request is processed through the CDN network. Any URLs that are not connected to the
Scene7 service URL structure and directly matching the Scene7 company root ID assigned when the company is created will
result in an API fault for the entire request. Any invalid URLs that the CDN does not support that it considers invalid will also
result in an API fault for the entire request.

Frequency of Use: Rules

The rules governing the frequency of the use of this feature are controlled by Scene7's CDN partners. The CDN retains the
discretion to degrade the responsiveness of these invalidations to maintain optimum performance of its service to its users.
Should Scene7 be notified of overuse of this feature we will need to resort to disabling the feature on either a per company basis
or entirely across the service.

Confirmation Emails

Confirmation emails from the Scene7 CDN partner can be sent to the list's creator or up to 5 other email addresses. The API
sends the confirmation when the entire CDN network has been notified that the URLs referenced in the email have been cleared.
A single call to cdnCacheInvalidation can send multiple emails if the number of URLs supplied exceed the number that
Scene7 can deliver to the CDN partner on a single notification. Currently, that would be if the request exceeds 100 URLs, but
is subject to change based at the request of the CDN partner.

Supported Since

6.0

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin

Parameters
Input (cdnCacheInvalidationParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

connected with the URLs to
invalidate.
Operations methods 43

Name Type Required Description

urlArray types:UrlArray Yes List of up to 1000 URLs to

invalidate from the CDN
cache. All URLS must contain
the Scene7 company root ID
to be invalidated.

Output(cdnCacheInvalidationReturn)

Name Type Required Description

invalidationHandle xsd:string Yes A handle referencing the purge request.

The cdnCacheInvalidation API now

invalidates the cache almost immediately
(~5 seconds). As such, polling for
invalidation status is generally no longer
required.

estimatedSeconds xsd:int Yes Estimated seconds to completion of the

purge request. Clients should wait for
this time before polling status.

Example
This example requests four URLs to be invalidated in the CDN cache. The response contains summary counts of the success of
the operations and a list of error details supplied directly from the CDN to assist the client in use of this feature.

getCdnCacheInvalidationStatus operation.

Request
<cdnCacheInvalidationParam xmlns="http://www.scene7.com/IpsApi/xsd/2012-02-14">
<companyHandle>c|6</companyHandle>
<urlArray>
<items>http://s7d7.scene7.com/is/image/JJEsquire/11008047?$thumbnail$</items>
<items>http://s7d7.scene7.com/is/image/JJEsquire/11008047?$product$</items>
<items>http://s7d7.scene7.com/is/image/JJEsquire/11008047?$large$</items>

<items>http://s7d7.scene7.com/is/image/JJEsquire/ImageSetConfigDefaults?req=userdata</items>
</urlArray>
</cdnCacheInvalidationParam>

Response
<cdnCacheInvalidationReturn xmlns="http://www.scene7.com/IpsApi/xsd/2012-02-14">
<successCount>4</successCount>
<warningCount>0</warningCount>
<errorCount>0</errorCount>
</cdnCacheInvalidationReturn>

checkAssetNames
Checks for IPS ID conflicts by comparing asset names against all names a company's Image Serving/Image Rendering catalog
namespace.
Operations methods 44

Authorized User Types

• IpsUser
• IpsAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser
• ImagePortalUser
• TrialSiteAdmin
• TrialSiteUser

Parmaeters
Input (checkAssetNamesParam)

Name Type Required Description

companyHandle xsd:string No The handle to the company
that contains the user.
assetNamesArray types:StringArray Yes An array of asset names to
check.

Output (checkAssetNamesReturn)

Name Type Required Description

inUseNameArray types:StringArray Yes An array of asset names in use.

Examples
This sample code requests the asset names in use for a specified company. The response returns an array of asset names that are
in use.

Request
<checkAssetNamesParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-09-10">
<companyHandle>c|1</companyHandle>
<assetNameArray>
<items>ABC123</items>
<items>DEF456</items>
</assetNameArray>
</checkAssetNamesParam>

Response
<checkAssetNamesReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-09-10">
<inUseNameArray>
<items>DEF456</items>
</inUseNameArray>
</checkAssetNamesReturn>

checkLogin
Checks if a user with a specific company (identified by handle), email address, and password can log in.

Note: If the company handle is omitted, this method checks the login of the default user.
Operations methods 45

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (checkLoginParam)

Name Type Required Description

companyHandle xsd:string No The handle to the company

that contains the user.

email xsd:string Yes The user's email address.

password xsd:string Yes The user's password.

Output (checkLoginParam)

Name Type Required Description

status xsd:string Yes User's log in status.

Examples
This sample code uses a company handle parameter, email address, and a password to determine if a user can log in to IPS. If
the user can log in, this method returns the string, ValidLogin. If the user cannot log in, this method returns the string,
InvalidLogin.

Request
<ns1:checkLoginParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>137</ns1:companyHandle>
<ns1:email>juser3@scene7.com</ns1:email>
<ns1:password>welcome</ns1:password>
</ns1:checkLoginParam>

Response
<ns1:checkLoginReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:status>InvalidLogin</ns1:status>
</ns1:checkLoginReturn>

copyImage
Creates a copy of an existing image asset. The specified Image Server protocol commands are applied to generate the new copy
Operations methods 46

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (copyImageParam)

Name Type Required Description

companyName xsd:string Yes The handle to the company

that contains the image.

assetHandle xsd:string Yes The handle to the image asset.

folderHandle xsd:string Yes The handle to the folder where

the image is to be copied.

name xsd:string Yes Name of new image.

urlModifier xsd:string Yes

Output (copyImageParam)

Name Type Required Description

assetHandle xsd:string Yes The handle to the copied

image.

Examples
The sample code copies an image specified by company, asset, folder handle, and name.

Request
<copyImageParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<assetHandle>a|739|1|537</assetHandle>
<folderHandle>ApiTestCo/</folderHandle>
<name>Copy_macbookwin1</name>
<urlModifier/>
</copyImageParam>
Operations methods 47

Response
<copyImageReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<assetHandle>a|943|1|580</assetHandle>
</copyImageReturn>

createAssetSet
Creates a generic asset set with a raw set definition string to be published to an Image Server.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (createAssetSet)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

that will contain the asset set.

folderHandle xsd:string Yes The handle to the folder in

which the new asset set will be
created.

name xsd:string Yes Asset name.

subType xsd:string Yes A unique identifier created by

the client for the asset set type.

setDefinition xsd:string No The parameters in the set

definition string.
These must resolve to the
format specified by the target
viewer.

thumbAssetHandle xsd:string No Handle of the asset that acts as

the thumbnail for the new
image set. If not specified, IPS
tries to use the first image asset
referenced by the set.

Substitution Functions for setDefinition

You can specify substitution functions in line which are resolved during catalog lookup or publication. Substitution strings have
the format ${<substitution_func>}. Available functions are enumerated below.
Operations methods 48

Note: The handle literals in parameter lists must be surrounded by brackets ([]). All text that is outside of a substitution
string is copied verbatim to the output string during resolution.

Substitution Function Returns

getFilePath([asset_handle>]) The asset's master file path.

getCatalogId([<asset_handle>]) The asset's catalog ID.

getMetaData([<asset_handle>], Metadata values for the asset.

[<metadata_field_handle>])

getThumbCatalogId([<asset_handle>]) The asset's catalog ID (for image-based assets only).The

associated thumb asset's catalog ID (for other assets). If an
associated thumb asset is not available, the function returns an
empty string.

Sample Media setDefinition String

${getCatalogId([a|1664|22|1664])};${getCatalogId([a|1664|22|1664])};1,${getFilePath([a|103
6|19|144])};${getCatalogId([a|452|1|433])};2;${getMetadata([a|1036|19|144],
[m|1|ASSET|SharedDateField])}

At catalog lookup or publish time, this is resolved to a string similar to the following:
jcompany/myRenderSet;jcompany/myRenderSet;1,jcompany/Videos/Somebodys_N08275_flv.flv;jcomp
any/myimg-1;2;20090703 10:05:53

Output (createAssetSet)

Name Type Required Description

assetHandle xsd:string Yes The handle to the asset set.

Examples
Request
<createAssetSetParam xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
<companyHandle>c|1</companyHandle>
<folderHandle>f|jcompany/AssetSets/</folderHandle>
<name>testAssetSet</name>
<subType>MediaSet</subType>
</createAssetSetParam>

Response
<createAssetSetReturn xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
<assetHandle>a|1801|44|1801</assetHandle>
</createAssetSetReturn>

createDerivedAsset
Creates a new asset derived from an existing master image asset.
Derived assets specify Image Server protocol commands that modify the representation of the owner image. The AdjustedView
derived type helps apply simple modifications to a single image (for example, by specifying a crop rectangle), while the LayerView
helps create a multilayer view which may include text or additional images.
Operations methods 49

Unlike an image copy (see copyImage), a derived image is linked to its owner image. Changes to the owner image modifies
associated derived assets. Deleting the owner image will delete any associated derived images.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (createDerivedAssetParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

that contains the asset from
which you will derive the new
asset.

ownerHandle xsd:string Yes The handle to the master

Image asset from which the
new image will be derived.

folderHandle xsd:string Yes The handle to the folder in

which the new derived asset
will be created.

name xsd:string Yes The name of the derived asset.

type xsd:string Yes The asset type of the new

derived asset: AdjustedView
or LayerView.

urlModifier xsd:string No Image serving or image

rendering protocol commands
applied before the request or
urlPostApplyModifier
commands.

urlPostApplyModifier xsd:string No Image serving or image

rendering protocol commands
applied after to the request or
urlPostApplyModifier
commands.

Output (createDerivedAssetParam)
Operations methods 50

Name Type Required Description

assetHandle xsd:string Yes The handle to the derived

asset.

Examples
The sample code creates a derived asset with an adjusted view and urlModifier and urlPostApplyModifier with arbitrary
values. The response returns the handle to the newly derived asset.

Request
<createDerivedAssetParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<ownerHandle>a|943|1|580</ownerHandle>
<folderHandle>ApiTestCo/</folderHandle>
<name>ApiDerivedAsset</name>
<type>AdjustedView</type>
<urlModifier>modify=this</urlModifier>
<urlPostApplyModifier>action=awesome</urlPostApplyModifier>
</createDerivedAssetParam>

Response
<createDerivedAssetReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<assetHandle>a|944|10|2</assetHandle>
</createDerivedAssetReturn>

createFolder
Creates a folder.

Note: The new folder is subordinate to the Images folder, even if you specify a / to indicate the root of the company.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Note: The user must have read/write access to the parent folder.

Parameters
Input (createFolder)

Name Type Required Description

companyHandle xsd:string Yes The Handle to the company

folderPath xsd:string Yes The root folder used to retrieve

folders and all subfolders to the
Operations methods 51

Name Type Required Description

leaf level. If excluded, the

company root is used.

Output (createFolderParam)

Name Type Required Description

folderHandle xsd:string Yes Handle of the new folder.

Examples
This sample code creates a folder at the root of a company. The response returns the handle of the newly created folder.

Request
<ns1:createFolderParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:folderPath>/SpinSets</ns1:folderPath>
</ns1:createFolderParam>

Response
<ns1:createFolderReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<folderHandle xmlns="http://www.scene7.com/IpsApi/xsd">MyCompany/SpinSets/</folderHandle>
</ns1:createFolderReturn>

createImageSet
Creates an image set.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Note: The user must have read/write access to the destination folder.

Parameters
Input (createImageSetParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

that the image set belongs to.

folderHandle xsd:string Yes The handle to the folder.

name xsd:string Yes Image set name.

Operations methods 52

Name Type Required Description

type xsd:string Yes Image set type.

thumbAssetHandle xsd:string No Handle of the asset that acts as

the thumbnail for the new
image set. If not specified, IPS
tries to use the first image asset
referenced by the set.

Output

Name Type Required Description

assetHandle xsd:string Yes The handle to the new image

set.

Examples
This code sample creates an image set specified by company, folder, name, and type. The response is an asset handle of the newly
created image set.

Request
<ns1:createImageSetParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:folderHandle>MyCompany/eCatalogs/</ns1:folderHandle>
<ns1:name>My Image Set</ns1:name>
<ns1:type>ImageSet</ns1:type>
</ns1:createImageSetParam>

Response
<createImageSetReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<assetHandle>25741|22|841</assetHandle>
</createImageSetReturn>

createMetadataField
Lets administrators create new metadata fields to coordinate with content management systems or for template operations.
Examples of created metadata fields include keywords, information about the author of the image, or copyright holder information.

Authorized User Types

• IpsAdmin

Parameters
Input (createMetadataFieldParam)

Parameter name Type Required Description

companyName xsd:string Yes Name of the company the

metadata field belongs to.

assetType xsd:string Yes Asset type.

Operations methods 53

Parameter name Type Required Description

name xsd:string Yes Name of the metadata field

that you are creating.

fieldType xsd:string Yes Metadata field type.

The metadata field types

constant defines the available
types.

defaultValue xsd:string No
The default value of the
metadata field to be created
(for example, Scene 7).

Default values are not

supported for tag field types
and must be omitted. If a
non-empty default is specified
for a tag field type, a fault will
be returned.

isHidden xsd:boolean No Hide or expose IPS

system-specific metadata.

isEnforced xsd:boolean
No A boolean flag that indicates
whether the metadata field is
enforced (validated) when the
value is set.

If set to true, then a fault is

thrown if an illegal value is set
in setAssetMetadata
/batchSetAssetMetadata.

initialTagValue xsd:string No Allows you create a set of

shared enumerated values that
selected tags can point to.

Output (createMetadataFieldReturn)

Name Type Required Description

fieldHandle xsd:string Yes The handle to the new

metadata field.

Examples
This code sample creates a string type metadata field called createMetadataField. The response returns the handle to the
new metadata field.
Operations methods 54

Request
<createMetadataFieldParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|21</companyHandle>
<assetType>Image</assetType>
<name>createMetadataField</name>
<fieldType>String</fieldType>
<initialTagValue>Fall</initialTagValue>
<defaultValue>Default</defaultValue>
</createMetadataFieldParam>

Response
<createMetadataFieldReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<fieldHandle>m|21|IMAGE|createMetadataField</fieldHandle>
</createMetadataFieldReturn>

createProject
Creates a new project.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (createProjectParam)

Name Type Required Description

companyHandle xsd:string Yes The handle of the company

associated with the new
project.

projectName xsd:string Yes New project name.

Output (createProjectParam)

Name Type Required Description

projectHandle xsd:string Yes The handle to the new project.

Examples
This code sample creates a project called ApiTestProject in a company specified by its handle. The response returns the
handle to the project.

Request
<createProjectParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<projectName>ApiTestProject</projectName>
</createProjectParam>
Operations methods 55

<createProjectReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<projectHandle>p|6|ApiTestProject</projectHandle>
</createProjectReturn>

createPropertySet
Property sets are application-specific sets of name-value pairs that can be attached to various IPS objects, depending on the
property set type. If the property set type does not allow multiple sets to be attached to an object
(PropertySetType/allowMultipleisfalse) and the object already has an associated set of the same type, the new set will
replace the existing one.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (createPropertySetParam)

Name Type Required Description

typeHandle xsd:string Yes The handle to the property set

type.

primaryOwnerHandle xsd:string Yes The handle to the primary

owner of the property set.

secondaryOwnerHandle xsd:string No The handle to the secondary

owner of the property set.

propertyArray types:PropertyArray Yes The array of properties.

permissionArray types:PermissionUpdateArray

Output (createPropertySetParam)

Name Type Required Description

setHandle xsd:string Yes The handle to the new

property set.

Examples
This code sample creates a property set that contains names and values of properties. The response returns a handle to the new
property set.

Request
<createPropertySetParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<typeHandle>pt|10801</typeHandle>
<primaryOwnerHandle>u|41|strangio@adobe.com</primaryOwnerHandle>
<propertyArray>
<items>
<name>application_project_whatever</name>
Operations methods 56

<value>true</value>
</items>
<items>
<name>application_server_prefix_published_test</name>
<value>http://s7everest.macromedia.com:8080/is/image/</value>
</items>
<items>
<name>application_server_prefix_origin_test</name>
<value>http://s7everest:8080/is/image/</value>
</items>
</propertyArray>
</createPropertySetParam>

Response
<createPropertySetReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<setHandle>ps|941</setHandle>
</createPropertySetReturn>

createPropertySetType
A property set type specifies various settings used to help manage property sets.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (createPropertySetTypeParam)

Name Type Required Description

companyHandle xsd:string No The handle to the company

that owns the property set
type. If companyHandle is not
passed and the caller is an
IpsAdmin, a global property
set type will be created.

name xsd:string Yes The name of the property set

type.

propertyType xsd:string Yes Choice of property set types.

allowMultiple xsd:boolean Yes Determines if your program

can have multiple property
sets.

Output (createPropertySetTypeReturn)

Name Type Required Description

typeHandle xsd:string Yes A handle to the type.

Operations methods 57

Examples
This code sample creates a property set with a name and type specified by the PropertySet Types constant. The handle to
the company that owns the property set type. If companyHandle is not passed and the caller is an IpsAdmin, a global property
set type will be created.

Request
<createPropertySetTypeReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<typeHandle>pt|10803</typeHandle>
</createPropertySetTypeReturn>

Response
<createPropertySetTypeReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<typeHandle>pt|10801</typeHandle>
</createPropertySetTypeReturn>

createTemplate
Creates a layered image that can have multiple text and image layers.
The urlModifier parameter specifies the Image Server protocol commands stored in the Image Server catalog applied prior
to any user-supplied commands on the URL. The urlPostApplyModifier parameter specifies protocol commands applied
after any URL commands, which will override any conflicting user-supplied settings.

Authorized User Types

• IpsUser
• IpsAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (createTemplateParam)

Name Type Required Description

companyHandle xsd:string Yes The company that the template

belongs to.

folderHandle xsd:string Yes The folder handle that

represents the folder where the
template resides.

name xsd:string Yes Template name.

type xsd:string Yes Template type.

urlModifier xsd:string Yes Specifies the Image Server

commands stored in the IS
catalog that are applied prior
to any user-supplied
commands on the URL.
Operations methods 58

Name Type Required Description

urlPostApplyModifier xsd:string No Specifies protocol commands

applied after any URL
commands, which will
override any conflicting
user-supplied settings.

Output (createTemplateParam)

Name Type Required Description

assetHandle xsd:string Yes The handle to the template.

Examples
This code sample creates a template in a folder specified by a handle, with a name of APIcreateTemplate, a urlModifier,
and a urlPostApplyModifier. The response returns the handle to the newly created template.

Request
<createTemplateParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|21</companyHandle>
<folderHandle>ApiTestCo/</folderHandle>
<name>APIcreateTemplate</name>
<type>Template</type>
<urlModifier>url=Modifier</urlModifier>
<urlPostApplyModifier>urlPostApply=Modifier</urlPostApplyModifier>
</createTemplateParam>

Response
<createTemplateReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<assetHandle>a|153393|2|2061</assetHandle>
</createTemplateReturn>

createViewerPreset
Creates a preset view that determines what a user can see. The viewer can be of any type available in IPS. The preset view is
applied when the assets are published.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (createViewerPresetParam)
Operations methods 59

Name Type Required Description

companyHandle xsd:string Yes The handle of the company

that contains the viewer presets
and assets.

folderHandle xsd:string Yes The handle of the folder that

contains the assets.

name xsd:string Yes Viewer name.

type xsd:string Yes Viewer type.

configSettingArray types:ConfigSettingArray No An array that contains names,

values, and handles of images
that you're applying presets to.

Output (createViewerPresetReturn)

Name Type Required Description

viewerPresetHandle xsd:string Yes Handle of the preset to the

viewer.

Examples
This code sample creates a video player preset. The response returns a handle to the preset.
<createViewerPresetParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|0</companyHandle>
<folderHandle>Scene7SharedAssets/</folderHandle>
<name>eVideo4</name>
<type>VideoPlayer</type>
<configSettingArray>
<items>
<name>Video Bit Rate</name>
<value>393334.6508779093</value>
</items>
<items>
<name>Audio Sample Rate</name>
<value>44100</value>
</items>
...
<items>
<name>vidPaneWidth</name>
<value>0</value>
</items>
</configSettingArray>
</createViewerPresetParam>

Response
<createViewerPresetReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<viewerPresetHandle>a|151760|40|151760</viewerPresetHandle>
</createViewerPresetReturn>

createVignettePublishFormat
Creates a new publish format for a vignette.
Operations methods 60

Vignette formats specify the size of published vignettes and their thumbnails, as well as zoom levels, sharpening parameters,
and the file format version for vignettes produced from master vignettes published to an Image Rendering server from IPS.

Newer Image Rendering server versions can support pyramid vignettes, which eliminates the need to define specific vignette
format sizes for publishing.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (createVignettePublishFormatParam)

Name Type Required Description

companyHandle xsd:string Yes Handle to the company the

vignette belongs to.

name Yes Name to identify the vignette

publishing format.

targetWidth Yes
Specifies the target width of the
resulting vignette view in
pixels.

Use zero so the output vignette

has the same size as the master
vignette.

targetHeight Yes Creates a pyramid vignette

optimized for zooming on the
Image Rendering server.
Starting at the maximum size,
set by the Target Vignette Size
fields, this creates multiple size
views in a single vignette
output file. Each subsequent
view size is halved until the
width and height are within
128x128 pixels.

createPyramid Yes Specifies the width of each

resulting thumbnail in pixels.
This setting is optional. Leave
as zero for no thumbnail file.

thumbWidth Yes Specifies the file format for the

published vignettes. Given a
Operations methods 61

Name Type Required Description

new version of Image

Authoring and an oler version
of the Image Rendering Server,
you must specify a vignette
version that your
ImageRendering Server can
read. If you specify a higher
version, the Image Rendering
server cannot read the
published vignettes. Set to zero
to publish vignettes at the
latest version.

saveAsVersion Yes Specifies the character the

separates the vignette name
and the suffix indicating its
width.

sizeSuffixSeparator Yes Specifies the character the

separates the vignette name
and the suffix indicating its
width.

sharpen No Applies sharpening to the

main view image for each
puvlish vignette size
Sharpening can compensate
for blurring when the
vignetters are scaled.

usmAmount Yes Digital unsharp masking is a

flexible and powerful way to
increase sharpness, especially
in scanned images. This
controls the magnitude of each
overshoot (how much darker
and light the edge borders
become).

usmRadius Yes Affects the size of the edges to

be enhanced or how wide the
edge rims become, so a smaller
radium enhances smaller-scalle
detail. Higher radius values can
cause halos at the edges. Fine
detail needs a smaller radius as
tiny detail of the same size or
smaller than the radius is lost.
Operations methods 62

Name Type Required Description

usmThreshold Yes Controls the minimum

brightness change to be
sharpened or how far apart
adjacent tonal values must be
before the filter works. This
setting can sharpen more
pronouced edges while leaving
more subtle edges untouched.
THe allowable range of
threshold of 0 to 255.

Output (createVignettePublishFormatReturn)

Name Type Required Description

vignetteFormatHandle xsd:string Yes The handle to the created

vignette format.

Examples
This code creates vignette publish format. The creation request specifies a name, target width and height, and other required
values.

Request
<createVignettePublishFormatParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|21</companyHandle>
<name>APIcreateVignettePublishFormat1</name>
<targetWidth>1200</<targetWidth>
<targetHeight>800</targetHeight>
<createPyramid>true</createPyramid>
<thumbWidth>400</thumbWidth>
<saveAsVersion>0</saveAsVersion>
<sizeSuffixSeparator>-</sizeSuffixSeparator>
<sharpen>50</sharpen>
<usmAmount>230.0</usmAmount>
<usmRadius>1.1</usmRadius>
<usmThreshold>130</usmThreshold>
</createVignettePublishFormatParam>

Response
<createVignettePublishFormatReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<vignetteFormatHandle>v|21|282</vignetteFormatHandle>
</createVignettePublishFormatReturn>

deleteAsset
Deletes an asset.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
Operations methods 63

• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Note: The user must have read and delete access to the asset.

Parameters
Input (deleteAssetParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company to

which the folder belongs.

assetHandle xsd:string Yes The handle to the asset to

delete.

Output (deleteAssetParam)

The IPS API does not return a response for this operation.

Examples
This sample code deletes any type of asset from a specific company. It requires an asset handle, which you must obtain from
another operation.

Request
<ns1:deleteAssetParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:assetHandle>24265|1|17061</ns1:assetHandle>
</ns1:deleteAssetParam>

Response

None.

deleteAssets
Deletes multiple assets.

Authorized user types

• IpsUser
• IspAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (deleteAssetsParam)
Operations methods 64

Name Type Required Description

companyHandle xsd:string Yes The handle to the company the

assets belong to.

assetHandleArray types:HandleArray Yes The array of assets to be

deleted.

Output (deleteAssetsParam)

Name Type Required Description

successCount xsd:int Yes The number of successfully

deleted assets.

warningCount xsd:int Yes The assets that generated a

warning when the operation
tried to delete them.

errorCount xsd:int Yes The assets that generated an

error when the operation tried
to delete them.

warningDetailArray types:AssetOperationFaultArray No The array of details associated

with the assets that generated
a warning when the operation
tried to delete them.

errorDetailArray types:AssetOperationFaultArray No The array of details associated

with the assets that generated
an error when the operation
tried to delete them.

Examples
This code sample sends a handle to a company and an array of asset handles in a deleteAssetsParam request to the Web
services server. deleteAssetsReturn returns a success count of 2, indicating both assets were deleted.

Request
<deleteAssetsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<assetHandleArray>
<items>a|942|1|579</items>
<items>a|943|1|580</items>
</assetHandleArray>
</deleteAssetsParam>
Operations methods 65

Response
<deleteAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<successCount>2</successCount>
<warningCount>0</warningCount>
<errorCount>0</errorCount>
</deleteAssetsReturn>

deleteAssetMetadata
Deletes metadata values for an asset. Works with an array of metadata delete to set values in a batch.

Authorized user types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Note: The user must have read and delete access to the asset.

Parameters
Input (deleteAssetMetadataParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company to

which the folder belongs.

assetHandle xsd:string Yes The handle to the asset to

delete.

metadataDelete xsd:string Yes Metadata to delete from the

asset.

deleteArray types:MetadataDeleteArray Yes Array of metadata to delete

from the asset.

Output (deleteAssetMetadataParam)

The IPS API does not return a response for this operation.

Examples
MetadataDelete
<complexType name="MetadataDelete">
<sequence>
<element name="fieldHandle" type="xsd:string"/>
Operations methods 66

</sequence>
</complexType>

Example call
<ac:Request id="deleteAssetMetadata">
<deleteAssetMetadataParam xmlns="http://www.scene7.com/IpsApi/xsd/2013-08-29-beta">
<companyHandle>c|101</companyHandle>
<assetHandle>a|202</assetHandle>
<deleteArray>
<items>
<fieldHandle>m|2919|ASSET|UntypedUDFField1395788289789</fieldHandle>
</items>
</deleteArray>
</deleteAssetMetadataParam>
</ac:Request>

deleteFolder
Deletes a folder.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Note: The user must have read and delete access to the folder and all of its children.

Parameters
Input (deleteFolderParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company to

which the folder belongs.

folderHandle xsd:string Yes The handle to the folder to

delete.

Output (deleteFolderParam)

The IPS API does not return a response for this operation.

Examples
This sample code deletes a folder from the root of the company. It requires a folder handle, which you must obtain from another
operation.

Request
<ns1:deleteFolderParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
Operations methods 67

<ns1:folderHandle>MyCompany/SpinSets/</ns1:folderHandle>
</ns1:deleteFolderParam>

None.

deleteGroup
Deletes a group.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (deleteGroupParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

that belongs to the group that
you want to delete.

groupHandle xsd:string Yes The handle to the group that

you want to delete.

Output (deleteGroupParam)

The IPS API does not return a response for this operation.

Examples
This sample code deletes a group from a company. It requires a group handle, which you must obtain from another operation.

Request
<ns1:deleteGroupParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:groupHandle>241</ns1:groupHandle>
</ns1:deleteGroupParam>

Response

None.

deleteImageFormat
Deletes an image format. Get the image format handle from saveImageFormat.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
Operations methods 68

Parameters
Input (deleteImageFormatParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

that contains the image format
that you want to delete.

imageFormatHandle xsd:string Yes The handle to the image

format you want to delete.

Output (deleteImageFormatParam)

The IPS API does not return a response for this operation.

Examples
This code sample deletes an image format from a company. Obtain the image format handle from another operation.

Request
<deleteImageFormatParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
<imageFormatHandle>47|301</imageFormatHandle>
</deleteImageFormatParam>

Response

None.

Related Topic:

saveImageFormat

deleteImageMap
Deletes an image map.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Note: The user must have read and write access to the asset.

Parameters
Input (deleteImageMapParam)
Operations methods 69

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

that contains the image map to
delete.

imageMapHandle xsd:string Yes The handle to the image map

to delete.

Output (deleteImageMapParam)

The IPS API does not return a response for this operation.

Examples
This code sample deletes an image map from a company. You must obtain the image map handle from another operation.

Request
<deleteImageMapParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
<imageMapHandle>34191|8|554</imageMapHandle>
</deleteImageMapParam>

Response

None

deleteJob
Deletes a current or scheduled job.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (deleteJobParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company to

which the job belongs.

jobHandle xsd:string Yes The handle to the job to delete.

Output
Operations methods 70

The IPS API does not return a response for this operation.

Examples
This code sample deletes a job that is running or is scheduled to run in IPS. It requires a job handle, which you must obtain
from another operation.

Request
<deleteJobParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
<jobHandle>47|My Test Job|</jobHandle>
</deleteJobParam>

Response

None.

deleteMetadataField
Deletes a company's metadata field.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (deleteMetadataFieldParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

that contains the metadata
field to be deleted.

fieldHandle xsd:string Yes The handle to the metadata

field to be deleted.

Output (deleteMetadataFieldParam)

The IPS API does not return a response for this operation.

Examples
This code sample deletes a company's metadata field. It uses the company handle and metadata handle as fields in the
deleteMetadataFieldParam passed in to the IPS Web services server to perform this action.

Request
<deleteMetadataFieldParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<fieldHandle>m|6|IMAGE|saveMetadataField</fieldHandle>
</deleteMetadataFieldParam>

Response
Operations methods 71

None.0

deleteProject
Deletes a project from a company. The links between the assets and the project are broken, but the assets are not deleted from
IPS.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (deleteProjectParam)

Name Type Required Description

companyName xsd:string Yes The name of the company

associated with the project.

projectHandle xsd:string Yes The handle to the project to be

deleted.

Output (deleteProjectReturn)

The IPS API does not return a response for this operation.

Examples
This code sample uses the company handle and the project handle as fields in the deleteProjectParam sent to the IPS Web
services server in order to delete the project.

Request
<deleteProjectParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<projectHandle>p|6|ProjectTestAPI</projectHandle></deleteProjectParam>

Response

None.

deletePropertySet
Deletes a property set and all associated properties.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
Operations methods 72

• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (deletePropertySetParam)

Name Type Required Description

setHandle xsd:string Yes The handle to the property set

to be deleted.

Output (deletePropertySetParam)

The IPS API does not return a response for this operation.

Examples
This code sample uses the set’s handle as a field in the deletePropertySetParam sent to the IPS Web services server in order
to delete the property set.

Request
<deletePropertySetParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<setHandle>ps|941</setHandle>
</deletePropertySetParam>

Response

None.

deletePropertySetType
Deletes a property set type and its associated property set and properties.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (deletePropertySetTypeParam)

Name Type Required Description

typeHandle xsd:string Yes The handle to the property set

type to be deleted.

Output (deletePropertySetTypeParam)

The IPS API does not return a response for this operation.
Operations methods 73

Examples
This code sample uses the type’s handle as a field in the deletePropertySetTypeParam sent to the IPS Web services server
in order to delete the property set type.

Request
<deletePropertySetTypeParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<typeHandle>pt|10801</typeHandle>
</deletePropertySetTypeParam>

Response

None.

deleteTagFieldValues
Removes tag field values from the dictionary of a tag field.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (deleteTagFieldValuesParam)

Name Type Required Description

companyHandle xsd:string Yes The handle of the company

containing the tag field.

fieldHandle xsd:string Yes The handle of the tag field to

be modified.

valueArray types:StringArray Yes An array of tag values to be

deleted from the field’s
dictionary.

Output (deleteTagFieldValuesParam)

The IPS API does not return a response for this operation.

Examples
Request
deleteTagFieldValuesParam xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
<companyHandle>c|3</companyHandle>
<fieldHandle>m|3|ASSET|SingleFixedTag</fieldHandle>
<valueArray>
<items>Pineapple</items>
<items>Banana</items>
</valueArray>
</deleteTagFieldValuesParam>

Response
Operations methods 74

None.

deleteVignettePublishFormat
Deletes a vignette publish format.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (deleteVignettePublishFormatParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company to

which the vignette belongs.

vignetteFormatHandle xsd:string Yes The handle to the vignette

publish format to be deleted.

Output (deleteVignettePublishFormatParam)

The IPS API does not return a response for this operation.

Examples
This code sample deletes a vignette publish format specified by its handle.

Request
<deleteVignettePublishFormatParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|21</companyHandle>
<vignetteFormatHandle>v|21|282</vignetteFormatHandle>
</deleteVignettePublishFormatParam>

Response
None.

deleteZoomTarget
Deletes a zoom target.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
Operations methods 75

• ImagePortalContribUser

Note: The user must have read and write access to the asset.

Parameters
Input (deleteZoomTargetParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company to

which the zoom target belongs.

zoomTargetHandle xsd:string Yes The handle to the zoom target

to delete.

Output (deleteZoomTargetParam)
The IPS API does not return a response for this operation.

Example
This code sample deletes a zoom target from a company.

Request
<ns1:deleteZoomTargetParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:zoomTargetHandle>34194|9|301</ns1:zoomTargetHandle>
</ns1:deleteZoomTargetParam>

Response

None.

emptyAssetsFromTrash
Empties assets from the IPS trash.
Assets live in the trash until they are manually emptied or until they time out of the trash. If they are manually emptied, they
live in the Trash until the next cleanup job (normally nightly) when they are finally purged from the system. If they time out of
the trash, assets are cleaned off as part of that same cleanup activity. The time out is configurable (defaults is 7 days).

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser
•
Operations methods 76

Parameters
Input (emptyAssetsFromTrashParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

that owns the assets.

assetHandleArray types:HandleArray Yes The array of handles that

represent the items to be
emptied from the trash.

Output (emptyAssetsFromTrashParam)

Name Type Required Description

successCount xsd:Int Yes The number of assets

successfully emptied from the
trash.

warningCount xsd:Int Yes The number of warnings

generated when the operation
attempted to empty assets from
the trash.

errorCount xsd:Int Yes The number of errors

generated when the operation
attempted to empty assets from
the trash.

warningDetailArray types:AssetOperationFaultArray No The array of details associated

with the assets that generated
warnings when the operation
attempted to empty them from
the trash.

errorDetailArray types:AssetOperationFaultArray No The array of details associated

with the assets that generated
errors when the operation
attempted to empty them from
the trash.

Examples
This code sample uses the company’s handle and an asset handle array that contains handles to the assets to be emptied from
the trash.

Request
<emptyAssetsFromTrashParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<assetHandleArray>
<items>a|942|1|579</items>
<items>a|943|1|580</items>
Operations methods 77

</assetHandleArray>
</emptyAssetsFromTrashParam>

Response
<emptyAssetsFromTrashReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<successCount>2</successCount>
<warningCount>0</warningCount>
<errorCount>0</errorCount>
</emptyAssetsFromTrashReturn>

executeJob
Runs a specific job.

Authorized User Types

• IpsUser
• IpsAdmin
• TrialSiteAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (executeJobParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company to

which the job belongs.

jobHandle xsd:string Yes The handle to the job to run.

Output (executeJobReturn)

The IPS API does not return a response for this operation.

Examples
This code sample runs a job that is scheduled to run in IPS.

Request
<executeJobParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
<jobHandle>47|My Test Job|</jobHandle>
</executeJobParam>

Response
Operations methods 78

None.

forceRepublishAssets
Resets the publish status for one or more assets to force the asset to be republished in the next publish job.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (forceRepublishAssetsParam)

Name Type Required Description

companyHandle xsd:string
Yes Handle to the company
containing assets to reset.

republishFiles xsd:boolean
No Designates that the files for the
asset are republished to the
delivery servers. Defaults to
true.

resyncCatalog xsd:boolean
No Designates that the catalog
metadata used to serve the asset
is synced to guarantee that it is
current. This parameter is used
to resolve race conditions that
might occur on near concurrent
updates to the same record.
Defaults to false.

assetHandleArray types:HandleArray
Yes Array of handles to assets
whose publish status is to be
reset.

Output (forceRepublishAssetsParam)

Name Type Required Description

publishStateUpdateArray types:PublishStateUpdateArray
Yes Array of publish state updates.
Operations methods 79

generatePassword
Generates a new password.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (generatePasswordParam)

None.

Output (generatePasswordParam)

Name Type Required Description

password xsd:string Yes A new password.

Examples
This code sample generates a password. It is unusual because the request is simply a parameter without any enclosed elements
or values. IPS returns a strong password.

Request
<generatePasswordParam xmlns="http://www.scene7.com/IpsApi/xsd">
</generatePasswordParam>

Response
<generatePasswordReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<password>1\7aQRn]</password>
</generatePasswordReturn>

getActiveJobs
Gets all currently active jobs.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
Operations methods 80

• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getActiveJobsParam)

Name Type Required Description

companyHandle xsd:string No The handle to the company.

jobHandle xsd:string No The handle to the job.

originalName xsd:string No Original job name.

Output (getActiveJobsReturn)

Name Type Required Description

jobArray xsd:string Yes Array of active jobs.

Examples
This code sample returns all active jobs of a company running in IPS. In this case, the response is unusual because the IPS
scheduling coordinator is disabled with no active jobs running. Under normal circumstances, the response would return a
number of active jobs.

Request
<ns1:getActiveJobsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
</ns1:getActiveJobsParam>

Response
<getActiveJobsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<jobArray></jobArray>
</getActiveJobsReturn>

getActivePublishContext
Gets a list of active publish contexts for the specified company. A publish context is considered active if there is at least one
active server defined for the context.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
Operations methods 81

• ImagePortalContribUser

Parameters
Input (getActivePublishContextsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company to

query for active publish
contexts

Output (getActivePublishContextsReturn)

Name Type Required Description

contextArray types:StringArray Yes The array of active publish

contexts, which may include
zero or more values from
Publish Context.

getAllCompanies
Returns an array of all companies.

Authorized User Types

• IpsAdmin

Parameters
Input (getAllCompaniesParam)

Name Type Required Description

includeExpired xsd:boolean Yes Set to true to return expired

and non-expired companies.

Output (getAllCompaniesReturn)

Name Type Required Description

companyArray types:CompanyArray Yes The array of companies.

Examples
This code sample returns all companies in IPS in an array. Note, the sample response is truncated for brevity.

Request
<ns1:getAllCompaniesParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:includeExpired>false</ns1:includeExpired>
</ns1:getAllCompaniesParam>
Operations methods 82

Response
<ns1:getAllCompaniesReturnxmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyArray>
<ns1:items>
<ns1:companyHandle>18</ns1:companyHandle>
<ns1:name>00webload</ns1:name>
<ns1:rootPath>00webload/</ns1:rootPath>
<ns1:expires>2101-02-01T07:00:00.667Z</ns1:expires>
</ns1:items>
<ns1:items>
<ns1:companyHandle>19</ns1:companyHandle>
<ns1:name>01webload</ns1:name>
<ns1:rootPath>01webload/</ns1:rootPath>
<ns1:expires>2101-02-01T07:00:00.414Z</ns1:expires>
</ns1:items>
. . .
</ns1:companyArray>
</ns1:getAllCompaniesReturn>

getAllUsers
Gets all users in an array.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (getAllUsersParam)

Name Type Required Description

includeInvalid xsd:boolean Yes Set to:

• true to include invalid users.
• false to omit invalid users.

Output (getAllUsersReturn)

Name Type Required Description

userArray types:UserArray Yes Array of all users.

Examples
This code sample returns all users. The response is truncated for brevity.

Request
<ns1:getAllUsersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:includeInvalid>false</ns1:includeInvalid>
</ns1:getAllUsersParam>
Operations methods 83

Response
<ns1:getAllUsersReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:userArray>
<ns1:items>
<ns1:userHandle>201|agentshadi@hotmail.com</ns1:userHandle>
<ns1:firstName>333</ns1:firstName>
<ns1:lastName>333</ns1:lastName>
<ns1:email>my_email@someaddress.com</ns1:email>
<ns1:role>TrialSiteUser</ns1:role>
<ns1:isValid>true</ns1:isValid>
<ns1:passwordExpires>2006-12-29T04:19:43.039Z</ns1:passwordExpires>
</ns1:items>
...
</ns1:userArray>
<ns1:getAllUsersReturn>

getAssetCounts
Gets the assets and the number of assets associated with a specific company.
The countArray returned consists of an array of assetTypes (data type xsd:string), each with its own count field (data
type xsd:int), allowing the representation of multiple asset types per element of the array.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getAssetCountsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

with assets you want to count.

Output (getAssetCountsReturn)

Name Type Required Description

countArray types:AssetCountArray No An array of asset types, each

with its own count field,
allowing the representation of
multiple asset types per
element of the array.
Operations methods 84

Examples
This code sample uses the company’s handle as a field in the getAssetCountsParam sent to the IPS Web services server in
order to get the asset counts.

Request
<getAssetCountsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
</getAssetCountsParam>

Response
<getAssetCountsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<countArray>
<items>
<assetType>Image</assetType>
<count>44</count>
</items>
<items>
<assetType>Flash</assetType>
<count>3</count>
</items>
</countArray>
</getAssetCountsReturn>

getAssetJobLogs
Gets the job logs for an asset. Items returned in the array contain detailed information about each entry in the job log for that
asset. The logMessage response field is localized based on the authHeader field.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getAssetJobLogsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company to

which the asset belongs.

assetHandle xsd:string Yes The handle to asset with the

job logs to be retrieved.

Output (getAssetJobLogsReturn)
Operations methods 85

Name Type Required Description

jobLogArray types:AssetJobLogArray Yes Job log array.

Examples
This code sample retrieves the job logs of a specific asset. The response returns a job log array with detailed information about
all of the jobs in which the asset was used.

Request
<getAssetJobLogsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<assetHandle>a|732|1|535</assetHandle>
</getAssetJobLogsParam>

Response
<getAssetJobLogsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<jobLogArray>
<items>
<jobHandle>j|6||Add_2007-10-24-16:11:07</jobHandle>
<jobName>Add_2007-10-24-16:11:07</jobName>
<logMessage>ApiTestCo/blakexslttest.jpg was processed into IPS</logMessage>
<logType>UploadSuccess</logType>
<submitUserEmail>strangio@adobe.com</submitUserEmail>
<logDate>2007-10-24T16:12:32.297-07:00</logDate>
</items>
<items>
<jobHandle>j|6||submitServerUploadJob40_2008-06-11-11:38</jobHandle>
<jobName>submitServerUploadJob40_2008-06-11-11:38</jobName>
<logMessage>ApiTestCo/blakexslttest.jpg was processed into IPS.</logMessage>
<logType>FileUpdated</logType>
<submitUserEmail>strangio@adobe.com</submitUserEmail>
<logDate>2008-06-11T11:38:48.547-07:00</logDate>
</items>
</jobLogArray>
</getAssetJobLogsReturn>

getAssetMetadataFields
Returns all metadata fields, grouped by asset type.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getAssetMetadataFieldsParam)
Operations methods 86

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

whose metadata you want to
retrieve.

Output (getAssetMetadataFieldsReturn)

Name Type Required Description

assetFieldArray types:AssetMetadataFieldsArray Yes Array of metadata fields, by

asset type.

Examples
Request
<getAssetMetadataFieldsParam xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
<companyHandle>c|1</companyHandle>
</getAssetMetadataFieldsParam>

Response

Note: Truncated for brevity.

<getAssetMetadataFieldsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
<assetFieldsArray>
<items>
<assetType>Asset</assetType>
</items>
</assetFieldsArray>
<getAssetMetadataFieldsReturn>

getAssetPublishHistory
Returns the publish history for an asset.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getAssetPublishHistoryParam)
Operations methods 87

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

with the asset publish history.

assetHandle xsd:string Yes The asset with the publish

history you want to examine.

Output (getAssetPublishHistoryReturn)

Name Type Required Description

pubHistoryArray types:PublishHistoryArray Yes The asset's publish history.

Examples
This code sample returns the publish history of an asset. An asset has never been published if the server returns an empty array.

Request
<getAssetPublishHistoryParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<assetHandle>a|732|1|535</assetHandle>
</getAssetPublishHistoryParam>

Response
<getAssetPublishHistoryReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<pubHistoryArray/>
</getAssetPublishHistoryReturn>

getAssets
Returns assets from IPS.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Note: Only returns those assets the user has access to.

Parameters
Input (getAssetParam)
Operations methods 88

Name Type Required Description

companyHandle xsd:string Yes The company handle.

accessUserHandle xsd:string No Impersonate a specific user.

Used by administrators only.

accessGroupHandle xsd:string No Filter by group.

assetHandleArray xsd:HandleArray Yes The root folder to retrieve

folders and all subfolders to the
leaf level. If excluded, the
company root is used.

responseFieldArray types:StringArray No Fields and sub-fields included

in the response.

excludeFieldArray types:StringArray Fields and sub-fields excluded

from the response.

Outpub (getAssetsReturn)

Name Type Required Description

assetArray types:AssetArray No Array of assets matching the

filter criteria.

getAssetsByName
Returns assets based on an array of asset names.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
Operations methods 89

• ImagePortalContrib
• ImagePortalContribUser

Note: Only returns assets to which the user has read access.

Parameters
Input (getAssetsByNameParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company.

accessUserHandle xsd:string No Provides access as another

user. Available to
administrators only.

accessGroupHandle xsd:string No Used to filter by a specific

group.

nameArray types:StringArray Yes Array of asset names to

retrieve.

assetTypeArray types:StringArray No Array of asset types allowed for

retrieved assets.

excludeAssetTypeArray types:StringArray No Array of Asset Types excluded

for retrieved assets.

assetSubTypeArray types:StringArray No Array of asset subtypes allowed

for retrieved assets.

strictSubTypeCheck xsd:boolean No
If true and
assetSubTypeArray is not
empty, only assets whose
subtypes are in
assetSubTypeArray are
returned.

If false, then assets with no

defined subtype are included.

The default value is false.

responseFieldArray types:StringArray No Contains a list of fields and

subfields included in the
response.

excludeFieldArray types:StringArray No Contains a list of fields and

subfields excluded from the
response.

Output (getAssetsByNameReturn)
Operations methods 90

Name Type Required Description

assetArray types:AssetArray No Array of assets that match the

filter criteria.

Examples
This code sample returns two image type assets.

Request
<getAssetsByNameParam xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
<companyHandle>c|3</companyHandle>
<nameArray>
<items>B010</items>
<items>IMG_0103</items>
</nameArray>
<assetTypeArray>
<items>Image</items>
</assetTypeArray>
</getAssetsByNameParam>

Response
<getAssetsByNameReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
<assetArray>
<items>
<assetHandle>a|210</assetHandle>
<type>Image</type>
<name>B010</name>
...</items>
<items>
<assetHandle>a|189</assetHandle>
<type>Image</type>
<name>IMG_0103</name>
...
</items>
</assetArray>
</getAssetsByNameReturn>

getAssociatedAssets
Gets assets associated with a specified asset and details about their relationship.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getAssociatedAssetsParam)
Operations methods 91

Name Type Required Description

companyHandle xsd:string Yes Handle to the company that

owns the asset.

assetHandle xsd:string Yes Asset handle.

responseFieldArray types:StringArray No The array of response fields

desired. See response-
FieldArray/excludeFieldArray
in the Introduction.

excludeFieldArray types:StringArray No The array of excluded response

fields. See response-
FieldArray/excludeFieldArray
in the Introduction.

Output (getAssociatedAssetsReturn)

Name Type Required Description

containerArray types:AssetArray
No Array of set and template
assets containing the speci-
fied asset.

memberArray types:AssetArray
No Array of assets contained by
the specified set or template
asset.

layerReferenceArray types:AssetArray
No Array of assets referenced in a
layer or template URL.

ownerArray types:AssetArray
No Array of assets that own the
specified asset.

derivedArray types:AssetArray
No Array of assets that were used
to generate the specified asset.

generatorArray types:GenerationInfoArray
No The generatorArray lists
the way this asset was created.
For example, if
assetHandler was an image
page of a PDF, then this would
contain the PDF processor tool
and reference the PdfFile asset.
Operations methods 92

Name Type Required Description

generatedArray types:GenerationInfoArray
No The generatedArray inverts
the way this asset was created.
For example, the
generatedArray could
contain the list of images
generated from this
assetHandler if this was a
PdfFile asset.

thumbAsset types:Asset
No The thumb asset information
associated with the request
asset. If no thumb asset is
assigned, the field is omitted
in the response.

You can use the parameters responseFieldArray or excludeFieldArray to limit the response size. In particular, the
GenerationInfo items returned in generatorArray or generatedArray default to include both the originator and the
generated asset records. For a PDF asset type, this behavior results in unwanted multiple copies of the "originator" PDF asset
record in the response. You can eliminate this issue by adding generatedArray/items/originator to excludeFieldArray.
Or, you can specify an explicit list of response fields that you want to include in responseFieldArray.

Examples
The following basic example is a request for the handle of the generator for an image that is extracted from a PDF. It includes
a containerArray of length one with an item including the assetHandle of the PDF.

Request
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:beta="http://www.scene7.com/IpsApi/xsd/2013-08-29-beta">
<soap:Body>
<beta:getAssociatedAssetsParam>
<beta:companyHandle>c|11</beta:companyHandle>
<beta:assetHandle>a|197</beta:assetHandle>
<beta:responseFieldArray>
<beta:items>containerArray/items/assetHandle</beta:items>
</beta:responseFieldArray>
</beta:getAssociatedAssetsParam>
</soap:Body>
</soap:Envelope>

Response
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
<soapenv:Body>
<getAssociatedAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2013-08-29-beta">
<containerArray>
<items>
<assetHandle>a|207</assetHandle>
</items>
</containerArray>
</getAssociatedAssetsReturn>
</soapenv:Body>
</soapenv:Envelope>
Operations methods 93

The inverse of the example above is the following:

Request
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:beta="http://www.scene7.com/IpsApi/xsd/2013-08-29-beta">
<soap:Body>
<beta:getAssociatedAssetsParam>
<beta:companyHandle>c|11</beta:companyHandle>
<beta:assetHandle>a|177</beta:assetHandle>
<beta:responseFieldArray>
<beta:items>generatedArray/items/originator/assetHandle</beta:items>
</beta:responseFieldArray>
</beta:getAssociatedAssetsParam>
</soap:Body>
</soap:Envelope>

Response
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
<soapenv:Body>
<getAssociatedAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2013-08-29-beta">
<generatedArray>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
Operations methods 94

<assetHandle>a|177</assetHandle>
</originator>
</items>
</generatedArray>
</getAssociatedAssetsReturn>
</soapenv:Body>
</soapenv:Envelope>

In this next example, a group is added to a company with groupHandleArray. This example uses one group only.

Request
<ns1:addGroupMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:groupHandleArray><ns1:items>225</ns1:items></ns1:groupHandleArray>
</ns1:addGroupMembershipParam>

Response

None.

getAutoCropRect
Returns a cropped region for an image based on its background color or transparency.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• IpsUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getAutoCropRectParam)

Note: Specify either autoColorCropOptions or autoTransparentCropOptions when calling this method.

Name Type Required Description

companyHandle xsd:string Yes The handle to the company with the

asset you want to work with.

assetHandle xsd:string Yes The handle to the asset you want to

work with.

autoColorCropOptions types:AutoColorCropOptions No Compute crop rectangle based on

color. See AutoColorCropOptions.

autoTransparentCropOptions types:AutoTransparentCropOptions No Compute crop rectangle based on

transparency. See
AutoTransparentCropOptions.

Output (getAutoCropRectReturn)
Operations methods 95

Name Type Required Description

xOffset xsd:int Yes The starting left pixels coordinate of the

computed crop region.

yOffset xsd:int Yes The starting top pixel coordinate of the

computed crop region.

width xsd:int Yes Width of the computed crop region (in pixels).

height xsd:int Yes Height of the computed crop region (in pixels).

Examples
Request
<getAutoCropRectParam xmlns="http://www.scene7.com/IpsApi/xsd/2012-07-31-beta">
<companyHandle>c|3578</companyHandle>
<assetHandle>a|3192146</assetHandle>
<autoColorCropOptions>
<corner>UpperLeft</corner>
<tolerance>0.5</tolerance>
</autoColorCropOptions>
</getAutoCropRectParam>

Response
<getAutoCropRectReturn xmlns="http://www.scene7.com/IpsApi/xsd/2012-07-31-beta">
<xOffset>452</xOffset>
<yOffset>66</yOffset>
<width>1271</width>
<height>1874</height>
</getAutoCropRectReturn>

getCompanyInfo
Returns information about the specified company including the company handle, the company name, the root path, and the
expiration date. You must specify either companyHandle or companyName whose information you want to retrieve.

Authorized User Types

• IpsUser
• IpsAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getCompanyInfoParam)
Operations methods 96

Name Type Required Description

companyHandle xsd:string Either companyHandle or The handle of the company

companyName is required. whose information you want
to obtain.

companyName xsd:string Either companyHandle or The name of the company

companyName is required. whose information you want
to obtain.

Output (getCompanyInfoReturn)

Name Type Required Description

companyInfo types:Company Yes Handle and other descriptive

information about the
company.

Examples
This code sample returns all information about a company by using a company name and handle. It returns data similar to the
response received when creating a company.

Request
<ns1:getCompanyInfoParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyName>Planetary</ns1:companyName>
</ns1:getCompanyInfoParam>

Response
<ns1:getCompanyInfoReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyInfo>
<ns1:companyHandle>137</ns1:companyHandle>
<ns1:name>Planetary</ns1:name>
<ns1:rootPath>Planetary/</ns1:rootPath>
<ns1:expires>2101-01-31T23:00:00.030Z</ns1:expires>
</ns1:companyInfo>
</ns1:getCompanyInfoReturn>

getCompanyMembers
Returns the users of a company specified by a company handle.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin
Operations methods 97

Parameters
Input (getCompanyMembersParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

whose members you want to
obtain.

includeInvalid xsd:boolean Yes Include invalid companies.

Output (getCompanyMembersReturn)

Name Type Required Description

memberArray types:CompanyMemberArray Yes Array of user memberships.

Examples
This code sample returns all the members of a company in a user array. The response has been truncated for brevity.

Request
<ns1:getCompanyMembersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:includeInvalid>false</ns1:includeInvalid>
</ns1:getCompanyMembersParam>

Response
<getCompanyMembersReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<memberArray>
<items>
<userHandle>66|pbayol@adobe.com</userHandle>
<firstName>Peter</firstName>
<lastName>Bayol</lastName>
<email>pbayol@adobe.com</email>
<role>IpsAdmin</role>
<isValid>true</isValid>
<passwordExpires>2107-07-25T23:12:49.472-07:00</passwordExpires>
</items>
...
</memberArray>
</getCompanyMembersReturn>

getCompanyMembership
Gets a user’s memberships in a company array.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin
• TrialSiteUser
• ImagePortalAdmin
Operations methods 98

• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getCompanyMembershipParam)

Name Type Required Description

userHandle xsd:string No The handle to the user whose

memberships you want to
obtain.

Output (getCompanyMembershipReturn)

Name Type Required Description

membershipArray types:CompanyMembershipArray Yes Array of company

memberships.

Examples
This code sample takes a user handle and gets all the user’s company memberships in an array. The response has been truncated
for brevity.

Request
<ns1:getCompanyMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:userHandle>70|kmagnusson@adobe.com</ns1:userHandle>
</ns1:getCompanyMembershipParam>

Response
<getCompanyMembershipReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<membershipArray>
<items>
<companyHandle>48</companyHandle>
<name>AIR</name>
<rootPath>AIR/</rootPath>
<expires>2101-01-31T23:00:00.485-08:00</expires>
</items>
...
</membershipArray>
</getCompanyMembershipReturn>

getCompanySettings
Returns IPS settings for a specific company.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin
Operations methods 99

Parameters
Input (getCompanySettingsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

whose settings you wish to
retrieve.

Output (getCompanySettingsReturn)

Name Type Required Description

settings types:CompanySettings Yes Company settings.

Examples
This code sample returns all IPS settings for a specific company.

Request
<ns1:getCompanySettingsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<ns1:companyHandle>c|6</ns1:companyHandle>
</ns1:getCompanySettingsParam>

Response
<getCompanySettingsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<settings>
<metadataArray>
<items>
<name>Profile Class</name>
<value>1</value>
<longVal>1</longVal>
</items>
<items>
<name>Default Color Profile</name>
<value>1</value>
</items>
</metadataArray>
<iccProfileInfo>
<originalPath>Scene7SharedAssets/ICCColorProfiles/Adobe ICC Profiles/RGB
Profiles/</originalPath>
<originalFile>sRGB Color Space Profile.icm</originalFile>
<fileSize>0</fileSize>
</iccProfileInfo>
</defaultDisplayProfile>
<diskSpaceWarningMin>100000</diskSpaceWarningMin>
<emailTrashCleanupWarning>true</emailTrashCleanupWarning>
</settings>
</getCompanySettingsReturn>

getDiskUsage
Returns information about a company's structure (number of files, etc.).

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
Operations methods 100

• ImagePortalAdmin

Parameters
Input (getDiskUsageParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

whose disk usage you want to
obtain.

Output (getDiskUsageReturn)

Name Type Required Description

diskUsageArray types:DiskUsageArray Yes Array of company disk use.

Examples
The name of this request is misleading. Rather than returning merely a scalar value that reflects how much disk space a company
is using, it gets other information about the structure of a company as well.

Request
<ns1:getDiskUsageParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
</ns1:getDiskUsageParam>

Response
<getDiskUsageReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<diskUsageArray>
<items>
<companyHandle>47</companyHandle>
<companyName>My Company</companyName>
<imageCount>207</imageCount>
<diskSpaceUsage>3024</diskSpaceUsage>
<lastModified>2007-09-14T22:10:30.661-07:00</lastModified>
</items>
</diskUsageArray>
</getDiskUsageReturn>

getDistinctMetadataValues
Returns all values for a metadata field.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser
Operations methods 101

Parameters
Input (getDistinctMetadataValuesParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

that you want to get data for.

metadataKey xsd:string Yes Metadata key in dot notation.

Output (getDistinctMetadataValuesReturn)

Name Type Required Description

valueArray types:ValueArray Yes Values of the requested

metadata field.

Examples
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.scene7.com/IpsApi/xsd"
xmlns:ns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
<soapenv:Header>
<xsd:authHeader>
<xsd:user>user@company.com</xsd:user>
<xsd:password>password</xsd:password>
</xsd:authHeader>
</soapenv:Header>
<soapenv:Body>
<ns:getDistinctMetadataValuesParam>
<ns:companyHandle>680</ns:companyHandle>
<ns:metadataKey>dc.format</ns:metadataKey>
</ns:getDistinctMetadataValuesParam>
</soapenv:Body>
</soapenv:Envelope>

Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<getDistinctMetadataValuesReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
<valueArray>
<items>
<value>N/A</value>
<count>412</count>
</items>
<items>
<value>image/jpeg</value>
<count>189</count>
</items>
<items>
<value>image/epsf</value>
<count>1</count>
</items>
<items>
<value>image/tiff</value>
<count>3</count>
</items>
</valueArray>
</getDistinctMetadataValuesReturn>
</soapenv:Body>
</soapenv:Envelope>
Operations methods 102

getFolders
Returns all folders and subfolders, starting at the folder path. The getFolders response returns a maximum of 100,000 folders.

Purpose of Folders
A folder enables you to organize subfolders and assets. All folder and asset names must be unique. Folders and assets that share
the same name will cause a namespace conflict, even if they're in different folder hierarchies.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Note: The user must have read access to the folder to return data on it.

Parameters
Input (getFoldersParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company.

accessUserHandle xsd:string No Used by administrators to

impersonate a specific user.

accessGroupHandle xsd:string No Filter by a specific group.

folderPath xsd:string No The root folder to retrieve

folders and all subfolders to the
leaf level. If excluded, the
company root is used.

assetTypeArray types:StringArray No Returns folders that only

contain specified asset types.

responseFieldArray types:StringArray No Contains a list of fields that

you want to include in the
response.

excludeFieldArray types:StringArray No Contains a list of fields you

want to exclude from the
response.
Operations methods 103

Output (getFoldersReturn)

Name Type Required Description

folderArray types:FolderArray No An array of folders that match

the filter criteria. The response
is limited to 100,000 folders
maximum.

permissionsSetArray types:PermissionSetArray

Examples
This code sample returns an array that contains all the folders for a company along with specific information about each folder.

Request
<ns1:getFoldersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
</ns1:getFoldersParam>

Response
<getFoldersReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<folderArray>
<items>
<folderHandle>MyCompany/</folderHandle>
<path>MyCompany/</path>
<hasSubfolders>false</hasSubfolders>
</items>
<items>
<folderHandle>MyCompany/eCatalogs/</folderHandle>
<path>MyCompany/eCatalogs/</path>
<hasSubfolders>false</hasSubfolders>
</items>
<items>
<folderHandle>MyCompany/PDF/</folderHandle>
<path>MyCompany/PDF/</path>
<hasSubfolders>false</hasSubfolders>
</items>
</folderArray>
</getFoldersReturn>

getFolderTree
Returns folders and subfolders in a hierarchical tree structure. The getFolderTree response is limited to a maximum of 100,000
folders

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalContrib
• ImagePortalContribUser
Operations methods 104

Note: The user must have read access to the folder to return data on it.

Parameters
Input (getFolderTreeParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company.

accessUserHandle xsd:string No Used only by administrators

to impersonate a specific user.

accessGroupHandle xsd:string No Used to filter by a specific

group, including any of those
to which the company belongs.

folderPath xsd:string No The root folder to retrieve

folders and all subfolders to the
leaf level. If excluded, the
company root is used.

depth xsd:int Yes A value of zero gets the

top-level folder. Any other
value specifies the depth to
descend into the tree.

assetTypeArray types:StringArray No Returns folders that only

contain specified asset types.

responseFieldArray types:StringArray No Contains a list of fields that

you want to include in the
response.

excludeFieldArray types:StringArray No Contains a list of fields that

you want to exclude in the
response.

Output (getFolderTreeReturn)

Name Type Required Description

folders types:folders No The hierarchy of folders in a

tree structure. The response is
limited to a maximum of
100,000 folders.

permissionSetArray types:PermissionSetArray
Operations methods 105

Examples
This code sample uses a company handle and a depth parameter to determine the level of depth the response should return.
The response contains folders and subfolder arrays with related. Set the depth value to a smaller number to search deeper into
the folder tree.

Request
<ns1:getFolderTreeParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:depth>-1</ns1:depth>
</ns1:getFolderTreeParam>

Response

<getFolderTreeReturn xmlns="http://www.scene7.com/IpsApi/xsd/">
<folders>
<items>
<folderHandle>f|sampleFolder/uploadTestDir/</folderHandle>
<path>MyCompany/uploadTestDir/</path>
<lastModified>2011-11-14T11:19:59.031-08:00</lastModified>
<childLastModified>2011-11-14T11:19:59.031-08:00</childLastModified>
<permissionSetHandle>pm|2</permissionSetHandle>
<hasSubfolders>true</hasSubfolders>
<subfolderArray>
<items>
<folderHandle>f|MyCompany/uploadTestDir/SubFolder/</folderHandle>
<path>DevanCo/uploadTestDir/SubFolder/</path>
<lastModified>2011-11-14T11:19:59.032-08:00</lastModified>
<childLastModified>2011-11-14T11:19:59.032-08:00</childLastModified>
<permissionSetHandle>pm|2</permissionSetHandle>
<hasSubfolders>true</hasSubfolders>
<subfolderArray>
<items>
<folderHandle>f|MyCompany/uploadTestDir/SubFolder/10/</folderHandle>
<path>DevanCo/uploadTestDir/SubFolder/10/</path>
<lastModified>2011-11-14T11:19:59.033-08:00</lastModified>
<childLastModified>2011-11-14T15:06:58.563-08:00</childLastModified>
<permissionSetHandle>pm|2</permissionSetHandle>
<hasSubfolders>false</hasSubfolders>
</items>
</subfolderArray>
</items>
</subfolderArray>
</items>
</folders>
<permissionSetArray>
<items>
<permissionSetHandle>pm|2</permissionSetHandle>
<permissionArray>
<items>
<groupHandle>g|1</groupHandle>
<groupName>Asset Download Group</groupName>
<permissionType>Read</permissionType>
<isAllowed>true</isAllowed>
<isOverride>false</isOverride>
</items>
<items>
<groupHandle>g|2</groupHandle>
<groupName>Asset Upload Group</groupName>
<permissionType>Read</permissionType>
<isAllowed>true</isAllowed>
<isOverride>true</isOverride>
</items>
<items>
<groupHandle>g|2</groupHandle>
<groupName>Asset Upload Group</groupName>
Operations methods 106

<permissionType>Write</permissionType>
<isAllowed>true</isAllowed>
<isOverride>true</isOverride>
</items>
</permissionArray>
</items>
<permissionSetArray>
</getFolderTreeReturn>

getGenerationInfo
Returns 2 different types of information based on the parameters passed in. originatorHandle returns information about
assets generated from the specified asset. generateHandle returns information about steps used to generate the specified asset
or file.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getGenerationInfoParam)

Name Type Required Description

xsd:string Yes The handle to the company.

xsd:string No The engine that was used in

the generation. See Font Styles.

xsd:string No The handle of the asset to

query for generated assets.

xsd:string No The handle of the asset to

query for assets and engines
used in its generation.

xsd:StringArray No Properties included in the

operation.

xsd:StringArray No Properties excluded from the

operation.

Output (getGenerationInfoReturn)
Operations methods 107

Name Type Required Description

generationArray types:GenerationInfoArray Yes Array of generation

information.

Examples
This code sample returns information about assets generated from a specific asset. It does not retrieve information about steps
used to generate the specified asset. The response is truncated for brevity.

Request
<getGenerationInfoParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<originatorHandle>a|716|25|160</originatorHandle>
</getGenerationInfoParam>

Response
<getGenerationInfoReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<generationArray>
<items>
<engine>PostScriptRip</engine>
<originator>
...
</generated>
<attributeArray/>
</items>
</generationArray>
</getGenerationInfoReturn>

getGroupMembers
Gets the users that belong to a specific company and group.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (getGroupMembersParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company.

groupHandle xsd:string The handle to the group.

Output (getGroupMembersReturn)

Name Type Required Description

userHandleArray type:HandleArray Yes An array of user handles.

Operations methods 108

Examples
This code sample returns a user handle array containing all users that belong to a specific group.

Request
<ns1:getGroupMembersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:groupHandle>225</ns1:groupHandle>
</ns1:getGroupMembersParam>

Response
<getGroupMembersReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<userHandleArray>
<items>70|kmagnusson@adobe.com</items>
</userHandleArray>
</getGroupMembersReturn>

getGroupMembership
Returns the members of a group.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getGroupMembershipParam)

Name Type Required Description

userHandle xsd:string No The handle to the user.

companyHandle xsd:string No The handle to the company.

Output (getGroupMembershipReturn)

Name Type Required Description

groupArray types:GroupArray Yes Array of groups.

Examples
This code sample returns all the members of a group. Because the company and user handles are optional, the operation can
return all members of all groups.

Request
<ns1:getGroupMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
</ns1:getGroupMembershipParam>
Operations methods 109

Response
<getGroupMembershipReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<groupArray>
<items>

<groupHandle>225</groupHandle><companyHandle>47</companyHandle><name>MyGroup</name><isSystemDefined>false</isSystemDefined></items></groupArray></getGroupMembershipReturn>

getGroups
Returns company groups.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (getGroupsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company.

Output (getGroupsReturn)

Name Type Required Description

groupArray types:GroupArray Yes Array of groups.

Examples
This code returns an array that contains all the groups that belong to a specific company and specific information about each
group.

Request
<ns1:getGroupsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
</ns1:getGroupsParam>
<getGroupsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<groupArray>
<items>
<groupHandle>225</groupHandle>
<companyHandle>47</companyHandle>
<name>MyGroup</name>
<isSystemDefined>false</isSystemDefined>
</items>
</groupArray>
</getGroupsReturn>

getImageFormats
Returns image formats, such as PDF, EPS, SWF, and others.
Operations methods 110

Authorized User Types

• IpsUser
• IspAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getImageFormatsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

with the image formats you
want to obtain.

Output (getImageFormatsParam)

Name Type Required Description

imageFormatArray types:ImageFormatArray Yes The image format array.

Examples
This code sample returns all image formats for the specified company.

Request
<ns1:getImageFormatsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
</ns1:getImageFormatsParam>

Response
<getImageFormatsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<imageFormatArray></imageFormatArray>
</getImageFormatsReturn>

getImageRenderingPublishSettings
For internal use only. See the the Image Rendering Material Catalog Reference–Catalog Attributes section.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin
Operations methods 111

Parameters
Input (getImageRenderingPublishSettingsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

whose image rendering
publishing settings you wish to
get.

contextHandle xsd:string Yes Handle to the publish context.

Output (getImageRenderingPublishSettingsReturn)

Name Type Required Description

publishSettingsArray type:ConfigSettingArray Yes Image rendering publishing

settings.

getImageServingPublishSettings
For internal use only. Users should refer to the Image Serving Image Catalog Reference – Attribute Reference section.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (getImageServingPublishSettingsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

with the image serving publish
settings.

contextHandle xsd:string Yes Handle to the publish context.

Output

Name Type Required Description

publishSettingArray xsd:string Yes Array of image server publish

settings.

getImageSetMembers
Gets an array of members that are in an image set.
Operations methods 112

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Note: Requires read access to the image and member set asset.

Parameters
Input (getImageSetMembersParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

that contains the image set.

assetHandle xsd:string Yes The image set asset handle.

Output (getImageSetMembersReturn)

Name Type Required Description

memberArray types:ImageSetMemberArray No Array of image set members.

Examples
This code sample returns specific image set members. The response returns an empty array.

Request
<ns1:getImageSetMembersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:assetHandle>34195|22|927</ns1:assetHandle>
</ns1:getImageSetMembersParam>

Response
<getImageSetMembersReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<memberArray></memberArray>
</getImageSetMembersReturn>

getJobLogs
Gets specified job logs for the selected company. You can sort by characters, direction, start and end dates, and number of rows.

Authorized User Types

• IpsUser
• IpsAdmin
Operations methods 113

• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getJobLogsParam)

Name Type Required Description

companyHandle xsd:string No The company handle.

userHandle xsd:string No Gets logs for jobs submitted by

a specific user.

sortBy xsd:string No Lets you select sort fields.

sortDirection xsd:string No Sort order (ascending or

descending).

startDate xsd:dateTime No The date and time of the start

of the job log. Provide the time
zone with the request for this
field.

endDate xsd:dateTime No The date and time of the end

of the job log. Provide the time
zone with the request for this
field.

numRows xsd:int No Maximum number of rows to

return.

Output (getJobLogsReturn)

Name Type Required Description

jobLogArray types: JobLogArray Yes Array of job logs.

Examples
This code sample returns IPS job logs for a specific company. You can also use it to return job logs for a specific user or company
and user.

Request
<ns1:getJobLogsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
</ns1:getJobLogsParam>
Operations methods 114

Response
<getJobLogsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<jobLogArray>
<items>
<companyHandle>47</companyHandle>
<jobHandle>47||Add_2007-09-14-15:04:34</jobHandle>
<jobName>Add_2007-09-14-15:04:34</jobName>
<submitUserEmail>kmagnusson@adobe.com</submitUserEmail>
<logType>BeginUpload</logType>
<startDate>2007-09-14T22:04:58.536-07:00</startDate>
<fileSuccessCount>2</fileSuccessCount>
<fileErrorCount>0</fileErrorCount>
<fileWarningCount>205</fileWarningCount>
<fileDuplicateCount>0</fileDuplicateCount>
<fileUpdateCount>0</fileUpdateCount>
<totalFileCount>0</totalFileCount>
<fatalError>false</fatalError>
</items>
</jobLogArray>
</getJobLogsReturn>

getJobLogDetails
Gets the details of a company job log.
The logMessage response field is localized based on the authHeaderlocale field.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getJobLogDetailsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company to

which the job log belongs.

jobHandle xsd:string No A handle to an active or

completed job.

originalName xsd:string No Original name of the job log.

logTypeArray types:StringArray No One or more Log Type

constants. If present, only the
specified log types will be
Operations methods 115

Name Type Required Description

returned. By default, all log

types are returned.

recordsPerPage xsd:int No Maximum number of

detailArray items to return.
The maximum and default
value is 1000.

resultsPage xsd:int No Page number of

recordsPerPage-results to
return. The default value is 1.

sortBy xsd:string No
One of the Job Detail Sort Field
constant values (Date or
LogType). The default value is
Date.

sortDirection xsd:string No
One of the Sort Direction
string constants. The default
value is ascending.

Output (getJobLogDetailsReturn)

Name Type Required Description

jobLogArray types:JobLogArray Yes Array of job logs.

Examples
This code sample returns all the job log details for a specific company. The first array contains standard job log details. An
embedded array returns additional information about the job.

Request
<ns1:getJobLogDetailsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:jobHandle>47||Add_2007-09-14-15:04:34</ns1:jobHandle>
</ns1:getJobLogDetailsParam>

Response
<getJobLogDetailsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<jobLogArray>
<items>
<companyHandle>47</companyHandle>
<jobHandle>47||Add_2007-09-14-15:04:34</jobHandle>
<jobName>Add_2007-09-14-15:04:34</jobName>
<submitUserEmail>some_address@adobe.com</submitUserEmail>
<logType>BeginUpload</logType>
<startDate>2007-09-14T22:04:58.536-07:00</startDate>
<fileSuccessCount>2</fileSuccessCount>
<fileErrorCount>0</fileErrorCount>
<fileWarningCount>205</fileWarningCount>
<fileDuplicateCount>0</fileDuplicateCount>
<fileUpdateCount>0</fileUpdateCount>
<totalFileCount>0</totalFileCount>
Operations methods 116

<fatalError>false</fatalError>
<detailArray>
<items>
<logMessage>Upload has begun!</logMessage>
<logType>BeginUpload</logType>
</items>
<items>
<logMessage>Add_2007-09-14-15:04:34</logMessage>
<logType>OriginalJobName</logType>
</items>
<items>
<logMessage>s7oslo</logMessage>
<logType>JobClient</logType>
</items>
...
</detailArray>
</items>
</jobLogArray>
</getJobLogDetailsReturn>

getMetadataFields
Gets the user-defined metadata fields associated with an asset.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getMetadataFieldsParam)

Name Type Required Description

companyHandle xsd:string Yes The company handle.

assetType xsd:string Yes Asset types from which to

obtain metadata.

Output (getMetadataFieldsParam)

Name Type Required Description

Examples
This code sample returns metadata assets for the specified type and company. The response contains an array of metadata fields
in a field array. Not all assets have the same metadata. The IPS user defines the asset's metadata field.
Operations methods 117

Request
<ns1:getMetadataFieldsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:assetType>Pdf</ns1:assetType>
</ns1:getMetadataFieldsParam>

Response
<getMetadataFieldsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<fieldArray>
<items>
<fieldHandle>47|ALL|Resolution</fieldHandle>
<name>Resolution</name>
<type>String</type>
<defaultValue>120</defaultValue>
<isRequired>false</isRequired>
<isUserDefined>true</isUserDefined>
</items>
</fieldArray>
</getMetadataFieldsReturn>

getOriginalFilePaths
Gets the original file paths of a company’s assets.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalContrib
• ImagePortalContribUser

Note: Requires read access to the asset.

Parameters
Input (getOriginalFilePathsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company.

assetHandleArray types:HandleArray Yes Array of handles to assets

whose original file path you
want to obtain.

Output (getOriginalFilePathsReturn)

Name Type Required Description

originalFileArray types:StringArray Yes The array of strings that

represent the original file
paths.
Operations methods 118

Examples
This code sample returns the file paths of assets specified with unique asset handles in an asset handle array.

Request
<ns1:getOriginalFilePathsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:assetHandleArray>
<ns1:items>24265|1|17061</ns1:items>
<ns1:items>24267|1|17063</ns1:items>
</ns1:assetHandleArray>
</ns1:getOriginalFilePathsParam>

Response
<getOriginalFilePathsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<originalFileArray>
<items>MyCompany/Autumn Leaves.jpg</items>
<items>MyCompany/Desert Landscape.jpg</items>
</originalFileArray>
</getOriginalFilePathsReturn>

getPhotoshopPath
Returns coordinates for the quadrilateral enclosing the named Photoshop path.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• IpsUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser
•

Parameters
Input (getPhotoshopPathParam)

Name Type Required Description

companyHandle xsd:string Yes Handle to the company with

the image you want to work
with.

assetHandle xsd:string Yes Handle to the image asset.

pathName xsd:string Yes Name of the Photoshop path

you want to return.

Output (getPhotoshopPathReturn)
Operations methods 119

Name Type Required Description

perspectiveQuad types:PerspectiveQuad Yes Returns image coordinates

based on the path. See
PerspectiveQuad.

Examples
Request
<getPhotoshopPathParam xmlns="http://www.scene7.com/IpsApi/xsd/2012-07-31">
<companyHandle>c|301</companyHandle>
<assetHandle>a|26014</assetHandle>
<pathName>Face Path</pathName>
</getPhotoshopPathParam>

Response
<getPhotoshopPathReturn xmlns="http://www.scene7.com/IpsApi/xsd/2012-07-31">
<perspectiveQuad>
<x0>932.19</x0>
<y0>296.592</y0>
<x1>968.769</x1>
<y1>320.16</y1>
<x2>1119.56</x2>
<y2>1200.0</y2>
<x3>900.43</x3>
<y3>1200.0</y3>
</perspectiveQuad>
</getPhotoshopPathReturn>

getPhotoshopPathNames
Returns an array of Photoshop path names for the given image.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• IpsUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getPhotoshopPathNamesParam)

Name Type Required Description

companyHandle xsd:string Yes Handle to the company that contains

the image you want to work with.

assetHandle xsd:string Yes Handle to the image asset.

Output (getPhotoshopPathNamesReturn)
Operations methods 120

Name Type Required Description

pathNameArray types:StringArray Yes An array of Photoshop path

names in an image.

Examples
Request
<getPhotoshopPathNamesParam xmlns="http://www.scene7.com/IpsApi/xsd/2012-07-31">
<companyHandle>c|301</companyHandle>
<assetHandle>a|26014</assetHandle>
</getPhotoshopPathNamesParam>

Response
<getPhotoshopPathNamesReturn xmlns="http://www.scene7.com/IpsApi/xsd/2012-07-31">
<pathNameArray>
<items>Background Path</items>
<items>Face Path</items>
</pathNameArray>
</getPhotoshopPathNamesReturn>

getProjects
Gets projects for a group of related assets.

Authorized User Types

• IpsUser
• IpsAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getProjectsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company.

Output (getProjectsReturn)

Name Type Required Description

projectArray types:ProjectArray Yes The array of projects

associated with the company.

Examples
This code sample returns all project handles in a project array.
Operations methods 121

Request
<ns1:getProjectsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
</ns1:getProjectsParam>

Response
<getProjectsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<projectArray>
<items>
<projectHandle>47|My Project 1</projectHandle>
<name>My Project 1</name>
</items>
<items>
<projectHandle>47|My Project 2</projectHandle>
<name>My Project 2</name>
</items>
</projectArray>
</getProjectsReturn>

getProperty
Gets string values of system properties related to Image Portal.
Supported system properties include:
• IpsVersion: IPS version number.
• IpsImageServerUrl: Full, external URL prefix for the IPS Image Server.
• VideoRootUrl
• swfRootUrl
• SvgRenderRootUrl: URL prefix for rendering SVG assets.
• SvgRenderEnabled: True if SVG assets can be rendered by SvgRenderRootUrl.
• UploadPostMaxFileSize: Maximum size (in bytes) of file data allowed in an upload POST. The system rejects files larger
than the maximum limit.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getPropertyParam)

Name Type Required Description

name xsd:string Yes The name of the property to

get.
Operations methods 122

Output (getPropertyReturn)

Name Type Required Description

value xsd:string Yes The property value.

Examples
This code sample uses an IPS Properties string constant to return a specific value. In this example, the IPS property is the version
of the IPS server.

Request
<ns1:getPropertyParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:name>IpsVersion</ns1:name>
</ns1:getPropertyParam>

Response
<getPropertyReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<value>3.8.0</value>
</getPropertyReturn>

getPropertySets
Gets property sets associated with a type handle.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getPropertySetsParam)

Name Type Required Description

typeHandle xsd:string Yes The handle to the property set

type.

primaryOwnerHandle xsd:string Yes The primary owner of the data

bound to the database object.

secondaryOwnerHandle xsd:string No An optional secondary owner

of the data.

Output (getPropertySetsReturn)
Operations methods 123

Name Type Required Description

setArray types:PropertySetArray Yes Arry of property sets.

Examples
This code sample returns property sets of their primary owner, specified by a type handle.

Request
<getPropertySetsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<typeHandle>pt|10801</typeHandle>
<primaryOwnerHandle>u|41|strangio@adobe.com</primaryOwnerHandle>
</getPropertySetsParam>

Response
<getPropertySetsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<setArray>
<items>
<setHandle>ps|941</setHandle>
<typeHandle>pt|10801</typeHandle>
<propertyArray>
<items>
<name>application_server_prefix_published_test</name>
<value>http://s7teton.macromedia.com:8080/is/image/</value>
</items>
<items>
<name>application_project_whatever</name>
<value>false</value>
</items>
<items>
<name>application_server_prefix_origin_test</name>
<value>http://s7teton:8080/is/image</value>
</items>
</propertyArray>
</items>
</setArray>
</getPropertySetsReturn>

getPropertySetType
Gets a property set type using a handle to a company and the name of the property set type. It gets a type structure with the
handle to the type as well as the property type.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser
Operations methods 124

Parameters
Input (getPropertySetTypeParam)

Name Type Required Description

companyHandle xsd:string No The handle to the company.

Optional because a property
set type can belong to multiple
companies.

name xsd:string Yes Property set type name.

Output (getPropertySetTypeReturn)

Name Type Required Description

type types:PropertySetType Yes The type structure that

contains a:
• Handle.
• Type name.
• Property type.
• Value that indicates if the
type allows multiple property
types.

Examples
This code sample returns a property set type by name.

Request
<getPropertySetTypeParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<name>Adobe.UserProperty</name>
</getPropertySetTypeParam>

Response
<getPropertySetTypeReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<type>
<typeHandle>pt|10801</typeHandle>
<name>Adobe.UserProperty</name>
<propertyType>UserProperty</propertyType>
<allowMultiple>false</allowMultiple></type>
</getPropertySetTypeReturn>

getPropertySetTypes
Gets the property set types associated with the specified company, or global property set types if no company is specified.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
Operations methods 125

• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getPropertySetTypesParam)

Name Type Required Description

companyHandle xsd:string No The handle to the company

that the property set types are
associated with.

Omit if you want to return

global property set types.

Output (getPropertySetTypesReturn)

Name Type Required Description

typeArray types:PropertySetTypeArray Yes An array of property set types

associated with the specified
company, or the global
property set types if no
company was specified.

Examples
Request
<getPropertySetTypesParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|1</companyHandle>
</getPropertySetTypesParam>

Response
<getPropertySetTypesReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<typeArray>
<items>
<typeHandle>pt|1</typeHandle>
<companyHandle>c|1</companyHandle>
<name>SavedSearch</name>
<propertyType>UserCompanyProperty</propertyType>
<alllowMultiple>true</alllowMultiple>
</items>
<items>
<typeHandle>pt|2</typeHandle>
<companyHandle>c|1</companyHandle>
<name>CompanyMetadata</name>
<propertyType>CompanyProperty</propertyType>
<alllowMultiple>true</alllowMultiple>
</items>
</typeArray>
</getPropertySetTypesReturn>
Operations methods 126

getPublishContexts

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Note:
• The user must have read access to return the assets.
• All users have access to the shared company.

Parameters
Input (getPublishContextsParam)

Name Type Required Description

companyHandle xsd:string Yes Handle to the company.

contextType xsd:string No The type of publish context

you want to return. Includes:
• ImageServing
• ImageRendering
• Video
• ServerDirectory

Output (getPublishContextsReturn)

Name Type Required Description

publishContextArray types:PublishContextArray Yes An array of publish contexts

for a company, filtered by
context type if required.

Examples
Request
<getPublishContextsParam xmlns="http://www.scene7.com/IpsApi/xsd/2011-11-04">
<companyHandle>c|301</companyHandle>
</getPublishContextsParam>
Operations methods 127

Response
<getPublishContextsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<publishContextArray>
<items>
<contextHandle>pc|3001</contextHandle>
<contextName>ImageRendering</contextName>
<contextType>ImageRendering</contextType>
</items>
<items>
<contextHandle>pc|3002</contextHandle>
<contextName>ImageServing</contextName>
<contextType>ImageServing</contextType>
</items>
<items>
<contextHandle>pc|3003</contextHandle>
<contextName>ServerDirectory</contextName>
<contextType>ServerDirectory</contextType>
</items>
<items>
<contextHandle>pc|3004</contextHandle>
<contextName>Video</contextName>
<contextType>Video</contextType>
</items>
</publishContextArray>
</getPublishContextsReturn>

getScheduledJobs
Gets jobs scheduled to run.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getScheduledJobsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company.

jobHandle xsd:string No Job handle.

originalName xsd:string No The name specified by

submitJob.

Output (getScheduledJobsReturn)
Operations methods 128

Name Type Required Description

jobArray types:ScheduledJobArray Yes Array of scheduled jobs.

Examples
This code sample returns all scheduled jobs in a job array. The array itself contains detailed information about the jobs.

Request
<getScheduledJobsParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>0</companyHandle>
</getScheduledJobsParam>

Response
<getScheduledJobsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<jobArray>
<items>
<companyHandle>0</companyHandle>
<jobHandle>0|Cleanup|</jobHandle>
<name>Cleanup</name>
<originalName></originalName>
<type>Cleanup</type>
<submitUserEmail>default@scene7.com</submitUserEmail>
<execSchedule>00 00 00 * * </execSchedule>
<nextFireTime>2007-10-13T00:00:00.000-07:00</nextFireTime>
<timeZone>PST</timeZone>
<triggerState>Paused</triggerState>
</items>
</jobArray>
</getScheduledJobsReturn>

getSearchStrings
Gets the search strings, keywords, and other information about an asset. The response contains additional information about
the asset.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (getSearchStringsParam)

Name Type Required Description

companyHandle xsd:string Yes Handle to the company.

assetHandle xsd:string Yes Handle to the asset.

Output (getSearchStringsReturn)
Operations methods 129

Name Type Required Description

searchStringArray types:SearchStrings Yes An array of asset search

strings.

Examples
This code sample returns asset specific search strings. The response returns an empty array.

Request
<getSearchStringsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>47</ns1:companyHandle>
<assetHandle>a|717|1|530</assetHandle>
</getSearchStringsParam>

Response

None.

getSystemProperties
Retrieves all system properties in a single request.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser
• ImagePortalUser
• TrialSiteAdmin
• TrialSiteUser

Parameters
Input (getSystemPropertiesParam)

None.

Output (getSystemPropertiesReturn)

Name Type Required Description

propertyArray types:PropertyArray Yes An array of system properties.

Examples
This code sample returns an array of system properties. Response truncated for brevity.

Request
<getSystemPropertiesParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-09-10"/>
Operations methods 130

Response
<getSystemPropertiesReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-09-10">
<propertyArray>
<items>
<name>SvgRenderEnabled</name>
<value>true</value>
</items>
<items>
<name>SwfRootUrl</name>
<value>/SWFs/</value>
</items>
...
</propertyArray>
</getSystemPropertiesReturn>

getTagFieldValues
Gets all tag dictionary values defined for one or more tag fields.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getTagFieldValuesReturn)

Name Type Required Description

companyHandle xsd:string Yes The handle of the company

containing the tag field.

fieldHandleArray types:HandleArray Yes An array of field handles to tag

values you want returned.

Output (getTagFieldValuesReturn)

Name Type Required Description

fieldArray types:TagFieldValuesArray Yes An array of the tag values in

the dictionary for each
requested field.
Operations methods 131

Examples
Request
<getTagFieldValuesParam xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
<companyHandle>c|3</companyHandle>
<fieldHandleArray>
<items>m|3|ASSET|SingleOpenTag</items>
<items>m|3|ASSET|SingleFixedTag</items>
</fieldHandleArray>
</getTagFieldValuesParam>

Response
<getTagFieldValuesReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
<fieldArray>
<items>
<fieldHandle>m|3|ASSET|SingleOpenTag</fieldHandle>
<valueArray>
<items>GroupB</items>
<items>GroupA</items>
</valueArray>
</items>
<items>
<fieldHandle>m|3|ASSET|SingleFixedTag</fieldHandle>
<valueArray>
<items>North</items>
<items>South</items>
<items>East</items><items>West</items>
</valueArray>
</items>
</fieldArray>
</getTagFieldValuesReturn>

getUniqueMetadataValues
Gets unique metadata field values.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getUniqueMetadataValuesParam)

Name Type Required Description

companyHandle xsd:string Yes Handle to the company.

fieldHandle xsd:string No Handle to metadata field.

Output (getUniqueMetadataValuesReturn)
Operations methods 132

Name Type Required Description

values type:StringArray

Examples
This code sample uses a field handle to return specific metadata values.

Request
<ns1:getUniqueMetadataValuesParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:fieldHandle>47|ALL|Resolution</ns1:fieldHandle>
</ns1:getUniqueMetadataValuesParam>

Response
<getUniqueMetadataValuesReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<values>
<items>320</items>
</values>
</getUniqueMetadataValuesReturn>

getUserChars
Gets a list of the characters used in a particular field.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (getUserCharsParam)

Name Type Required Description

charField xsd:string Yes Determines the Trash State to

search for.

includeInactive xsd:boolean Yes Include or exclude inactive

users. Non-IPS Admin users
must be an active member of
at least one company to be
authorized to make any API
calls. An authorization fault
will be returned if the user has
no active company
memberships.

includInvalid xsd:boolean No Include or exclude invalid

users.
Operations methods 133

Name Type Required Description

companyHandleArray types:HandleArray No Filter results based on

company.

groupHandleArray types:HandleArray No Filters results based on groups.

userRoleArray types:StringArray No Filters results based on user

role.

numChars xsd:int No Enable >1 character.

Output (getUserCharsReturn)

Name Type Required Description

userCharsArray types:StringArray Yes An array of character prefixes.

Examples
This code sample returns:
• First characters of the last names of the users of a specific company.
• A set of groups.
• A set of user roles.
The User Char Filter Fields string constant determines the type of user characters returned.

Request
<ns1:getUserCharsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:charField>LastName</ns1:charField>
<ns1:includeInvalid>false</ns1:includeInvalid>
<ns1:companyHandleArray>
<ns1:items>47</ns1:items>
</ns1:companyHandleArray>
</ns1:getUserCharsParam>

Response
<getUserCharsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<userCharsArray>
<items>b</items>
<items>c</items>
<items>d</items>
</userCharsArray>
</getUserCharsReturn>

getUserInfo
Gets information about a user. Use the email address and the password of a system user as credentials for authorizing the request.
Otherwise, the operation gets information about the default user.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
Operations methods 134

• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getUserInfoParam)

Name Type Required Description

userHandle xsd:string No Handle to the user whose

information you want to
return.

email xsd:string No User email address.

Output (getUserInfoReturn)

Name Type Required Description

userInfo types:User Yes The first name, last name,

email address, and role of a
user, as well as whether the
user is valid and when the
user’s password expires.

Examples
This code sample returns information for the default IPS user.

Request
<getUserInfoParam xmlns="http://www.scene7.com/IpsApi/xsd" /></getUserInfoParam>

Response
<ns1:getUserInfoReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:userInfo>
<ns1:userHandle>3261|user@scene7.com</ns1:userHandle>
<ns1:firstName>FirstName</ns1:firstName>
<ns1:lastName>LastName</ns1:lastName>
<ns1:email>user@scene7.com</ns1:email>
<ns1:role>IpsAdmin</ns1:role>
<ns1:isValid>true</ns1:isValid>
<ns1:passwordExpires>2107-04-22T18:35:41.995Z</ns1:passwordExpires>
</ns1:userInfo>
</ns1:getUserInfoReturn>

getUsers
Gets an array of users as specified by company, group, and user role handles. This operation lets you sort returned users and
filter by character.
Operations methods 135

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Name Type Required Description

includeInactive xsd:boolean No Include or exclude inactive

users. Non-IPS Admin users
must be an active member of
at least one company to be
authorized to make any API
calls. An authorization fault
will be returned if the user has
no active company
memberships.

includeInvalid xsd:boolean No Lets you include/exclude

invalid users.

companyHandleArray types:HandleArray No Filter results by company.

groupHandleArray types:HandleArray No Filter results by group.

userRoleArray types:StringArray No Filter results by user role.

charFilterField xsd:string No Filter results by field's string

prefix (see Trash State).

charFilter xsd:string No Filter results by a specific

character.

sortBy xsd:string No Choice of user sort fields.

recordsPerPage xsd:int No Returns specified number of

records per page.

resultsPage xsd:int No Results page.

Output (getUsersReturn)

Name Type Required Description

userArray types:UserArray Yes An array of users.

Examples
This code sample returns the array of users for several optional parameters. User roles, user character filter fields, and user sort
fields are determined by using specific String Constants.

Request
<ns1:getUsersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:includeInvalid>false</ns1:includeInvalid>
Operations methods 136

<ns1:companyHandleArray>
<ns1:items>47</ns1:items>
</ns1:companyHandleArray>
<ns1:userRoleArray>
<ns1:items>IpsAdmin</ns1:items>
</ns1:userRoleArray>
<ns1:sortBy>LastName</ns1:sortBy>
</ns1:getUsersParam>

Response
<getUsersReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<userArray>
<items>
<userHandle>70|kmagnusson@adobe.com</userHandle>
<firstName>Kris</firstName>
<lastName>Magnusson</lastName>
<email>kmagnusson@adobe.com</email>
<role>IpsAdmin</role>
<isValid>true</isValid>
<passwordExpires>2107-07-27T15:18:15.816-07:00</passwordExpires>
</items>
...
</userArray>
</getUsersReturn>

getViewerConfigSettings
Gets all viewer configuration settings associated with the specified asset.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (getViewerConfigSettingsParam)

Name Type Required Description

companyHandle xsd:string Yes Handle to the company.

assetHandle xsd:string Yes Handle to the asset.

Output (getViewerCoinfigSettingsReturn)

Name Type Required Description

type xsd:string Yes Viewer type to which the

configuration settings apply.

configSettingsArray types:ConfigSettingsArray Yes Array of viewer configuration

settings.
Operations methods 137

getVignettePublishFormats

Authorizied User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (getVignettePublishFormatsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company.

Output (getVignettePublishFormatsReturn)

Name Type Required Description

vignetteFormatArray types:VignettePublishFormatArray Yes Array of vignette publish

formats.

Examples
This code sample returns two vignette publish formats associated with a specific company. Information is returned in an array,
which is truncated for brevity.

Request
<getVignettePublishFormatsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|21</companyHandle>
</getVignettePublishFormatsParam>

Response
<getVignettePublishFormatsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<vignetteFormatArray>
<items>
<companyHandle>c|21</companyHandle>
<vignetteFormatHandle>v|21|281</vignetteFormatHandle>
<name>APIcreateVignettePublishFormat</name>
...
</items>
</vignetteFormatArray>
</getVignettePublishFormatsReturn>

getXMPPacket
Retrieves an XMP Metadata packet for the specified asset.

Authorized User Types

• IpsUser
• IpsAdmin
Operations methods 138

• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getXMPPacketParam

Name Type Required Description

companyHandle xsd:string Yes The company handle with the

packet you want to return (e.g.,
c|656).

assetHandle xsd:string Yes The asset for which the XMP

packet should be retrieved.

Output (getXMPPacketReturn)

Name Type Required Description

compressedPacket xsd:Base 64 binary Yes zlib-compressed XMP packet.

Examples
Request
<ns:getXMPPacketParam>
<ns:companyHandle>c|680</ns:companyHandle>
<ns:assetHandle>a|918567</ns:assetHandle>
</ns:getXMPPacketParam>

Response
<getXMPPacketReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">

<compressedPacket>H4sIAAAAAAAAAAGqAVX+eNqNU9FumzAUfc9XWN5rwTbpUGNBpC3RtpdqU9NOe3XABTRsU9sM8vezMUUp6qQhhDg+

955zfX2djXQUneCWgVG00tAxh6xUZ07dv19GEEwh9ncOP3kC/Lr/AQ5Kc/AxxlGBUwxSEpPtLUm3NyDBeIdIghISkTuKU3qLwfzA/QZkunymD8

cvs5lDOayt7ShCwzDEwzZWukJkt9sh7ESSyEVE5iItGyNpPniJoHHkptBNZxslgcfsrHqbQ7jxTkG8q5VVplbdYiFNPO0tLpRAC4

1IjNF1YlksGV2v26mkskC85YJLa1w8CfGLBH3SFZfFJYfbFXFgllKO+bn/ZpqrFv+xsS519WKO1mX9y/yoHppveRXrgWTlxX9qJk0ojHG9eaBP3

PtKnNaNRNJ
kq6lNC8bO5/sugbVa5/4Hnd05blc9y1zmGCCI0zcO50PyK40+q4LbWPt3IqGmykqnONnVgUUYNvsdfOH6wzN6C03OMd6zQb0KpSh

/3LPyoIWfgNKX1Vz4i8rx5MSHHyX/D3L1+gMvRUL7NWE+sFH8+TvNxla7t+8xdjuhqNPERMBaoBAAA=
</compressedPacket>
</getXMPPacketReturn>

getZipEntries
Returns Zip file data.
Operations methods 139

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (getZipEntriesParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

that contains the Zip file.

assetHandle xsd:string Yes Handle to the Zip file.

Output (getZipEntriesReturn)

Name Type Required Description

zipArray types:ZipEntryArray Yes Array of entries in a Zip file.

Examples
This code sample returns Zip file information, including compressed and uncompressed size.

Request
<getZipEntriesParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|21</companyHandle>
<assetHandle>a|94223|27|30602</assetHandle>
</getZipEntriesParam>

Response
<getZipEntriesReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<zipArray
<items>
<name>Checklist_Images/.DS_Store</name>
<isDirectory>false</isDirectory>
<lastModified>2007-05-09T15:41:52.000-07:00</lastModified>
<compressedSize>503</compressedSize>
<uncompressedSize>6148</uncompressedSize>
</items>
...
</zipArray>
</getZipEntriesReturn>

moveAsset
Moves an asset to a specific folder.
Operations methods 140

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (moveAssetParam)

Name Type Required Description

companyHandle xsd:string Yes Handle to the company.

assetHandle xsd:string Yes Handle to the asset you want

to move.

folderHandle xsd:string Yes Handle to the destination

folder.

Output (moveAssetReturn)

The IPS API does not return a response for this operation.

Examples
This code sample moves an asset to a folder.

Request
<ns1:moveAssetParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:assetHandle>24266|1|17062</ns1:assetHandle>
<ns1:folderHandle>MyCompany/My New Images/</ns1:folderHandle>
</ns1:moveAssetParam>

Response

None.

moveAssets
Moves multiple assets independently of each other. It accomplishes this using the AssetMove type contained in the
assetMoveArray. Each AssetMove field contains a destination folder.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser
Operations methods 141

Parameters
Input (moveAssetsReturn)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

with assets to be moved.

assetMoveArray types:AssetMoveArray Yes An asset move array. It

contains an asset and an asset
destination folder.

Output (moveAssetsReturn)

Name Type Required Description

successCount xsd:int Yes Successfully moved asset

count.

warningCount xsd:int Yes Count of assets that generated

warnings when the operation
attempted to move them.

errorCount xsd:int Yes Count of assets that generated

errors when the operation
attempted to move them.

warningDetailArray types:AssetOperationFaultArray No AssetOperationFaultsthat

contain the:
• Assets that threw the
warnings.
• Warning codes.
• Reason for the warning.

errorDetailArray types:AssetOperationFaultArray No AssetOperationFaultsthat

contain the:
• Assets that threw the errors.
• Error codes.
• Reason for the errors.

Examples
This code sample moves assets to a specific location specified by the assetMoveArray. The array includes the asset handle and
its folder handle. The response indicates the assets were moved successfully.

Request
<moveAssetsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<assetMoveArray>
<items>
<assetHandle>a|942|1|579</assetHandle>
<folderHandle>ApiTestCo/uploads/</folderHandle>
Operations methods 142

</items>
<items>
<assetHandle>a|943|1|580</assetHandle>
<folderHandle>ApiTestCo/uploads/</folderHandle>
</items>
</assetMoveArray>
</moveAssetsParam>

Response
<moveAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<successCount>2</successCount>
<warningCount>0</warningCount>
<errorCount>0</errorCount>
</moveAssetsReturn>

moveFolder
Move a folder to a new location.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (moveFolderParam)

Name Type Required Description

companyHandle xsd:string Yes Handle to the company.

folderHandle xsd:string Yes Folder handle.

destFolderHandle xsd:string Yes Handle to the destination

folder.

Output (moveFolderReturn)

Name Type Required Description

folderHandle xsd:string Yes Handle to the moved folder.

Examples
Request
<moveFolderParam xmlns="http://www.scene7.com/IpsApi/xsd/2011-11-04">
<companyHandle>c|101</companyHandle>
<folderHandle>f|test/MoveTest/</folderHandle>
<destFolderHandle>f|DevanCo/DestFolder/</destFolderHandle>
</moveFolderParam>
Operations methods 143

Response
<moveFolderReturn xmlns="http://www.scene7.com/IpsApi/xsd/2011-11-04">
<folderHandle>f|test/DestFolder/MoveTest/</folderHandle>
</moveFolderReturn>

pauseJob
Pauses an active job.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (pauseJobParam)

Name Type Required Description

companyHandle xsd:string Yes Handle to the company.

jobHandle xsd:string Yes Handle to the job you want to

pause.

Output (PauseJobReturn)

The IPS API does not return a response for this operation.

Examples
This code sample pauses an active job.

Request
<pauseJobParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
<jobHandle>47|My Test Job|</jobHandle>
</pauseJobParam>

Response

None.

removeAssetPermissions
Removes permissions from selected assets.
Operations methods 144

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (removeAssetPermissionsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company.

assetHandle xsd:string Yes The handle to the asset with

permissions you want to
remove.

Output (removeAssetPermissionsReturn)
The IPS API does not return a response for this operation.

Examples
This code sample removes permissions from an asset.

Request
<ns1:removeAssetPermissionsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:assetHandle>15674|25|1062</ns1:assetHandle>
</ns1:removeAssetPermissionsParam>

Response

None.

removeCompanyMembership
Removes a user from one or more companies.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (removeCompanyMembershipParam)
Operations methods 145

Name Type Required Description

userHandle xsd:string No The handle to the user with the

membership you want to
remove.

companyHandleArray types:HandleArray Yes The handle to the company

that you're removing the user
from.

Output (removeCompanyMembershipReturn)

The IPS API does not return a response for this operation.

Examples
This code sample removes a user from a company. Omit the optional user handle to remove all users from the companies
specified in the company handle array.

Request
<ns1:removeCompanyMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:userHandle>621|jduvar@adobe.com</ns1:userHandle>
<ns1:companyHandleArray>
<ns1:items>47</ns1:items>
</ns1:companyHandleArray>
</ns1:removeCompanyMembershipParam>

Response

None.

removeFolderPermissions
Removes folder permissions.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (removeFolderPermissionsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

with folders with permissions
you want to remove.

folderHandle xsd:string Yes Handle to the folder.

Operations methods 146

Name Type Required Description

updateChildren xsd:boolean Yes

When true:
• Permissions removal
propagates through all of the
folder permission operations.

When false:
• The operation affects the
specified folder only.

Output (removeFolderPermissionsReturn)

The IPS API does not return a response for this operation.

Examples
This code sample removes permissions from a folder and its sub-folders. Set updateChildren to false if you need to remove
permissions from the parent folder only.

Request
<removeFolderPermissionsParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>64</companyHandle>
<folderHandle>blackmesa/Awatermark/</folderHandle>
<updateChildren>true</updateChildren>
</removeFolderPermissionsParam>

Response

None.

removeGroupMembers
Removes company users from a specific group.
Differences Between Remove Commands
• removeGroupMembers: Removes multiple users from a group.
• removeGroupMembership: Removes an individual user from an array of groups.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (removeGroupMembersParam)
Operations methods 147

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

with the users you want to
work with.

groupHandle xsd:string Yes Group handle.

userHandleArray types:HandleArray Yes An array of handles for users

whose group memberships you
want to remove.

Output (removeGroupMembersParam)

The IPS API does not return a response for this operation.

Examples
This code sample removes a user from the specified company. Remove multiple users from a group with the user handle array.

Request
<ns1:removeGroupMembersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:groupHandle>225</ns1:groupHandle>
<ns1:userHandleArray>
<ns1:items>621|jduvar@adobe.com</ns1:items>
</ns1:userHandleArray>
</ns1:removeGroupMembersParam>

Response

None.

removeGroupMembership
Removes users from an array of groups.
Differences Between Remove Commands
• removeGroupMembers: Removes multiple users from a group.
• removeGroupMembership: Removes an individual user from an array of groups.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (removeGroupMembershipParam)
Operations methods 148

Name Type Required Description

userHandle xsd:string No The handle to the company

whose group membership you
want to remove.

groupHandleArray types:HandleArray Yes The array of handles to groups

from which you want the
company to be removed.

Output (removeGroupMembershipReturn)

The IPS API does not return a response for this operation.

Examples
This code sample removes a user from a group.

Request
<ns1:removeGroupMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:userHandle>47</ns1:userHandle>
<ns1:groupHandleArray>
<ns1:items>225</ns1:items>
</ns1:groupHandleArray>
</ns1:removeGroupMembershipParam>

Response

None.

removeProjectAssets
Removes assets from a project. Does not destroy the assets.

Authorized User Types

• IpsUser
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (removeProjectAssetsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

with the assets you want to
move.

projectHandle xsd:string Yes The handle to the project

assets you want to move.
Operations methods 149

Name Type Required Description

assetHandleArray types:HandleArray Yes Array of handles to the assets

you want to move.

Output (removeProjectAssetsReturn)

Name Type Required Description

successCount xsd:int Yes Successfully removed asset

count.

warningCount xsd:int Yes The number of warnings

generated when the operation
attempted to remove assets
from the project.

errorCount xsd:int Yes The number of errors

generated when the operation
attempted to remove assets
from the project.

warningDetailArray types:AssetOperationFaultArray No The array of details associated

with the assets that generated
warnings when the operation
attempted to remove them
from the project.

errorDetailArray types:AssetOperationFaultArray No The array of details associated

with the assets that generated
errors when the operation
attempted to remove them
from the project.

Examples
This code sample removes 2 assets from a project (specified by the project handle).

Request
<removeProjectAssetsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<projectHandle>p|6|ProjectTestAPI</projectHandle>
<assetHandleArray>
<items>a|732|1|535</items>
<items>a|739|1|537</items>
</assetHandleArray>
</removeProjectAssetsParam>

renameAsset
Renames an asset.
Operations methods 150

Note: The renameFiles parameter has been deprecated for prior releases and removed from renameAsset. The virtual
file path is changed to match the new asset name (preserving the file extension), while physical file paths are not affected.
API clients need to remove references to this parameter when updating to the new API version.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImpagePortalContribUser

Note: The user must have read and write access to the asset.

Parameters
Input (renameAssetParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company to

which the asset belongs.

assetHandle xsd:string Yes The handle to the asset you

want to rename.

newName xsd:string Yes Asset's new name.

validateName xsd:boolean Yes If the validateName is true

and the asset type requires a
unique IPS ID, then the new
name is checked for global
uniqueness and renameAsset
throws a fault if it is not
unique.

Output (renameAssetReturn)

The IPS API does not return a response for this operation. See the description of the <ns1:validateName> element for caveats
about this element.

Examples
This code sample renames an asset

Request
<ns1:renameAssetParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:assetHandle>24265|1|17061</ns1:assetHandle>
<ns1:newName>My Newly Renamed Image</ns1:newName>
<ns1:validateName>true</ns1:validateName>
Operations methods 151

<ns1:renameFiles>true</ns1:renameFiles>
</ns1:renameAssetParam>

Response

None.

renameFolder
Renames a folder.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Note: The user must have read and write access to the asset.

Parameters
Input (renameFolderParam)

Name Type Required Description

companyHandle xsd:string Yes Handle to the company with

folders you want to rename.

folderHandle xsd:string Yes Handle to the folder.

folderName xsd:string Yes New folder name.

Output (renameFolderReturn)

Name Type Required Description

folderHandle xsd:string Yes Handle to the renamed folder.

Examples
This code sample renames a folder.

Request
<ns1:renameFolderParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:folderHandle>MyCompany/PDF/</ns1:folderHandle>
<ns1:folderName>My Newly Renamed PDF Folder</ns1:folderName>
</ns1:renameFolderParam>

Response
<renameFolderReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<folderHandle>MyCompany/My Newly Renamed PDF Folder/</folderHandle>
</renameFolderReturn>
Operations methods 152

renameProject
Renames a project.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (renameProjectParam)

Name Type Required Description

companyName xsd:string Yes Handle to the company with

the project you want to
rename.

projectHandle xsd:string Yes Handle to the project.

projectName xsd:string Yes New project name.

Output (renameProjectParam)

Name Type Required Description

projectHandle xsd:string Yes The handle of the renamed

project.

Examples
This code sample renames a project and returns the project handle.

Request
<renameProjectParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<projectHandle>p|6|ApiTestProject</projectHandle>
<projectName>ProjectTestAPI</projectName>
</renameProjectParam>

Response
<renameProjectReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<projectHandle>p|6|ProjectTestAPI</projectHandle>
</renameProjectReturn>

replaceImage
Replaces image data for an image asset.
Operations methods 153

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (replaceImageParam)

Name Type Required Description

companyName xsd:string Yes The handle to the company

with the image you want to
replace.

assetHandle xsd:string Yes The handle to the asset you

want to replace.

urlModifier xsd:string Yes Image Server commands that

generate new image data.

Output (replaceImageReturn)

Name Type Required Description

assetHandle xsd:string Yes Handle to the new asset.

Examples
This code sample replaces an image and and applies a urlModifier with a command that specifies that the Image Server will
take no action upon replacement.

Request
<replaceImageParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|21</companyHandle>
<assetHandle>a|140626|1|102524</assetHandle>
<urlModifier>action=none</urlModifier>
</replaceImageParam>

Response
<replaceImageReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<assetHandle>a|140626|1|102524</assetHandle>
</replaceImageReturn>

restoreAssetsFromTrash
Restores assets from trash.

Authorized User Types

• IpsUser
Operations methods 154

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (restoreAssetsFromTrashParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to a company with

the assets you want to restore.

assetHandleArray types:HandleArray Yes Array of handles for the assets

you want to restore.

Output (restoreAssetsFromTrashReturn)

Name Type Required Description

successCount xsd:int Yes Number of assets successfully

removed from the trash.

warningCount xsd:int Yes Number of warnings generated

when the operation attempted
to restore assets from the trash.

errorCount xsd:int Yes Number of errors generated

when attempting to restore
assets from the trash.

warningDetailArray types:AssetOperationFaultArray No The array of details associated

with the assets that generated
warnings when the operation
attempted to restore assets
from the trash.

errorDetailArray types:AssetOperationFaultArray No The array of details associated

with the assets that generated
errors when the operation
attempted to restore assets
from the trash.

Examples
This code sample restores assets from the trash. The response indicates the operation completed successfully.

Request
<restoreAssetsFromTrashParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<assetHandleArray>
<items>a|942|1|579</items>
Operations methods 155

<items>a|943|1|580</items>
</assetHandleArray>
</restoreAssetsFromTrashParam>

Response
<restoreAssetsFromTrashReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<successCount>2</successCount>
<warningCount>0</warningCount>
<errorCount>0</errorCount>
</restoreAssetsFromTrashReturn

resumeJob
Restarts a paused job.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (resumeJobParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

with the job you want to
restart.

jobHandle xsd:string Yes The handle to the paused job.

Output (resumeJobReturn)
The IPS API does not return a response for this operation.

Examples
This code sample restarts a paused job.

Request
<resumeJobParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
<jobHandle>47|My Test Job|</jobHandle>
</resumeJobParam>

Response

None.
Operations methods 156

saveGroup
Create or edit a group.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (saveGroupParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

with the group you want to
save.

groupHandle xsd:string No The handle to the group.

name xsd:string Yes Group name.

isSystemDefined xsd:boolean Yes false is default.

Output (saveGroupReturn)

Name Type Required Description

groupHandle xsd:string Yes Group handle.

Examples
This code sample creates a group that belongs to a specific company. If the group already exists, it is saved with the parameter
values that you specify.

Request
<ns1:saveGroupParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:name>My Other Group</ns1:name>
<ns1:isSystemDefined>false</ns1:isSystemDefined>
</ns1:saveGroupParam>

Response
<saveGroupReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<groupHandle>281</groupHandle>
</saveGroupReturn>

saveImageFormat
Creates an image format.

Note: The urlModifier field value must consist of valid XML. For example, change & to &amp;. Get the urlModfier
value from the IPS user interface.
Operations methods 157

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (saveImageFormatParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

with the image format you
want to work with.

imageFormatHandle xsd:string No Image format handle you want

to save.

name xsd:string Yes Image format name.

urlModifier xsd:string Yes This can be any IPS protocol

query string. The easiest way
to generate a URL modifier is
to create one with the IPS user
interface and then cut and
paste the query string.

Output (saveImageFormatReturn)

Name Type Required Description

imageFormatHandle xsd:string Yes Handle to the image format.

Examples
This code sample creates an image format. In this example, urlModifier was determined by its value in the IPS user interface
with a valid HTML format.

Request
<saveImageFormatParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
<name>My Image Format Name</name>
<urlModifier>wid=400&amp;hei=400&amp;fmt=jpeg&amp;qlt=750&amp;op_sharpen=0&amp;
resMode=bicub&amp;op_usm=0.0,0.0,0,0&amp;iccEmbed=0
</urlModifier>
</saveImageFormatParam>

Response
<saveImageFormatReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<imageFormatHandle>47|301</imageFormatHandle>
</saveImageFormatReturn>
Operations methods 158

saveImageMap
Create a new image map or edit an existing map.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Note: The user must have read and write access to the asset.

Parameters
Input (saveImageMapParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

with the image map you want
to save.

assetHandle xsd:string Yes The handle to the image asset

to which the image map
belongs.

imageMapHandle xsd:string No The handle to the image map.

Creates an image map if
NULL.

name xsd:string Yes The name of the image map

that is created or saved.

shapeType xsd:string Yes Choice of Region Shape.

region xsd:string Yes A comma-delimited list of

points that define the region.

action xsd:string Yes

The href value associated
with the image map as
specified in the IPS interface.

To obtain the href value, click

the image in the IPS interface,
copy and paste the URL into
this element, and then format
the IPS URL as a proper URL.
Operations methods 159

Name Type Required Description

For example, & becomes

&amp;.

position xsd:int Yes The order in the list of image

maps (the Z axis).

enabled xsd:boolean Yes

Output (saveImageMapReturn)

Name Type Required Description

imageMapHandle xsd:string Yes The handle to the new or

edited image map.

Examples
This code sample creates a new image map for an asset. It uses a shape type determined by a region shape string constant and
returns a handle to the new image map.

Request
<saveImageMapParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
<assetHandle>24266|1|17062</assetHandle>
<name>My Image Map</name>
<shapeType>Rectangle</shapeType>
<region>0,10,0,10</region>
<action>http://s7oslo.macromedia.com/scene7/browse/MoreInfo.jsp?assetID=24266&amp;
iRow=1&iRows=1&amp;strSearchType=image</action>
<position>0</position>
</saveImageMapParam>

Response
<saveImageMapReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<imageMapHandle>34191|8|554</imageMapHandle>
</saveImageMapReturn>

saveMetadataField
Create or edit a metadata field. Omit the optional field handle to create a new metadata field.

Note: This method is deprecated.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (saveMetadataFieldParam)
Operations methods 160

Parameter name Type Required Description

companyHandle xsd:string Yes The handle to the company.

fieldHandle xsd:string No Field handle.

assetType xsd:string Yes Choice of asset types from

which to save metadata.

name xsd:string Yes Field name.

fieldType xsd:string Yes Choice of metadata field types.

defaultValue xsd:string Yes Default value of the fields for

all assets.

isHidden xsd:boolean No Hide or expose IPS

system-specific metadata.

isEnforced xsd:boolean
No A boolean flag that indicates
whether the metadata field is
enforced (validated) when the
value is set.

If set to true, then a fault is

thrown if an illegal value is set
in setAssetMetadata
/batchSetAssetMetadata.

Output (saveMetadataFieldReturn)

Name Type Required Description

fieldHandle xsd:string Yes Handle of the new metadata

field.

Examples
This code sample creates a new metadata field constrained by the Asset Type and Metadata Field Types string constants. If the
fieldHandle element has a valid field handle value, it changes the metadata values and gets the same field handle that you
specified in the request.

Request
<ns1:saveMetadataFieldParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:assetType>Pdf</ns1:assetType>
<ns1:name>Resolution</ns1:name>
<ns1:fieldType>String</ns1:fieldType>
<ns1:defaultValue>120</ns1:defaultValue>
</ns1:saveMetadataFieldParam>

Response
<saveMetadataFieldReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<fieldHandle>47|ALL|Resolution</fieldHandle>
</saveMetadataFieldReturn>
Operations methods 161

saveZoomTarget
Create or edit a zoom target.

Authorized User Type

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (saveZoomTargetParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

with the zoom target you want
to save.

assetHandle xsd:string Yes The handle to the zoom target.

zoomTargetHandle xsd:string No Edits or creates a zoom target.

name xsd:string Yes Zoom target name.

xPosition xsd:int Yes Left pixel location.

yPosition xsd:int Yes Top pixel location.

width xsd:int Yes Zoom target width.

height xsd:int Yes Zoom target height.

userData xsd:string Yes For customer-specific

information. Can contain any
type of data.

Output (saveZoomTargetReturn)

Name Type Required Description

zoomTargetHandle xsd:string Yes Handle to the newly created

zoom target.

Examples
This code sample saves a zoom target. The response returns the zoom target handle.

Request
<saveZoomTargetParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
Operations methods 162

<assetHandle>24267|1|17063</assetHandle>
<name>My Zoom Target</name>
<xPosition>2</xPosition>
<yPosition>2</yPosition>
<width>10</width>
<height>10</height>
<userData>My User Data</userData>
</saveZoomTargetParam>

Response
<saveZoomTargetReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<zoomTargetHandle>34194|9|301</zoomTargetHandle>
</saveZoomTargetReturn>

searchAssets
Search for assets based on your specified criteria.

searchAssets: About
searchAssets is the primary method of retrieving IPS assets. This method is used for various purposes such as browsing the
folder hierarchy or finding a specific asset by name.

Response Size

searchAssets returns up to 1000 assets in a single call. To return up to 10,000 assets per call, limit the response data to a subset
of the totalRows, name, handle, type, and subType fields. To return larger sets, set up paging with the resultPage
parameter.

Limit Result File Size with responseFieldArray or excludeFieldArray

Limit the size of your data set with the responseFieldArray or excludFieldArray parameters. These parameters help
reduce memory use and bandwidth and can improve server response times.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Note: The user must have read access to return assets.

Parameters
Input (searchAssetsParam)
Operations methods 163

Name Type Required? Description

companyHandle xsd:string Yes The handle to the company with the assets
you want to search.

accessUserHandle xsd:string No Lets administrators work as a different user.

accessGroupHandle xsd:string No Lets administrators work as part of a

different group.

folder xsd:string No The root path for searching for assets. If

omitted, the company root folder is used.

includeSubfolders xsd:boolean No Set to true to search subfolders.

publishState xsd:string No Publish state choice.

trashState xsd:string No Trash state choice. Default is NotInTrash.

conditionMatchMode xsd:string No
Choice of Search Match Modes for
combining results of keywordArray,

conditionMatchMode

systemFieldConditionArray, and
metadataConditionArray. Default is
MatchAll.

keywordArray types:StringArray No
Note: Deprecated parameter. It is
advised that you do not use it.

A string array of keywords to match.

systemFieldMatchMode xsd:string No
Choice of Search Match Modes for
combining systemFieldCondition
matches. Default is MatchAll
.

No The array of system field conditions.

systemFieldConditionArray types:SystemFieldConditionArray

tagMatchMode xsd:string No Search Match Modes string constants. The

default is MatchAll.

tagConditionArray types:TagConditionArray No
An array of tag field search predicates.

Predicates are combined according to the

tagMatchMode setting, and then combined
with any terms in keywordArray,
systemFieldConditionArray, and
metadataConditionArray according to
the conditionMatchMode setting.
Operations methods 164

Name Type Required? Description

metadataMatchMode xsd:string No Search Match Modes for combining

metadataCondition matches. Default is
MatchAll.

metadataConditionArray No The array of metadata field search

types:MetadataConditionArray
conditions.

assetTypeArray types:StringArray No Array of Asset Types to include in search.

excludeAssetTypeArray types:StringArray No Array of Asset Types to exclude from search.

assetSubTypeArray types:StringArray No A list of sub type names to filter against.

strictSubTypeCheck xsd:boolean No If true and assetSubTypeArray is not

empty, only assets whose sub types are in
assetSubTypeArray are returned. If
false (default), then assets with no defined
sub type are returned.

excludeByproducts xsd:boolean No If true, byproduct assets generated during

ingestion of a master asset, such as ripped
PDF page images, are excluded from search
results. Default is false.

excludByproductArray No Array of byproduct asset generation

types:ExcludeByproductArray
conditions to exclude from search results. If
present, this parameter overrides the
excludeByproducts setting.

projectHandle xsd:sting No Handle of a project containing the assets to

search.

recordsPerPage xsd:int No Maximum number of results to return.

resultsPage xsd:int No Specifies the page of results to return, based

on recordsPerPage page size.

sortBy xsd:string No Choice of asset sort fields.

sortDirection xsd:string No Choice of sort direction.

responseFieldArray types:StringArray No Contains a list of fields and subfields for

inclusion in the response.

excludeFieldArray types:StringArray No Contains a list of fields and subfields for

exclusion from the response.

Output (searchAssetsReturn)
Operations methods 165

Name Type Required Description

totalRows xsd:int No Number of rows a search

returns when records per page
are not limited.

assetArray types:AssetArray No Assets that the search returns.

Examples
This code sample searches for image assets that belong to a specific company. The response is truncated for brevity.

Request
<ns1:searchAssetsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:includeSubfolders>true</ns1:includeSubfolders>
<ns1:assetTypeArray>
<ns1:items>Image</ns1:items>
</ns1:assetTypeArray>
</ns1:searchAssetsParam>

Response
<searchAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<totalRows>210</totalRows>
<assetArray>
<items>
<assetHandle>24265|1|17061</assetHandle>
<type>Image</type>
<name>Autumn Leaves</name>
...
</items>
</assetArray>
</searchAssetsReturn>

searchAssetsByMetadata
Searches the metadata index repository for the given search terms. Returns asset data like the searchAssets method.
While searchAssetsByMetadata lets you search against User-Defined Metadata Fields, those fields are not returned if they
are specified in the responseMetadataArray. To illustrate this point, the following code example:
<ns:responseMetadataArray>
<ns:items>custom_attributes.x</ns:items>
</ns:responseMetadataArray>

returns a null value:

<items>
<name>custom_attributes.x</name>
<value>null</value>
</items>

To work around this issue, you can use the fieldHandles of the assets that are returned from the search to run getAssets
(see also getAssets). This method gets the User-Defined Fields values for the assets in question. Use the following syntax example
to search against User-Defined Metadata Fields:
<ns:metadataConditionArray>
<ns:items>
<ns:fieldHandle>custom_attributes.[UDF Field Name]</ns:fieldHandle>
<ns:op>[Conditional]</ns:op>
<ns:value>[Value]</ns:value>
</ns:items>
</ns:metadataConditionArray>
Operations methods 166

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (searchAssetsByMetadataParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company.

Filter type:SearchFilter No Filters that help you define

search criteria.

See SearchFilter.

metadataConditionArray type:MetadataConditionArray No Conditions that define search

criteria. See below for
additional information.

responseMetadataArray type:StringArray No Additional fields you want to

have populated on the
response in the asset summary.
The fields must be specified in
the normalized format.

recordsPerPage xsd:int No The number of assets returned

by the response. The default
value is 1000.

resultsPage xsd:int No Specifies the page of results to

return, based on
recordsPerPage page size.

sortBy xsd:string No Sort by selected asset field.

sortDirection xsd:string No Choice of sort direction.

Ascending is default.

Output (searchAssetsByMetadataReturn)
Operations methods 167

Name Type Required Description

totalRows xsd:int No Number of matches.

assetArray types:AssetArray No Array of assets returned by the

search.

metadataConditionArray Details
Item Structure

metadataConditionArray structure is as follows:

<ns1:items>
<ns:fieldHandle>field_handle</ns:fieldHandle>
<ns:op>operator</ns:op>
<ns:value>comparison_value</ns:value>
</ms1:items>

Values

field_handle is the metadata search key. It can contain dot notation. Possible values include:

• asset_id (without prefix)

• name
• folder_path
• type
• file_name
• description
• comment
• user_data
• sku
• modified_at
• modified_by
• created_at (same as modified_at (Date in the form: Fri Jul 25 2014 22:13:45 GMT-0500 (CDT))
• created_by

Allowed Operators

The operator defines how to compare the value and include:

• Equals
• NotEquals
• Contains
• NotContains
• StartsWith
• EndsWith

The comparison_value is the term to search for.

Examples
This code sample performs a search with the following metadata criteria:
Operations methods 168

• name field contains 1000801.

• dc.rights field equals Per Jessen Schmidt.

Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.scene7.com/IpsApi/xsd"
xmlns:ns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
<soapenv:Header>
<xsd:authHeader>
<xsd:user>user@adobe.com</xsd:user>
<xsd:password>topSecret</xsd:password>
</xsd:authHeader>
</soapenv:Header>
<soapenv:Body>
<ns:searchAssetsByMetadataParam>
<ns:companyHandle>c|656</ns:companyHandle>
<ns:metadataConditionArray>
<ns:items>
<ns:fieldHandle>name</ns:fieldHandle>
<ns:op>Contains</ns:op>
<ns:value>1000801</ns:value>
</ns:items>
<ns:items>
<ns:fieldHandle>dc.rights</ns:fieldHandle>
<ns:op>Equals</ns:op>
<ns:value>Per Jessen Schmidt</ns:value>
</ns:items>
</ns:metadataConditionArray>
<ns:responseMetadataArray>
<ns:items>dc.subject</ns:items>
<ns:items>xmp.CreatorTool</ns:items>
</ns:responseMetadataArray>
</ns:searchAssetsByMetadataParam>
</soapenv:Body>
</soapenv:Envelope>

Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<searchAssetsByMetadataReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
<totalRows>1</totalRows>
<assetSummaryArray>
<items>
<assetHandle>a|885289</assetHandle>
<type>Image</type>
<name>test9-1000801</name>
<folder>Extroscope/Test subfolders/</folder>
<filename>test9-1000801.jpg</filename>
<created>2009-11-19T07:21:24.252-08:00</created>
<createUser>pschmidt@adobe.com</createUser>
<lastModified>2009-11-19T07:21:25.487-08:00</lastModified>
<lastModifyUser>pschmidt@adobe.com</lastModifyUser>
<metadataArray>
<items>
<name>dc.subject</name>
<value>[San Fransico, USA</value>
</items>
<items>
<name>xmp.CreatorTool</name>
<value>Ver.1.0</value>
</items>
</metadataArray>
</items>
</assetSummaryArray>
</searchAssetsByMetadataReturn>
</soapenv:Body>
</soapenv:Envelope>
Operations methods 169

setAssetsContextState
Set or update the publish state for one or more assets. You can set separate publish states for each publish context in a company.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Note: The user must have read access to return the asset.

Parameters
Input (setAssetsContextStateParam)

Name Type Required Description

companyHandle xsd:string Yes Handle to the company.

assetsContextHandle types:AssetsContextStateUpdateArray Yes An array of assets and their

new publish states.

Output (setAssetsContexStateReturn)

Name Type Required Description

successCount xsd:int Yes The number of assets

successfully changed.

warningCount xsd:int Yes The number of warnings

generated when the operation
attempted to modify assets.

errorCount xsd:int Yes The number of errors

generated when the operation
attempted to modify assets.

warningDetailArray types:AssetOperationFaultArray No Array of errors generated by

assets when the operation
attempted to modify them.

Examples
This code sample sets the publication state of an asset using NotMarkedForPublish.
Operations methods 170

Request
<setAssetsContextStateParam xmlns="http://www.scene7.com/IpsApi/xsd/2011-11-04">
<companyHandle>c|301</companyHandle>
<assetsContextStateUpdateArray>
<items>
<assetHandle>a|27007</assetHandle>
<contextStateUpdateArray>
<items>
<contextHandle>pc|3001</contextHandle>
<publishState>NotMarkedForPublish</publishState>
</items>
<items>
<contextHandle>pc|3002</contextHandle>
<publishState>MarkedForPublish</publishState>
</items>
<items>
<contextHandle>pc|3003</contextHandle>
<publishState>NotMarkedForPublish</publishState>
</items>
<items>
<contextHandle>pc|3004</contextHandle>
<publishState>NotMarkedForPublish</publishState>
</items>
</contextStateUpdateArray>
</items>
<items>
<assetHandle>a|27008</assetHandle>
<contextStateUpdateArray>
<items>
<contextHandle>pc|3001</contextHandle>
<publishState>MarkedForPublish</publishState>
</items>
<items>
<contextHandle>pc|3002</contextHandle>
<publishState>NotMarkedForPublish</publishState>
</items>
<items>
<contextHandle>pc|3003</contextHandle>
<publishState>NotMarkedForPublish</publishState>
</items>
<items>
<contextHandle>pc|3004</contextHandle>
<publishState>MarkedForPublish</publishState>
</items>
</contextStateUpdateArray>
</items>
</assetsContextStateUpdateArray>
</setAssetsContextStateParam>

Response
<setAssetsContextStateReturn xmlns="http://www.scene7.com/IpsApi/xsd/2011-11-04-beta">
<successCount>8</successCount>
<warningCount>0</warningCount>
<errorCount>0</errorCount>
</setAssetsContextStateReturn>

setAssetMetadata
Sets metadata values for an asset. Works with an array of metadata updates to set values in a batch.

Authorized User Types

• IpsUser
• IpsAdmin
Operations methods 171

• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Note: The user must have read access to the asset.

Parameters
Input (setAssetMetadataParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

with the asset you want to
update.

assetHandle xsd:string Yes The handle to the asset.

updateArray types:MetadataUpdateArray Yes Updates in a metadata update

array.

Output (setAssetMetadataReturn)

The IPS API does not return a response for this operation.

Examples
This code sample uses an array of metadata updates to set the metadata of the specified asset.

Request
<ns1:setAssetMetadataParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:assetHandle>24265|1|17061</ns1:assetHandle>
<ns1:updateArray>
<ns1:items>
<ns1:fieldHandle>47|ALL|Resolution</ns1:fieldHandle>
<ns1:value>320</ns1:value>
</ns1:items>
</ns1:updateArray>
</ns1:setAssetMetadataParam>

Response

None.

setAssetPermissions
Sets the permissions of a single asset by using a permission asset.
Assets inherit the permissions of their parent folder by default. Once you set permissions on an asset, it no longer inherits the
permissions of its parent unless you call removeAssetPermissions.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
Operations methods 172

• ImagePortalAdmin

Parameters
Input (setAssetPermissonsParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

that contains the folder you
want to work with.

assetHandle xsd:string Yes Folder handle.

permissionArray types:PermissionsUpdateArray Yes Permissions array.

Output (setAssetPermissonsReturn)

The IPS API does not return a response for this operation.

Examples
This code sample sets permissions on an asset. It contains the company and asset handle, and a permissions array.

Request
<setAssetPermissionsParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>64</companyHandle>
<assetHandle>97374|1|61046</assetHandle>
<permissionArray>
<items>
<groupHandle>521</groupHandle>
<permissionType>Read</permissionType>
<isAllowed>true</isAllowed>
<isOverride>true</isOverride>
</items>
</permissionArray>
</setAssetPermissionsParam>

Response

None.

setAssetPublishState
Determines if an asset is ready to be published.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalContrib
• ImagePortalContribUser

Note: The user must have read and write access to the asset.
Operations methods 173

Parameters
Input (setAssetPublishStateParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company.

assetHandle xsd:string Yes Asset handle.

publishState xsd:string Yes Available states:

• MarkedForPublish
• NotMarkedForPublish

contextHandleArray

Output

The IPS API does not return a response for this operation.

Examples
This code sample sets the publication state of an asset using NotMarkedForPublish.

Request
<setAssetPublishStateParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
<assetHandle>24267|1|17063</assetHandle>
<publishState>NotMarkedForPublish</publishState>
</setAssetPublishStateParam>

Response

None.

setAssetsPublishState
Determines if a batch of assets are ready to be published.
This is the batch version of setAssetState.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Note: The user must have read and write access to the asset.

Parameters
Input (setAssetsPublishStateParam)
Operations methods 174

Name Type Required Description

companyHandle xsd:string Yes Company handle.

publishStateUpdateArray types:PublishStateUpdateArray Yes Array of publish state values

for the assets.

Output (setAssetsPublishStateParam)

Name Type Required Description

successCount xsd:int Yes The number of successfully

updated assets.

warningCount xsd:int Yes The number of assets that

generated a warning when the
operation tried to update them.

errorCount xsd:int Yes The number of assets that

generated an error when the
operation tried to delete them.

warningDetailArray types:AssetOperationFaultArray No Details associated with the

asset updates that generated a
warning.

errorDetailArray types:AssetOperationFaultArray No Details associated with the

asset updates that generated an
error.

Examples
This code sample sets the publication state of an asset.

Request
<element name="setAssetsPublishStateParam">
<complexType>
<sequence>
<element name="companyHandle" type="xsd:string"/>
<element name="publishStateUpdateArray" type="types:PublishStateUpdateArray"/>
</sequence>
</complexType>
</element>

Response
<element name="setAssetsPublishStateReturn">
<complexType>
<sequence>
<element name="successCount" type="xsd:int"/>
<element name="warningCount" type="xsd:int"/>
<element name="errorCount" type="xsd:int"/>
<element name="warningDetailArray"type="types:AssetOperationFaultArray" minOccurs="0"/>

<element name="errorDetailArray"type="types:AssetOperationFaultArray" minOccurs="0"/>

</sequence>
</complexType>
</element>
Operations methods 175

setAssetSetDefinition
Updates the set definition for an existing Asset Set.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (setAssetDefinitionParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

with the asset set.

assetHandle xsd:string Yes Asset set handle

setDefinition xsd:string Yes Definition string. See below.

Output (setAssetSetDefinitionReturn)

The IPS API does not return a response for this operation.

setDefinition Parameter: About

setDefinition Functions

Specify setDefinition substitution functions in-line. These are resolved during a catalog lookup or on publication. Substitution
strings have the format ${<substitution_func>}, and include the following:

Note: Handle literals in the parameter lists must be surrounded by brackets ([]). The text outside of a substitution string
gets copied to the output string during resolution.

Substitution Function Returns the Asset's

getFilePath([asset_handle]) Master file path.

getCatalogd([asset_handle]) Catalog ID.

getMetaData([asset_handle],[metadata_field_handle]) Metadata value.

Operations methods 176

Substitution Function Returns the Asset's

getThumbCatalogId([asset_handle]) Catalog ID. Applies to image-based assets (Image, Adjusted

View, Layer View).

For other assets, returns the thumb asset's catalog ID (if any).
If no thumb asset is associated with the asset, the function
returns an empty string.

setDefinition Examples

This media set definition string:

${getCatalogId([a|1664|22|1664])};${getCatalogId([a|1664|22|1664])};
1,${getFilePath([a|1036|19|144])};${getCatalogId([a|452|1|433])};2;
${getMetadata([a|1036|19|144], [m|1|ASSET|SharedDateField])}

Resolves to the following at lookup or publication time:

jcompany/myRenderSet;jcompany/myRenderSet;
1,jcompany/Videos/N08275_flv.flv;jcompany/myimg-1;2;20090703 10:05:53

Examples
Request
<setAssetSetDefinitionParam xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
<companyHandle>c|1</companyHandle>
<assetHandle>a|1802|44|1802</assetHandle>
<setDefinition>${getCatalogId([a|1553|1|1176])};${getCatalogId([a|1553|1|1176])};1;img1,

${getCatalogId([a|632|1|452])};${getCatalogId([a|632|1|452])};1,${getCatalogId([a|1664|22|1664])};

${getCatalogId([a|1664|22|1664])};1,${getFilePath([a|1036|19|144])};${getCatalogId([
a|452|1|433])};
2;${getMetadata([a1036|19|144], [m|1|ASSET|SharedDateField])}</setDefinition>
</setAssetSetDefinitionParam>

Response

None.

setCompanyMembership
Sets a user’s membership in one or more companies.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (setCompanyMembershipParam)

Name Type Required Description

userHandle xsd:sting No User handle.

Operations methods 177

Name Type Required Description

membershipArray types:CompanyMembershipUpdateArray Yes Array of companies.

Output (setCompanyMembershipParam)

The IPS API does not return a response for this operation.

Examples
This code sample adds a user to a company. Specify multiple companies in the company handle array if required.

Request
<ns1:setCompanyMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:userHandle>3341|juser@scene7.com</ns1:userHandle>
<ns1:companyHandleArray>
<ns1:items>137</ns1:items>
</ns1:companyHandleArray>
</ns1:setCompanyMembershipParam>

Response

None.

setCompanySettings
Sets various company-specific configuration values.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (setCompanySettingsParam)

Name Type Required Description

companyHandle xsd:string Yes Company handle.

overwriteMode xsd:string No Asset overwrite mode.

retainPublishState xsd:boolean No Set to true to preserve the

publish state when an asset is
re-uploaded.

defaultSourceProfileHandle xsd:string No IccProfile asset to use as

default source color profile.

defaultDisplayProfileHandle xsd:string No IccProfile asset to use as

default display color profile.
Operations methods 178

Name Type Required Description

iptcExifMappingXsltHandle xsd:string No XSL asset used for mapping

IPTC and EXIF metadata to
IPS metadata fields.

xmpMappingXsltHandle xsd:string No XSL asset used to map XMP

metadata to IPS metadata
fields.

diskSpaceWarningMin xsd:int No Minimum free disk space (in

KB) available before a warning
message is sent.

emailTrashCleanupWarning xsd:boolean No Set to true to send company

administrators a notification
whenever assets are emptied
from trash.

Output (setCompanySettingsReturn)

The IPS API does not return a response for this operation.

Examples
This code sample sets a company's configuration.

Request
<ns1:setCompanySettingsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<ns1:companyHandle>c|6</ns1:companyHandle>
<ns1:overwriteMode>OverwriteFullName</ns1:overwriteMode>
<ns1:retainPublishState>true</ns1:retainPublishState>
<ns1:diskSpaceWarningMin>100000</ns1:diskSpaceWarningMin>
<ns1:emailTrashCleanupWarning>true</ns1:emailTrashCleanupWarning>
</ns1:setCompanySettingsParam>

Response

None.

setFolderPermissions
Sets folder permissions.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (setFolderPermissionsParam)
Operations methods 179

Name Type Required Description

companyHandle xsd:string Yes Company handle.

folderHandle xsd:string Yes Folder handle.

setChildren xsd:boolean Yes Sets permissions on children

that belong to the folder.

permissionArray types:PermissionUpdateArray Yes Permissions array.

Output (setFolderPermissionsReturn)

The IPS API does not return a response for this operation.

Examples
This code sample specifies a company handle, a folder handle, and a permission array with detailed information about the folder.
It applies the same permissions for the children of the parent folder.

Request
<setFolderPermissionsParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>64</companyHandle>
<folderHandle>blackmesa/Awatermark/</folderHandle>
<setChildren>true</setChildren>
<permissionArray>
<items>
<groupHandle>521</groupHandle>
<permissionType>Read</permissionType>
<isAllowed>true</isAllowed>
<isOverride>true</isOverride>
</items>
</permissionArray>
</setFolderPermissionsParam>

Response

None.

setGroupMembers
Sets the group membership of users that belong to a specific company.
The operation throws an authentication fault if you do not have privileges to accomplish this operation. This is also true if any
of the users in the user handle array do not belong to the company specified in the company handle,

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (setGroupMembersParam)

Name Type Required Description

companyHandle xsd:string Yes Company handle.

Operations methods 180

Name Type Required Description

groupHandle xsd:string Yes Group handle.

userHandleArray types:HandleArray Yes Array of handles for users

whose group membership you
want to set.

Output (setGroupMembesReturn)

The IPS API does not return a response for this operation.

Examples
This code sample sets group membership for a single user.

Request
<ns1:setGroupMembersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:groupHandle>225</ns1:groupHandle>
<ns1:userHandleArray>
<ns1:items>70|kmagnusson@adobe.com</ns1:items>
</ns1:userHandleArray>
</ns1:setGroupMembersParam>

Response

None.

setGroupMembership
Sets group membership for a user.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (setGroupMembershipParam)

Name Type Required Description

userHandle xsd:string No The handle to the user whose

group membership you want
to set.

companyHandle xsd:string No Company handle.

groupHandleArray types:HandleArray Yes The array of handles to groups

to which the user to belongs.

Output (setGroupMembershipReturn)

The IPS API does not return a response for this operation.
Operations methods 181

Examples
This code sample makes the user a member of a group. Add a user to multiple groups with the group handle array.

Request
<ns1:setGroupMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:userHandle>70|kmagnusson@adobe.com</ns1:userHandle>
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:groupHandleArray>
<ns1:items>225</ns1:items>
</ns1:groupHandleArray>
</ns1:setGroupMembershipParam>

Response

None.

setImageMaps
Sets the image map for an asset.
You must have already created the image maps. Image maps are applied in order of retrieval from the array. This means the
second image map overlays the first, the third overlays the second, and so on.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (setImageMapsParam)

Name Type Required Description

companyHandle xsd:string Yes Company handle.

assetHandle xsd:string Yes Asset handle.

imageMapArray types:ImageMapDefinitionArray Yes Array of predefined image

maps.

Output (setImageMapsReturn)

Name Type Required Description

imageMapHandleArray types:HandleArray Yes An array with image map

handles applied to the asset.

Examples
This code sample sets 2 image maps for an image asset. The code specifies shape type, region, and action taken when the image
maps are invoked. The response contains an array with handles to the image maps.
Operations methods 182

Request
<setImageMapsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<assetHandle>a|739|1|537</assetHandle>
<imageMapArray>
<items>
<name>ImageMap2</name>
<shapeType>Rectangle</shapeType>
<region>40</region>
<action>400</action>
<enabled>true</enabled>
</items>
<items>
<name>ImageMap3</name>
<shapeType>Rectangle</shapeType>
<region>40</region>
<action>400</action>
<enabled>false</enabled>
</items>
</imageMapArray>
</setImageMapsParam>

setImageSetMembers
Sets the list of assets associated with an image set.
This operation ignores the pageReset parameter for ImageSets and SpinSets and forces the value to true.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Note: The user must have read and write access to the image set asset and read access to each member asset.

Parameters
Input (setImageSetMembersParam)

Name Type Required Description

companyHandle xsd:string Yes Company handle.

assetHandle xsd:string Yes Image set handle.

memberArray types:ImageSetMemberUpdateArray Yes Array of asset members that

belong to the image set.

Output (setImageSetMembersReturn)

The IPS API does not return a response for this operation.
Operations methods 183

Examples
This code sample uses a member array to set the members of an image set.

Request
<setImageSetMembersParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
<assetHandle>34205|22|929</assetHandle>
<memberArray>
<items>
<assetHandle>24266|1|17062</assetHandle>
<pageReset>true</pageReset>
</items>
</memberArray>
</setImageSetMembersParam>

Response

None.

setImageRenderingPublishSettings
For Scene 7 developers only. Refer to the Image Rendering Material Catalog Reference–Catalog Attributes section.

Parameters
Input (setImageRenderingPublishSettingsParam)

Name Type Required Description

companyHandle xsd:string Yes Company handle.

publishSettingsArray types:ConfigSettingArray Yes For Scene 7 developers only.

contextHandle xsd:string No Handle to the publish context.

setImageServingPublishSettings
For Scene 7 developers only. Refer to the Image Rendering Material Catalog Reference–Catalog Attributes section.

Parameters
Input

Name Type Required Description

CompanyHandle xsd:string Yes Company handle.

publishSettingsArray types:ConfigSettingArray Yes For Scene 7 developers only.

contextHandle xsd:string No Handle to the publish context.

setPassword
Sets the password of a specific user or the default user to a specific value, depending on whether you specify a user handle.
Password expiration date is optional. If omitted, the password never expires.
Operations methods 184

Authorized User types

Note: Only the IpsAdmin user type is authorized to run setPassword calls against other users.

• IpsAdmin
• IpsCompanyAdmin
• IpsUser
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser
• ImagePortalUser

Parameters
Input (setPasswordParam)

Name Type Required Description

userHandle xsd:string No User handle.

password xsd:string Yes Password.

The following requirements are enforced on the

chosen password:

• Passwords are case-sensitive.

• The minimum password length is eight
characters.
• The password must contain one or more
characters from the following character classes:
• Lowercase English characters. For example,
a b c d e and so forth
• Uppercase English characters. For example,
A B C D E and so forth.
• Numbers. For example, 1 2 3 4 5 and so
forth.
• Special symbol characters. For example, you
can use any of the following: ` ~ ! @ # $
% ^ * ( ) _ + - = { } | [ ] & \ :
" ; ' < > ? , . /
Operations methods 185

Name Type Required Description

passwordExpires xsd:dateTime No Determines password expiration date.

Note: Provide the time zone with the

request for this field. Time zones are
adjusted to Central Time.

Output (setPasswordReturn)

The IPS API does not return a response for this operation.

Examples
This code sample creates a user password. The password never expires because passwordExpires was omitted.

Request
<ns1:setPasswordParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:userHandle>3341|juser@scene7.com</ns1:userHandle>
<ns1:password>@Do6e$ySt3mz</ns1:password>
</ns1:setPasswordParam>

Response

None.

setProjectAssets
Assign or update assets in a project.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (setProjectAssetsParam)

Name Type Required Description

companyName xsd:string Yes Company handle.

projectHandle xsd:string Yes Project handle.

assetHandleArray types:HandleArray Yes The array of asset handles you

want to associate with the
project.
Operations methods 186

Output (setProjectAssetsReturn)

Name Type Required Description

successCount xsd:int Yes The number of successfully

added assets.

Examples
This code sample assigns an asset to a project. The request returns a success count of one.

Request
<setProjectAssetsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<projectHandle>p|6|ProjectTestAPI</projectHandle>
<assetHandleArray>
<items>a|739|1|537</items>
</assetHandleArray>
</setProjectAssetsParam>

Response
<setProjectAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<successCount>1</successCount>
<warningCount>0</warningCount>
<errorCount>0</errorCount>
</setProjectAssetsReturn>

setTagFieldValues
Sets tag dictionary values for an existing tag field.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input

Name Type Required Description

companyHandle xsd:string Yes Company handle.

fieldHandle xsd:string Yes Tag field handle.

valueArray types:StringArray Yes An array of tag values that

replace the field's existing
dictionary. Asset associations
are maintained when a new
value matches an existing
value.

Output (setTagFieldValuesReturn)
Operations methods 187

The IPS API does not return a response for this operation.

Examples
Request
<setTagFieldValuesParam xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
<companyHandle>c|3</companyHandle>
<fieldHandle>m|3|ASSET|SingleFixedTag</fieldHandle>
<valueArray>
<items>Nurth</items>
<items>Suth</items>
<items>East</items>
<items>West</items>
<items>Pineapple</items>
<items>Banana</items>
</valueArray>
</setTagFieldValuesParam>

Response

None.

setUrlModifier
Sets the Image Serving or Image Rendering protocol commands for the specified asset. These commands modify the representation
of the asset without destroying it.
For Image Serving, commands in the urlModifier parameter are published in the Modifier catalog field and applied prior to
any commands specified on the request URL. Commands in urlPostApplyModifier will be published to the PostModifier
catalog field and will override any commands on the request URL or in urlModifier. For Image Rendering, the commands
in urlModifier and urlPostApplyModifier are concatenated and published to the Modifier catalog field.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (setUrlModifierParam)

Name Type Required Description

companyHandle xsd:string Yes Company handle.

assetHandle xsd:string Yes Asset handle.

urlModifier xsd:string No Image Serving or Image

Rendering protocol commands
to apply prior to request or
urlPostApplyModifier
commands.
Operations methods 188

Name Type Required Description

urlPostApplyModifier xsd:string No Image Serving or Image

Rendering protocol commands
to apply after urlModifier
and request commands.

Output (setUrlModifierReturn)

The IPS API does not return a response for this operation.

Examples
Request
<setUrlModifierParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<assetHandle>a|942|1|579</assetHandle>
<urlModifier>modify=that</urlModifier>
<urlPostApplyModifier>action=awesomeToo</urlPostApplyModifier>
</setUrlModifierParam>

Response

None.

setUserInfo
Sets user attributes (e.g., name, email, role, etc.)

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (setUserInfoParam)

Name Type Required Description

userHandle xsd:string No User handle.

firstName xsd:string Yes First name.

lastName xsd:string Yes Last name.

email xsd:string Yes User email.

defaultRole xsd:string Yes Sets the role for a user in each

company they belong to. Note,
however, the IpsAdmin role
overrides other per-company
settings.
Operations methods 189

Name Type Required Description

passwordExpires xsd:dateTime No Set's password expiration date.

isValid xsd:boolean Yes Determines if user is a valid

IPS user.

membershipArray types:CompanyMembershipUpdateArray Yes An array of company handles.

Output (setUserInfoReturn)

The IPS API does not return a response for this operation.

Examples
Request
<setUserInfoParam xmlns="http://www.scene7.com/IpsApi/xsd">
<firstName>test</firstName>
<lastName>test</lastName>
<email>test@test.test</email>
<defaultRole>IpsAdmin</defaultRole>
<isValid>true</isValid>
</setUserInfoParam>

Response

None.

setViewerConfigSettings
Attaches viewer configuration settings to an asset. These can be a viewer preset or the source asset for the viewer.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (setViewerConfigSettingsParam)

Name Type Required Description

companyHandle xsd:string Yes Handle to the company.

assetHandle xsd:string Yes Asset handle.

name xsd:string Yes Asset name.

type xsd:string Yes The type of asset you want to

apply the viewer configuration
to.
Operations methods 190

Name Type Required Description

configSettingArray types:ConfigSettingArray Yes The array of

ConfigSettings applied to
the asset..

Output (setViewerConfigSettingsParam)

The IPS API does not return a response for this operation.

setZoomTargets
Sets the zoom target associated with an asset image. It overwrites existing zoom targets.

Authorizied User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (setZoomTargetsParam)

Name Type Required Description

companyHandle xsd:string Yes Company handle.

assetHandle xsd:string Yes Asset with the zoom target you

want to set.

zoomTargetArray types:ZoomTargetDefinitionArray Yes Array of zoom target

definitions.

Output (setZoomTargetsReturn)

Name Type Required Description

zoomTargetHandleArray types:HandleArray Yes The set of handles to the zoom

targets created by this
operation.

Examples
This code sample defines an array of zoom targets by name, position (x and y axis), width, height, and assigns the array to an
asset. The response contains handles to the newly created zoom targets.

Request
<setZoomTargetsParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|6</companyHandle>
<assetHandle>a|739|1|537</assetHandle>
Operations methods 191

<zoomTargetArray>
<items>
<name>zoomTarget2</name>
<xPosition>40</xPosition>
<yPosition>40</yPosition>
<width>400</width>
<height>400</height>
</items>
<items>
<name>zoomTarget3</name>
<xPosition>40</xPosition>
<yPosition>40</yPosition>
<width>400</width>
<height>400</height>
</items>
</zoomTargetArray>
</setZoomTargetsParam>

Response
<setZoomTargetsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<zoomTargetHandleArray>
<items>a|947|9|41</items>
<items>a|948|9|42</items>
</zoomTargetHandleArray>
</setZoomTargetsReturn>

stopJob
Stops a job in progress.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (stopJobParam)

Name Type Required Description

companyHandle xsd:string Yes Company handle.

jobHandle xsd:string Yes Handle to the job you want to

stop.

Output (stopJobReturn0

The IPS API does not return a response for this operation.
Operations methods 192

Examples
Request
<stopJobParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
<jobHandle>47|My Test Job|</jobHandle>
</stopJobParam>

Response

None.

submitJob
Submits a job to the system.

Authorized User Types

• IpsUser
• IpsAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (submitJobParam)

Name Type Required Description

companyHandle xsd:string Yes

Company handle.

userHandle xsd:string No
Handle to the user who
submitted the job.

Note: The system sends

email to the user
specified by
userHandle. If
userHandle is not
provided, the person who
submitted the job
receives the emails.

jobName xsd:string Yes

Job name.
Operations methods 193

Name Type Required Description

locale xsd:string No
The locale used for job log
details and email localization.

Locales are specified as

<language_code> and
[<country_code>], where
the language code is a
lower-case, two- letter code as
specified by ISO-639, and the
optional country code is an
upper-case, two-letter code as
specified by ISO-3166. For
example, the locale string for
English (United States) would
be: en-US.

execTime xsd:dateTime No
Date and time to run the job.

Note: Provide the time

zone with the request.
Time zones are adjusted
to the time zone of the
target IPS server.

execSchedule xsd:string No
Determines when to run the
job.

Can be a cron string that runs

the job on a recurring basis.

The schedule is always relative

to the server’s local time zone.
See the IPS documentation for
the custom schedule format.

description xsd:string No
Job description.

exportJob types:ExportJob No
Export previously uploaded
files.

See ExportJob.

imageServingPublishJob types:ImageServingPublishJob No
Details for an image serving
publish job.
Operations methods 194

Name Type Required Description

imageRenderingPublishJob types:ImageRenderingPublishJob No
Details for an image rendering
publish job.

videoPublishJob types:VideoPublishJob No
Details for an video publish
job.

See VideoPublishJob.

serverDirectoryPublishJob types:ServerDirectoryPublishJob No
Details for an server directory
publish job.

uploadDirectoryJob types:UploadDirectoryJob No
Details for an upload directory
job.

uploadUrlsJob types:UploadUrlsJob No
Details for an upload URL job.

optimizeImagesJob types:OptimizeImagesJob No

ripPdfsJob types:RipPdfsJob No

reprocessAssetsJob types:ReprocessAssetsJob No

automatedSetGenerationJob types:AutomatedSetGenerationJob No
Process an asset list into sets
using Automated Set Scripts.

See
AutomatedSetGenerationJob.

Output (submitJobReturn)

Name Type Required Description

jobHandle xsd:string Yes Job handle.

Examples
This code sample submits an image serving publish job to IPS and returns a job handle. Choose only one type of job in the
request. Because userHandle was omitted, email notifications are sent to the user who submitted the job. This sample job runs
immediately because execTime and execSchedule were omitted.

Request
<submitJobParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
<jobName>My Test Job</jobName>
<imageServingPublishJob>
<publishType>Full</publishType>
<emailSetting>Error</emailSetting>
</imageServingPublishJob>
</submitJobParam>
Operations methods 195

Response
<submitJobReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<jobHandle>47|My Test Job|</jobHandle>
</submitJobReturn>

Notes
You can specify at most one of execTime and execSchedule. If neither is passed, the job runs immediately. You can use only
one of the following:
• imageServingPublishJob
• imageRenderingPublishJob
• videoPublishJob
• serverDirectoryPublishJob
• uploadDirectoryJob
• uploadUrlsJob

updateAssetPermissons
Updates asset permissions.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (updateAssetPermissionsParam)

Name Type Required Description

companyHandle xsd:string Yes Company handle.

assetHandle xsd:string Yes Asset handle.

updateArray types:PermissionUpdateArray Yes Permissions you want to apply

to the asset.

Output (updateAssetPermissionsReturn)

The IPS API does not return a response for this operation.

Examples
Request
<ns1:updateAssetPermissionsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:assetHandle>15674|25|1062</ns1:assetHandle>
<ns1:updateArray>
<ns1:items>
<ns1:groupHandle>225</ns1:groupHandle>
<ns1:permissionType>Read</ns1:permissionType>
<ns1:isAllowed>true</ns1:isAllowed>
<ns1:isOverride>false</ns1:isOverride>
Operations methods 196

</ns1:items>
</ns1:updateArray>
</ns1:updateAssetPermissionsParam>

Response

None.

updateAssetSet
Updates an asset set.

Parameters
Input (updateAssetSetParam)

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

that contains the image set you
want to modify.

assetHandle xsd:string Yes The handle to the image set

you want to modify.

setDefinition xsd:string No Resets image set members.

thumbAssetHandle xsd:string No The handle of the asset that

acts as the thumbnail for the
image set.

Output (updateAssetSetReturn)

Name Type Required Description

Examples
Request
<updateAssetSetParam xmlns="http://www.scene7.com/IpsApi/xsd/2014-04-03">
<companyHandle>c|15</companyHandle>
<assetHandle>a|535</assetHandle>

<setDefinition>${getCatalogId([a|202])};${getCatalogId([a|202])};advanced_image;,${getCatalogId([a|935])};${getCatalogId([a|935])};advanced_image;,${getCatalogId([a|933])};${getCatalogId([a|933])};advanced_image;</setDefinition>

<thumbAssetHandle>a|202</thumbAssetHandle>
</updateAssetSetParam>

Response
<updateAssetSetReturn xmlns="http://www.scene7.com/IpsApi/xsd/2014-04-03"/>

updateFolderPermissions
Update folder permissions.
Operations methods 197

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (updateFolderPermissionsParam)

Name Type Required Description

companyHandle xsd:string Yes Company handle.

folderHandle xsd:string Yes Folder handle.

updateChildren xsd:boolean Yes Determines whether to update

children with permissions set
for the top-level folder.

updateArray types:PermissionUpdateArray Yes The array of permission

updates you want to apply to
the folder.

Output (updateFolderPermissionsReturn)

The IPS API does not return a response for this operation.

Examples
Request
<ns1:updateFolderPermissionsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:folderHandle>MyCompany/eCatalogs/</ns1:folderHandle>
<ns1:updateChildren>false</ns1:updateChildren>
<ns1:updateArray>
<ns1:items>
<ns1:groupHandle>225</ns1:groupHandle>
<ns1:permissionType>Read</ns1:permissionType>
<ns1:isAllowed>true</ns1:isAllowed>
<ns1:isOverride>true</ns1:isOverride>
</ns1:items>
</ns1:updateArray>
</ns1:updateFolderPermissionsParam>

Response

None.

updateImageSet
Updates an image set.

Parameters
Input (updateImageSetParam)
Operations methods 198

Name Type Required Description

companyHandle xsd:string Yes The handle to the company

that contains the image set you
want to modify.

assetHandle xsd:string Ys The handle to the image set

you want to modify.

memberArray types:ImageSetMemberUpdateArray No Resets image set members.

thumbAssetHandle xsd:string No The handle of the asset that

acts as the thumbnail for the
image set.

Output (updateImageSetReturn)

Name Type Required Description

sequence

Examples
Request
<updateImageSetParam xmlns="http://www.scene7.com/IpsApi/xsd/2014-04-03">
<companyHandle>c|15</companyHandle>
<assetHandle>a|381</assetHandle>
<memberArray>
<items>
<assetHandle>a|374</assetHandle>
<pageReset>false</pageReset>
</items>
<items>
<assetHandle>a|375</assetHandle>
<pageReset>false</pageReset>
</items>
<items>
<assetHandle>a|376</assetHandle>
<pageReset>false</pageReset>
</items>
</memberArray>
<thumbAssetHandle>a|376</thumbAssetHandle>
</updateImageSetParam>

Response
<updateImageSetReturn xmlns="http://www.scene7.com/IpsApi/xsd/2014-04-03"/>

updateMetadataField
Update field metadata.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
Operations methods 199

Parameters
Input (updateMetadataFieldParam)

Parameter name Type Required Description

companyHandle xsd:string Yes Company handle.

fieldHandle xsd:string Yes Metadata field handle.

name xsd:string No Metadata field name.

defaultValue xsd:string No Metadata field value.

isHidden xsd:boolean No Hide or expose IPS

system-specific metadata.

isEnforced xsd:boolean
No A boolean flag that indicates
whether the metadata field is
enforced (validated) when the
value is set.

If set to true, then a fault is

thrown if an illegal value is set
in setAssetMetadata
/batchSetAssetMetadata.

initialTagValue xsd:string No Lets you create a set of shared

enumerated values that
selected tags can point to.

Output (updateMetadataFieldReturn)

Name Type Required Description

fieldHandle xsd:string Yes Metadata field handle.

Examples
This code sample updates assigns a new name and default value to a metadata field. The response returns a handle to the updated
field.

Request
<updateMetadataFieldParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|21</companyHandle>
<fieldHandle>m|21|IMAGE|createMetadataField</fieldHandle>
<name>updateMetadataField</name>
<defaultValue>Default</defaultValue>
</updateMetadataFieldParam>

Response
<updateMetadataFieldReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<fieldHandle>m|21|IMAGE|updateMetadataField</fieldHandle>
</updateMetadataFieldReturn>
Operations methods 200

updatePropertySet
Uses a property array to update a property set.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser

Parameters
Input (updatePropertySetParam)

Name Type Required Description

setHandle xsd:string Yes Handle to the property set.

replaceProperties xsd:string No Set to true to replace

properties.

propertyArray types:PropertyArray Yes Array of updated properties

for the property set.

Output (updatePropertySetReturn)

The IPS API does not return a response for this operation.

Examples
This code sample updates a property set with properties in the property array.

Request
<updatePropertySetParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<setHandle>ps|941</setHandle>
<replaceProperties>true</replaceProperties>
<propertyArray>
<items>
<name>application_project_whatever</name>
<value>false</value>
</items>
<items>
<name>application_server_prefix_published_test</name>
<value>http://s7teton.macromedia.com:8080/is/image/</value>
</items>
<items>
<name>application_server_prefix_origin_test</name>
<value>http://s7teton:8080/is/image/</value>
</items>
Operations methods 201

</propertyArray>
</updatePropertySetParam>

Response

None.

updateTagFieldValues
Updates tag dictionary values for a tag field.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin

Parameters
Input (updateTagFieldValuesParam)

Name Type Required Description

companyHandle xsd:string Yes Company handle.

fieldHandle xsd:string Yes Tag field handle.

updateArray types:TagValueUpdateArray Yes Array of tag field values that

you want to update.

Note: Updates tag string

values only. Does not
affect asset associations.

Output (updateTagFieldValuesReturn)

Name Type Required Description

successCount xsd:int Yes The number of successfully

updated tag fields.

warningCount xsd:int Yes The number of warnings

generated when the operation
attempted to update tag fields.

errorCount xsd:int Yes The number of errors

generated when the operation
attempted to update tag fields.

warningDetailArray types:TagValueUpdateFaultArray No The array of details associated

with the assets that generated
warnings when the operation
attempted to update tag fields.
Operations methods 202

Name Type Required Description

errorDetailArray types:TagValueUpdateFaultArray No The array of details associated

with the assets that generated
errors when the operation
attempted to update tag fields.

Examples
Request
<updateTagFieldValuesParam xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
<companyHandle>c|3</companyHandle>
<fieldHandle>m|3|ASSET|SingleFixedTag</fieldHandle>
<updateArray>
<items>
<oldValue>Nurth</oldValue>
<newValue>North</newValue>
</items>
<items>
<oldValue>Suth</oldValue>
<newValue>South</newValue>
</items>
<items>
<oldValue>East</oldValue>
<newValue>West</newValue>
</items>
<items>
<oldValue>Banana</oldValue>
<newValue>Pear</newValue>
</items>
</updateArray>
</updateTagFieldValuesParam>

Response
<updateTagFieldValuesReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
<successCount>2</successCount>
<warningCount>0</warningCount>
<errorCount>2</errorCount>
<errorDetailArray>
<items>
<value>East</value>
<code>30001</code>
<reason>New tag value 'West' already exists.</reason>
</items>
<items>
<value>Banana</value>
<code>30001</code>
<reason>Tag value 'Banana' not found.</reason>
</items>
</errorDetailArray>
</updateTagFieldValuesReturn>

updateViewerConfigSettings
Updates SWF viewer configuration settings.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
Operations methods 203

• ImagePortalAdmin

Parameters
Input (updateViewerConfigSettingsParam)

Name Type Required Description

companyHandle xsd:string Yes Handle to the company.

assetHandle xsd:string Yes Asset handle.

configSettingArray types:ConfigSettingArray Yes Array of configuration settings

you want to apply to the
viewer.

Output (updateViewerConfigSettingsReturn)

The IPS API does not return a response for this operation.

updateVignettePublishFormat
Updates the vignette publish format settings.

Authorized User Types

• IpsAdmin
• IpsCompanyAdmin
• TrialSiteAdmin
• ImagePortalAdmin

Parameters
Input (updateVignettePublishFormatParam)

Name Type Required Description

companyHandle xsd:string Yes Company handle.

vignetteFormatHandle xsd:string Yes Publish format handle.

name xsd:string No Publish format name.

targetWidth xsd:int Yes Specifies the target width of the

resulting vignette view in
pixels. Use zero so the output
vignette has the same size as
the master vignette.

targetHeight xsd:int Yes Specifies the target height of

the resulting vignette view in
pixels. Use zero so the output
vignette has the same size as
the master vignette.
Operations methods 204

Name Type Required Description

createPyramid xsd:boolean Yes Creates a pyramid vignette

optimized for zooming on the
Image Rendering server.
Starting at the maximum size,
set by the Target Vignette Size
fields, this creates multiple size
views in a single vignette
output file. Each subsequent
view size is halved until the
width and height are within
128x128 pixels.

thumbWidth xsd:int Yes Specifies the width of each

resulting thumbnail in pixels.
This setting is optional. Leave
as zero for no thumbnail file.

saveAsVersion xsd:int Yes Specifies the file format for the

published vignettes. Given a
new version of Image
Authoring and an older
version of the Image
Rendering Server, you must
specify a vignette version that
your ImageRendering Server
can read. If you specify a
higher version, the Image
Rendering server cannot read
the published vignettes. Set to
zero to publish vignettes at the
latest version.

sizeSuffixSeparator xsd:string Yes Specifies the character that

separates the vignette name
and the suffix indicating its
width.

sharpen xsd:int No Applies sharpening to the

main view image for each
publish vignette size.
Sharpening can compensate
for blurring when the vignettes
are scaled.

usmAmount xsd:double Yes Digital unsharp masking is a

flexible and powerful way to
increase sharpness, especially
in scanned images. This
Operations methods 205

Name Type Required Description

controls the magnitude of each

overshoot (how much darker
and lighter the edge borders
become).

usmRadius xsd:double Yes Affects the size of the edges to

be enhanced or how wide the
edge rims become, so a smaller
radius enhances smaller-scale
detail. Higher radius values can
cause halos at the edges. Fine
detail needs a smaller radius as
tiny detail of the same size or
smaller than the radius is lost.

usmThreshold xsd:int Yes Controls the minimum

brightness change to be
sharpened or how far apart
adjacent tonal values must be
before the filter works. This
setting can sharpen more
pronouced edges while leaving
more subtle edges untouched.
The allowable range of
threshold is 0 to 255.

Output (updateVignettePublishFormatReturn)

Name Type Required Description

vignetteFormatHandle xsd:string Yes Handle to the updated vignette

publish format.

This code sample updates a vignette publish format and returns the handle to the updated format.

Request
<updateVignettePublishFormatParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<companyHandle>c|21</companyHandle>
<vignetteFormatHandle>v|21|283</vignetteFormatHandle>
<name>APIcreateVignettePublishFormat2</name>
<targetWidth>1000</targetWidth>
<targetHeight>800</targetHeight>
<createPyramid>false</createPyramid>
<thumbWidth>100</thumbWidth>
<saveAsVersion>0</saveAsVersion>
<sizeSuffixSeparator>-</sizeSuffixSeparator>
<sharpen>50</sharpen>
<usmAmount>240.0</usmAmount>
<usmRadius>3.1</usmRadius>
<usmThreshold>150</usmThreshold>
</updateVignettePublishFormatParam>
Operations methods 206

Response
<updateVignettePublishFormatReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
<vignetteFormatHandle>v|21|283</vignetteFormatHandle>
</updateVignettePublishFormatReturn>

updateXMPPacket
Sets or updates an XMP metadata packet for an asset.

Authorized User Types

• IpsUser
• IpsAdmin
• IpsCompanyAdmin
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalcontribUser

Parameters
Input (updateXMPPacketParam)

Name Type Required Description

companyHandle xsd:string Yes Company handle.

assetHandle xsd:string Yes Asset handle.

compressedPacket xsd:Base 64 binary Yes zlib-compressed XMP packet

you want to set or update.

Output (updateXMPPacketReturn)

Name Type Required Description

success xsd:boolean Yes Returns true if the packet was

updated.

Examples
Request
<ns:updateXMPPacketParam>
<ns:companyHandle>c|680</ns:companyHandle>
<ns:assetHandle>a|918567</ns:assetHandle>

<ns:compressedPacket>H4sIAAAAAAAAAAGqAVX+eNqNU9FumzAUfc9XWN5rwTbpUGNBpC3RtpdqU9NOe3XABTRsU9sM8vezMUUp6qQhhDg
+955zfX2djXQUneCWgVG00tAxh6xUZ07dv19GEEwh9ncOP3kC/LrQ5KcAxxlGBUwxSEpPtLUm3NyDBeIdIghISkTuKU3qLwfzAQZkunymD8cvs5
lDOayt7ShCwzDEwzZWukJkt9sh7ESSyEVE5iItGyNpPniJoHHkptBNZxslgcfsrHqbQ7jxTkG8q5VVplbdYiFNPO0tLpRAC41IjNF1YlksGV2v2
6mkskC85YJLa1w8CfGLBH3SFZfFJYfbFXFglldKO+bn/ZpqrFv+xsS519WKO1mX9yyoHppveRXrgWTlxX9qJk0ojHG9eaBP3PtKnNaNRNJkq6lN
C8bO5sugbVa5/4Hnd05blc9y1zmGCCI0zcO50PyK40+q4LbWPt3IqGmykqnONnVgUUYNvsdfOH6wzN6C03OMd6zQb0KpSh3LPyoIWfgNKX1Vz4i
8rx5MSHHyX/D3L1+gMvRUL7NWE+sFH8+TvNxla7tx+8xdjuhqNPERMBaoBAAA=</ns:compressedPacket>
</ns:updateXMPPacketParam>
Operations methods 207

Response
<updateXMPPacketReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
<success>true</success>
</updateXMPPacketReturn>
Data types 208

Data types

AcoInfo

Properties of an ACO asset.

Parameters

Name Type Description

originalPath xsd:string ACO file path.

originalFile xsd:string ACO file name.

fileSize xsd:int ACO file size.

ActiveJob

A job that runs on a server. Also, it is an instance of a scheduled job.

Jobs exist in 3 states:
• Scheduled to run.
• Currently running.
• Completed running (and have already written information to a job log).
Specify a job type value to return the job type. You can return the following jobs:
• imageServingPublishJob
• imageRenderingPublishJob
• videoPublishJob
• serverDirectoryPublish
• JobUploadDirectoryJob
• uploadUrlsJob

Parameters

Name Type Description

companyHandle xsd:string Handle to the company.

jobHandle xsd:string Handle to the job.

name xsd:string Unique name for the job.

originalName xsd:string Original name of the ActiveJob type

submitted with the job.

type xsd:string Choice of job types returned by the

system.
Data types 209

Name Type Description

state xsd:string Choice of active job states returned by the

system.

submitUserEmail xsd:string email address of the user who scheduled

the job.

locale xsd:string The locale for job log details and email
localization.

Specify locales as
<language_code>[-<country_code>],
where the language code is a lower-case,
two-letter code as specified by ISO-639,
and the optional country code is an
upper-case, two-letter code as specified
by ISO-3166. For example, the locale
string for English (United States) would
be: en-US.

description xsd:string Job description originally specified in

submitJob.

serverName xsd:string Name of the server running the job.

startDate xsd:dateTime Date, time, and time zone for the active
job.

totalSize xsd:string Total size of the active job.

progress xsd:int Job progress (i.e., how close the job is to

completion).

progressMessage xsd:int A text message that describes job

progress.

lastProgressUpdate xsd:dateTime Date, time, and time zone of the last

progress update.

taskProgressArray types:TaskProgressArray Asynchronous task progress information.

imageServingPublishJob types:ImageServingPublishJob Job details for an image serving publish

job.

imageServingRenderJob types:ImageServingRenderJob Job details for an image rending publish

job.

videoPublishJob types:VideoPublishJob Job details for a video publish job.

serverDirectoryPublishJob types:ImageServingPublishJob Job details for a server directory publish

job.

uploadUrlsJob types:UploadUrlsJob Job details for an upload URLs job.

ripPdfsJob types:RipPdfsJob
Data types 210

Name Type Description

optimizeImagesJob types:OptimizeImagesJob

reprocessAssetsJob types:ReprocessAssetsJob

uploadPostJob types:UploadPostJob Job detail tracking desktop upload.

exportJob types:ExportJob Allow authorized export of previously

uploaded files. See Export Job.

ActiveJobArray

An array of active jobs.

Parameters

Name Type Description

items types:ActiveJob Array of active jobs.

AnimatedGifInfo

Properties of an Animated GIF file asset.

Parameters

Name Type Description

originalPath xsd:string Path to the GIF file.

originalFile xsd:string File name.

optimizedPath xsd:string Path to the IPS-optimized image file.

optimizedFile xsd:string The IPS-optimized image file.

fileSize xsd:int File size.

Asset

An object or container in the folder hierarchy.

Data types 211

Parameters

Name Type Description

acoInfo

animatedGifInfo types:AnimatedGifInfo Details about an animated GIF file.

assetHandle xsd:string Asset handle.

assetSetInfo

cabinetInfo types:CabinetInfo Properties for a cabinet asset type.

created xsd:dateTime Date and time the asset was uploaded.

createUser xsd:string Email address of the user who created the

asset.

cssInfo types:CssInfo Details about a CSS file.

cuePointInfo

excelInfo

fileName xsd:string Returns the virtual filename. The full

virtual file path is folder+fileName.

flashInfo

folder xsd:string Folder that contains an asset.

folderHandle xsd:string Handle to the asset's parent folder.

fontInfo type:fontInfo Properties for a font asset.

iccProfileInfo types:IccProfileInfo Properties for an ICC profile asset.

illustratorInfo

imageInfo types:ImageInfo Properties for an image asset.

inDesignInfo

ipsImageUrl xsd:string Relative URL representing a thumbnail

view of the asset.

javascriptInfo types:JavascriptInfo Details about a JavaScript file.

lastModified xsd:dateTime Date and time the asset was last modified.

lastModifyUser xsd:string Email address of the user who last

modified the asset.

layerViewInfo types:LayerViewInfo Properties for a layer view asset.

maskInfo

masterVideoInfo
Data types 212

Name Type Description

metadataArray types:MetadataArray Array of metadata values associated with

the asset.

name xsd:string Asset name.

pdfInfo

pdfSettingsInfo types:PdfSettingsInfo Properties of a PDF settings asset.

permissions

postScriptInfo

powerPointInfo

premiereExpressInfo

projects xsd:string List of project names.

psdInfo

readyForPublish xsd:boolean Sets a flag to indicate if an asset should be

published or not.

renderSceneInfo types:RenderSceneInfo Properties of a render scene asset.

rtfInfo

subType xsd:string Generic asset subtype that supports

subtype values (for example, AssetSet).

svgInfo types:SvgInfo Properties of an SVG asset.

swcInfo types:SwcInfo Properties of an SWC asset.

templateInfo types:TemplateInfo Properties of a template asset.

trashState xsd:string Indicates if an asset is in the trash or live

(see "Trash State" for values).

type xsd:string Asset type. See Asset Types for values.

videoCaptionInfo types:VideoCaptionInfo
Properties of a video caption asset.

videoInfo
Properties of a video asset.

viewerPresetInfo types:ViewerPresetInfo Properties of a viewer preset asset.

viewerSwfInfo types:ViewerSwfInfo Properties of a viewer SWf asset.

vignetteInfo types:VignetteInfo Properties of a vignette asset.

watermarkInfo types:WatermarkInfo Properties of a watermark asset.

windowCoveringInfo types:WindowCoveringInfo Properties of a window covering asset.

wordInfo
Data types 213

Name Type Description

xmlInfo types:XmlInfo Properties of an XML asset.

xslInfo types:XslInfo Properties of an XSL asset.

zipInfo

AssetArray

An array of assets.

Parameters

Name Type Description

items types:Asset Asset array.

AssetContextStateUpdate

Set a new set of publish state flags for the publish context associated with an asset.
Parameters

Name Type Description

assetHandle xsd:string Handle to the asset you want to update.

contextStateUpdateArray types:ContextStateUpdateArray An array of publish contact states for the

asset you want to update.

AssetContextStateUpdateArray

An array of asset context state updates.

Parameters

Name Type Description

items types:AssetsContextStateUpdate An array of asset context state updates.

AssetCount

Asset types and count for a company.

Asset types include ViewerSWf, PDF, Cabinet, and others.

Name Type Description

assetType xsd:string Type of asset associated with count.

Data types 214

Name Type Description

count xsd:int Number of assetType assets in the

company.

AssetCountArray

An array of asset counts.

Parameters

Name Type Description

items types:AssetCount Array of asset counts.

AssetJobLog

The details of a job log entry associated with a particular asset. Data returned by getAssetJobLogs.

Parameters

Name Type Description

jobHandle xsd:string Job handle.

jobName xsd:string Job Name.

logMessage xsd:string Message in the job log.

logMessage response field is localized

based on authHeader locale field.

logType xsd:string Type of job in the log entry.

submitUserEmail xsd:string email of user who submitted the job.

logDate xsd:dateTime Job date.

auxArray types:JobLogDetailArray Array of auxiliary job log messages for

each job log.

AssetJobLogArray

Array of asset job logs.

Parameters

Name Type Description

items types:AssetJobLog Array of asset job logs.

Data types 215

AssetMetadataFields

Returns metadata field definitions for specified asset types.

Parameters

Name Type Description

assetType xsd:string Asset type associated with field definitions

(see "Asset Types" for values).

fieldArray types:MetadataFieldArray Array of metadata field definitions

associated with the asset type specified in
assetType.

AssetMetadataFieldsArray

An array of AssetMetadataFields. Used by getAssetMetadataFields to return all asset metadata fields in a single call
with results grouped by asset type.

Parameters

Name Type Description

items types:AssetMetadataFields An AssetMetadataFields array item.

AssetMove

A handle to an asset and the handle to where it will be moved.

Parameters

Name Type Description

assetHandle xsd:string The handle to the asset you want to move.

folderHandle xsd:string The handle to the destination folder.

AssetMoveArray

Array of asset moves.

Parameters

Name Type Description

items type:AssetMove Array of asset moves.

Data types 216

AssetOperationFault

Contains information about warning or error conditions generated during a batch asset operation. The code and reason fields
correspond to the fault message fields that would have been thrown for the equivalent non-batch operation.

Parameters

Name Type Description

assetHandle xsd:string Asset handle for the failed operation.

code xsd:int Operation fault code.

reason xsd:string Fault description or reason.

AssetOperationFaultArray

An array of asset operation faults.

Parameters

Name Type Description

items types:AssetOperationFault An array of asset operation fault items.

AssetPublishContexts

Maps an asset to the PublishContexts in which an asset is marked for publication.

Parameters

Name Type Description

assetHandle xsd:string Handle to the asset.

publishContextArray types:PublishContextArray An array of publish contexts in which the

asset is marked for publication.

AssetPublishContextArray

Parameters

Name Type Description

AssetPublishContextArray types:AssetPublishContext An array of asset publish contexts.

Data types 217

AssetSetInfo

Properties for AssetSet type assets.

Parameters

Name Type Description

setDefinition xsd:string Asset set definition formatted according

to the requirements of the targeted IS
Viewer. Can contain optional IPS
substitution parameters.

AssetSummary

Metadata search results that contain summarized information about an asset.

Parameters

Name Type Description

assetHandle xsd:string Asset handle.

type xsd:string Asset type. The "Asset Types" constant

defines the possible values. Optional.

name xsd:string Asset name. Optional.

folder xsd:string The folder that contains the asset.

filename xsd:string Asset's file name.

created xsd:dateTime Asset creation date.

createUser xsd:string The user who created the asset.

lastModified xsd:dateTime The date that the asset was last updated.

lastModifyUser xsd:string The last user who modified the asset.

metadataArray types:MetadataArray Array of metadata values associated with

the asset.

score xsd:double Defines the precision in case of a

similarity search (0 = no match, 1 = exact
match).

scoreDetail xsd:string Holds detailed information about similar

areas as a result of a similarity search.
Data types 218

AssetSummaryArray

An array of asset summaries.

Parameters

Name Type Description

items types:AssetSummary Array of asset summaries.

AudioInfo

Properties of an audio file asset.

Parameters

Name Type Description

originalPath xsd:string Path to the audio file.

originalFile xsd:string File name.

fileSize xsd:int File size.

AutoColorCropOptions

Options for automatically cropping images based on color.

Parameters

Name Type Description

corner xsd:string Choice of AutoCrop Corner.

tolerance xsd:double Color match specification. Uses:

• 0 to match colors exactly.
• 1 to enable the most color differences.

AutomatedSetGenerationJob

Group files into sets using an asset handle list array.

Data types 219

Parameters

Name Type Description

assetHandleArray types:HandleArray An array of asset handles used to create the set.

By default, 1000 is the maximum number of

assets you can have in the array.

destFolder xsd:string Path to the folder where you want to save the
sets. Saves to company root folder by default.

readyForPublish xsd:boolean Sets a flag to indicate if the assets should be

published or not.

autoSetCreationOptions types:AutoSetCreationOptions An array of set generation scripts you can run

on the uploaded files. See
AutoSetCreationOptions

emailSetting xsd:string
Set up an automated email notification for the
job.

emailSetting Options

The emailSetting parameter includes the following options:

Option Returns

All All job notifications (errors, warnings, completion) to the specified recipient.

Error Job errors to the specified recipient.

ErrorAndWarning Job errors and warnings to the specified recipient.

JobCompletion A job completion notification to the specified recipient.

None The job does not send any job notifications to the specified recipient.

Example
<complexType name="AutomatedSetGenerationJob">
<sequence>
<element name="assetHandleArray" type="types:HandleArray"/>
<element name="destFolder" type="xsd:string" minOccurs="0"/>
<element name="readyForPublish" type="xsd:boolean"/>
<element name="autoSetCreationOptions" type="types:AutoSetCreationOptions"/>
<element name="emailSetting" type="xsd:string"/>
</sequence>
</complexType>

AutoSetCreationOptions

Automatic set generation script list for upload jobs. Assumes that every script specified for the upload is applied to all uploaded
assets.
Data types 220

Parameters

Name Type Description

autoSetsArray types:HandleArray Array of PropertySet handles defining the

automatic set generation scripts applied
during upload.

AutoTransparentCropOptions

Options used when automatically cropping images based on transparency.

Parameters

Name Type Description

tolerance xsd:double Removes white space from image edges

based on transparency. Uses:
• 0 to match colors exactly.
• 1 to enable the most color differences.

BatchMetadataUpdate

Updates metadata in batch mode.

Parameters

Name Type Description

assetHandleArray types:HandleArray Array of asset handles.

updateArray types:MetadataUpdateArray Array of metadata update handles.

BatchMetadataUpdateArray

An array of batch metadata updates.

Parameters

Name Type Description

items types:BatchMetadataUpdate The array of batch updates.

CabinetInfo

Properties of a cabinet asset.

Data types 221

Parameters

Name Type Description

originalPath xsd:string Relative path to the original cabinet.

originalFile xsd:string Cabinet name.

fileSize xsd:int Cabinet size.

imagePath xsd:string Relative path to the cabinet associated

with the vignette.

imageFile xsd:string File name of cabinet associated with the

vignette.

optimizedPath xsd:string Path to the IPS-optimized cabinet.

optimizedFile xsd:string IPS-optimized cabinet file.

ColorManagementOptions

Options specified during upload. Affects how color is managed for the upload.

Parameters

Name Type Description

colorManagement xsd:string Color management mode choice.

sourceProfileHandle xsd:string Source profile handle.

outputProfileHandle xsd:string Output profile handle.

Company

Represents a company.

Parameters

Name Type Description

companyHandle xsd:string Company handle.

name xsd:string Company name.

rootPath xsd:string Root path of the company.

expires xsd:dateTime Date and time the company expires.

Data types 222

CompanyArray

An array of companies

Parameters

Name Type Description

items types:Company An array of companies.

CompanyMember

Describes the different companies a user belongs to.

Parameters

Name Type Description

user types:User User name.

role xsd:string Role the user has for each company they
belong to.

isActive xsd:boolean Sets the user's status for each company

they belong to.

CompanyMemberArray

Parameters

Name Type Description

items types:CompanyMember

CompanyMembership

Parameters

Name Type Description

company types:Company

role xsd:string

isActive xsd:boolean Sets the user's status for each company

they belong to.
Data types 223

CompanyMembershipArray

Parameters

Name Type Description

items types:CompanyMembership

CompanyMembershipUpdate

Parameters

Name Type Description

companyHandle xsd:string Handle to the company.

role xsd:string The role a user has for each company they
belong to.

isActive xsd:boolean Sets the user's status for each company

they belong to.

CompanyMembershipUpdateArray

Parameters

Name Type Description

items types:CompanyMembershipUpdate

CompanyMetadataInfo

Holds information about a company metadata object like ID, name, and type.

Parameters

Name Type Description

Data types 224

CompanyMetadataInfoArray

An array of CompanyMetadataInfo elements.

Parameters

Name Type Description

CompanySettings

Company-specific configuration settings.

Parameters

Name Type Description

overwriteMode xsd:string Determines whether to overwrite images
in current folder with same base image
name and extension.
retainPublishState xsd:boolean Specifies whether a replacement image
uploaded into IPS should retain the
existing “Ready to Publish” setting or
whether it should be as specified by the
upload.
defaultSourceProfile types:Asset Specifies the default source color profile
(Coated FOGRA27 (ISO 126472:2004))
automatically applied as part of the “Use
default Color Behavior”when adding
CMYK image files.
defaultDisplayProfile types:Asset Specifies the default internal color profile
(U.S. Web Coated (SWOP)
v2)automatically applied as part of the
“Use default Color Behavior” when
adding CMYK image files.
iptcExifMappingXslt types:Asset The extraction of IPTC and EXIF image
header data into IPS requires a conversion
from internal field names to user-defined
field names for the company. Determines
an XSL translation table (default is “Do
not extract any IPTC or EXIF fields”) for
uploaded images.
xmpMappingXslt types:Asset The extraction of XMP image header data
into IPS requires a conversion from
internal field names to user-defined field
names for the company. Determines an
Data types 225

Name Type Description

diskSpaceWarningMin
emailTrashCleanupWarning
javascriptUploadEnabled
XSL translation table (default is “Do not
extract any XMP fields”) for uploaded
images.
xsd:int Minimum amount of image directory free
disk space before a warning is sent out.
xsd:boolean Determines whether to send emails before
items placed into the trash can are
automatically deleted.
types:Asset Determines whether to upload JavaScript
files. This is a potential security risk, so
use this option with care.

ConfigSetting

Used by Scene7 developers only.

Parameters

Name Type Description

name xsd:string Configuration name.
value xsd:string Configuration value.
handle xsd:string Handle to the stored configuration.

ConfigSettingArray

An array of configuration settings.

Parameters

Name Type Description

items types:ConfigSetting An array of configuration settings.

ContextStateUpdate

Updates publish context state for an asset.

Parameters
Set an asset's publish context state with setAssetsContextState.

Name Type Description

contextHandle xsd:string Handle to the publish context.

Data types 226

Name Type Description

publishState xsd:string The asset's updated published state for

the specified publish context. Includes:
• MarkedForPublish
• NotMarkedForPublish
•

ContextStateUpdateArray

An array of context state updates.

Parameters

Name Type Description

ContextStateUpdateArray types:ContextStateUpdate An array of context state updates.

CreateVideoSitemapJob

Creates a video site map.

Parameters

Name Type Description

forceUpdate xsd:boolean Generates the site map when set to true.

Note: If the Sitemap Generation

Configuration is set to manual and
forceUpdate is not set, the site
map will not be generated.

CssInfo

Properties of an CSS file asset.

Parameters

Name Type Description

originalPath xsd:string Path to the CSS file.

originalFile xsd:string File name.

fileSize xsd:int File size.

Data types 227

CuePointInfo

Properties of a CuePoint file asset.

Parameters

Name Type Description

originalPath xsd:string CuePoint file path.
originalFile xsd:string CuePoint file name.
fileSize xsd:int CuePoint file size.

DiskUsage

Disk space statistics for an asset or folder.

Parameters

Name Type Description

companyHandle xsd:string Company handle.
companyName xsd:string Company name.
imageCount xsd:int Number of stored images.
diskSpaceUsage xsd:long Total file side in kilobytes.
lastModified xsd:dateTime Date, time, and time zone the DiskUsage
type was last modified.

DiskUsageArray

An array of disk usage.

Parameters

Name Type Description

items types:DiskUsage Array of disk usage.

EmailConfirmation

Sends an email to a designated recipient in response to a cdnCacheInvalidation operation.

Data types 228

Parameters

Name Type Description

ccOriginator xsd:boolean If true, includes the user's web service user

account, which is a list of emails
designated to receive an email
confirmation from the Scene7 CDN.

ccOthersArray types:EmailArray An array of email addresses (5 maximum)

designated to receive the confirmation
notification from the Scene7 CDN.

EmailArray

An array used to designate the originator or a list of up to 5 email addresses to receive the confirmation notification.

Parameters

Name Type Description

items xsd:string email addresses.

ExcludeByproductArray

Supports byproduct filtering in the searchAssets operation.

Parameters

Name Type Description

items types:ExcludeByproductCondition Item in the array.

ExcludeByproductCondition

Determines which generation engine and generated asset type to exclude from search results.

Parameters

Name Type Description

engine xsd:string The generation engine that created assets
you want to exclude. See Generation Info
for values.
generatedAssetType xsd:string Excluded asset type. See Asset Types for
values.
Data types 229

ExcludeMasterVideoFromAVS

Excludes the master video from the adaptive video set.

Parameters

Name Type Description

true|false xsd:boolean
Excludes the master video file from the
adaptive video set.

Defaults to true.

ExcelInfo

Properties of a Microsoft Excel file.

Parameters

Name Type Description

originalPath xsd:string Path to the file.
originalFile xsd:string File name.
fileSize xsd:int File size.

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]

Data types 230

Name Type Description

• 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

FlashInfo

Properties of a Flash file.

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:string File name.
fileSize xsd:int File size.
Data types 231

Folder

Hierarchical file or asset storage object. Folders can contain one (or more) subfolders.

Parameters

Name Type Description

folderHandle xsd:string Folder handle.
path xsd:string Folder path.
lastModified xsd:dateTime Last modification date.
childLastModified xsd:dateTime Last modification date for subfolders and
folder child assets.
permissionsSetHandle xsd:string Folder permissions handle.
hasSubfolder types:Boolean Determines if a folder has subfolders.
subfolderArray types:FolderArray An array of subfolders in a folder.

FolderArray

An array of folders.

Parameters

Name Type Description

items types:Folder Array of folders.

FontFieldUpdate

Update information for font properties.

Parameters

Name Type Description

assetHandle xsd:string Font asset handle.
fontName xsd:string Font name.
postscriptName xsd:string PostScript font name.
rtfName xsd:string Rich Text font name.
fontFamily xsd:string Font family name.
style xsd:string Font style (see Font Styles for values).
typeName xsd:string Font type name.
type xsd:string Font type (see Font Types for values).
Data types 232

FontFieldUpdateArray

An array of font field updates.

Parameters

Name Type Description

items types:FontFieldUpdate An item in the font field update array.

FontInfo

Font asset properties.

Parameters

Name Type Description

originalPath xsd:string Font path.
originalFile xsd:string Font name.
fileSize xsd:int Font size.

GenerationAttribute

A name-value pair that contains information about an asset generation step. See getGenerationInfo.

Parameters

Name Type Description

name xsd:string Attribute name.
value xsd:string Attribute value.

GenerationAttributeArray

Array of generation attributes.

Parameters

Name Type Description

items types:GenerationAttribute The array of generation attributes.
Data types 233

GenerationInfo

PostScript file properties.

Parameters

Name Type Description

engine xsd:string Generation engine used (see "Generation
Info" for values).
originator types:Asset Asset record of master asset used in
generation.
generated types:Asset Asset record of generated asset.
attributeArray types:GenerationAttributeArray Array of attributes associated with
generation process.

GenerationInfoArray

An array of generation properties.

Parameters

Name Type Description

items types:GenerationInfo An array of generation properties.

Group

Named set of users used for assigning permissions.

Parameters

Name Type Description

groupHandle xsd:string Group handle.
companyHandle xsd:string Company handle.
name xsd:string Group name.
is SystemDefined xsd:string Whether the group is defined by the
system.

GroupArray

Array of groups.
Data types 234

Parameters

Name Type Description

items types:Group Array of groups.

HandleArray

An array of handles.

Note: The array can contain any type of handles required to perform an operation.

Parameters

Name Type Description

items xsd:string An array of handles.

IccProfileFieldUpdate

Update information for ICC profile properties.

Parameters

Name Type Description

assetHandle xsd:string Handle of the ICC Profile asset to update.
class xsd:string Profile classes (see “Profile Classes” for
values).
colorSpace xsd:string Profile color space (see “Color Spaces”
for values).
pcsType xsd:string Profile connection space (see “Color
Spaces” for values).

IccProfileFieldUpdateArray

An array of ICC profile field update items.

Parameters

Name Type Description

items types:IccProfileUpdate IccProfileFieldUpdate array item.

IccProfileInfo

Properties of an ICC profile asset.

Data types 235

Parameters

Name Type Description

originalPath xsd:string ICC profile path.
originalFile xsd:string Name of the original ICC profile.
fileSize xsd:int ICC profile size.

IllustratorInfo

Properties of an Adobe Illustrator file.

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:string File name.
fileSize xsd:int File size.

IllustratorOptions

Options for an Adobe Illustrator file.

Parameters

Name Type Description

process xsd:string Choice of Illustrator processes.
resolution xsd:string File resolution.
colorSpace xsd:string Target color space.
alpha xsd:boolean Whether to rasterize the file into an
image. If so, create a transparent
background if the original file is defined
in this way for creating overlaying logos.

ImageFieldUpdate

Updates the image field associated with an image asset.

Parameters

Name Type Description

assetHandle xsd:string Asset handle.
resolution xsd:double Image resolution in pixels per inch.
Data types 236

Name Type Description

anchorX xsd:int X axis image anchor.
anchorY xsd:int Y axis image anchor.
userData xsd:string Value of userData metadata field, which
is published to the image serving user data
catalog field.

ImageFieldUpdateArray

An array of image field updates.

Parameters

Name Type Description

items types:ImageFieldUpdate Array of image field updates.

ImageFormat

Unstructured named set of image output settings.

Not an asset type.

Parameters

Name Type Description

imageFormatHandle xsd:string Image format handle.
name xsd:string Image format name.
urlModifier xsd:string Image server URL that represents the
image format.

ImageFormatArray

Array of image formats.

Parameters

Name Type Description

items types:ImageFormat Array of image formats.

ImageInfo

Properties of an image asset.

Data types 237

Parameters

Name Type Description

originalPath xsd:string
Relative path to the original file.

originalFile xsd:string
File name.

optimizedPath xsd:string
Path to the IPS-optimized image file.

optimizedFile xsd:string
The IPS-optimized image file.

maskPath xsd:string
Path of the mask of the image.

maskFile xsd:string
Filename of the mask.

width xsd:int
Image width in pixels.

height xsd:int
Image height in pixels.

fileSize xsd:int
Image size in bytes.

resolution xsd:double
Pixels per inch.

sku xsd:string
Product ID.

description xsd:string
Image description.

comments xsd:string
Comments (deprecated).

userData xsd:string
User information associated with the
image (deprecated).

anchorX xsd:int
Horizontal anchor point in pixels.

anchorY xsd:int
Vertical anchor point in piexels.

urlModifier xsd:string
Image server URL parameter.

urlPostApplyModifier xsd:string
Parameters concatenated to the end of
the urlModifier. Query string format
list of parameters that are commands to
the image server. Values are in the image
server protocol guide.
Data types 238

Name Type Description

zoomTargets types:ZoomTargetArray
Array of zoom targets (5 max).

masks types:MaskArray
Masks array.

imageMaps types:ImageMapsArray
Image maps array.

ImageMap

Target for a click action in the browser.

Always associated with an image. You can get an ImageMap target from ImageInfo.

Parameters

Name Type Description

imageMapHandle xsd:string Image map handle.
name xsd:string Image map name.
region xsd:string Image map coordinates. Format is based
on the HTML <area> tag attribute.
action xsd:string Other attributes to include in the HTML
<area> tag, including the href URL.

shapeType xsd:boolean A RegionShape value.

position xsd:string Position in the format of the HTML
<area> element’s coords attribute. For
example: coords ="0,0,84,128".
enabled xsd:boolean True if image map is enabled.
lastModified xsd:dateTime Date and time the image map was last
modified.

ImageMapArray

An array of image maps.

Parameters

Name Type Description

items types:ImageMap The image map array.
Data types 239

ImageMapDefinition

Target definition for a click action in the browser.

Parameters

Name Type Description

name xsd:string The name of the image map definition.
shapeType xsd:string One of region shape values.
region xsd:string Image map coordinates. The format is
based on the HTML <area> tag
attributes.
action xsd:string Other attributes to include in the HTML
<area> tag, including the href URL.

enabled xsd:boolean True if the image map is enabled.

ImageMapDefinitionArray

An array of image map definitions.

Parameters

Name Type Description

items types:ImageMapDefinition Array of image map definitions.

ImageRenderingPublishJob

Publishes files to the image rendering servers.

Parameters

Name Type Description

emailSetting xsd:string Choice of email settings.
httpCompletionUrl xsd:string URL to send a completion notice.
contextHandle xsd:string Handle to the publish context.

ImageServingPublishJob

Publishes files to the image servers.

Data types 240

Parameters

Name Type Description

publishType xsd:string One of the available publish types.
emailSetting xsd:string Choice of email settings.
httpCompletionUrl xsd:string URL to send a completion notice.

ImageSetMember

Assets that belong to an image set.

Page reset means that an eCatalog should start a new page. RenderSet indicates that it is part of a RenderSet swatch. The
value is forced to true for eCatalog and RenderSet sets.

Parameters

Name Type Description

asset type:Asset Assets in the image set array.
pageReset xsd:boolean Starts a new page. Setting is ignored and
value is forced to true for eCatalog and
RenderSet sets.

ImageSetMemberArray

An array of image set members.

Parameters

Name Type Description

items types:ImageSetMember The array of image set members.

ImageSetMemberUpdate

Within this type, the pageReset field is meaningful for RenderSet and Catalog image asset types:
• For RenderSet, pageReset indicates the start of a new render view/swatch group.
• For Catalog, pageReset indicates the start of a new page view. Typically, there are 2 page images per page view, but you can
have more or fewer.

Parameters

Name Type Description

assetHandle xsd:string Asset handle in the image set member
array.
Data types 241

Name Type Description

pageReset xsd:boolean Resets the page.
Setting is ignored and value is forced to
true for ImageSet and SpinSet.

ImageSetMemberUpdateArray

An array of image set member updates.

Parameters

Name Type Description

items types:ImageSetMemberUpdate The array of image set member updates.

InDesignInfo

InDesign file properties.

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:string File name.
fileSize xsd:int File size.

JavascriptInfo

Properties of a JavaScript file asset.

Parameters

Name Type Description

originalPath xsd:string Path to the JavaScript file.

originalFile xsd:string File name.

fileSize xsd:int File size.

JobLog

The job log after the job has run.

Data types 242

Parameters

Name Type Description

companyHandle xsd:string Company handle.
jobHandle xsd:string Job handle.
jobName xsd:string Job name.
originalJobName xsd:string The original name submitted for the job
with submitJob.
submitUserEmail xsd:string The email address of the user who
submitted the job.
logType xsd:string Choice of job log types.
jobSubType xsd:string Additional job information.
startDate xsd:dateTime The start date, time, and time zone of the
job.
endDate xsd:dateTime The end date, time, and time zone of the
job.
description xsd:string A description of the job as originally
specified in submitJob.
fileSuccessCount xsd:int Number of files successfully processed.
fileErrorCount xsd:int Number of files that caused an error.
fileWarningCount xsd:int Number of files that generated a warning.
fileDuplicateCount xsd:int Number of duplicate files.
fileUpdateCount xsd:int Number of files updated.
totalFileCount xsd:int Number of files processed by the logged
job.
transferSuccessCount xsd:int Number of successful transfers.
transferErrorCount xsd:int Number of transfer errors.
transferWarningCount xsd:int Number of transfer warnings.
fatalError xsd:boolean Whether the job generated a fatal error.
detailTotalRows xsd:int The total number of rows matching the
query, which may be larger than the size
of detailArray due to page size limits.
detailArray types:JobLogDetailArray The array of details about the logged job.

JobLogArray

An array of job logs.

Data types 243

Parameters

Name Type Description

items types:JobLog The array of job logs.

JobLogDetail

Job log information.

Parameters

Name Type Description

logMessage xsd:string Messages in the job log.
logType xsd:string Job log file type.
assetName xsd:string Name of asset in the job log (optional).
assetType xsd:string Choice of asset type.
assetHandle xsd:string Asset handle referenced in the job log.
auxArray types:JobLogDetailAuxArray Provides additional detailed job log
information beyond the five job log types
described above.

JobLogDetailArray

Array of job log details.

Parameters

Name Type Description

items types:JobLogDetail An array of job log details.

JobLogDetailAux

Contains supplementary messages associated with the main job log message (JobDetail). Includes warnings and other details
associated with the currently processed asset.

Parameters

Name Type Description

logMessage xsd:string An auxiliary message.
logType xsd:string Log type:
IPSJobLog.gcUploadWarning or
IPSJobLog.gcUploadError.

dateCreated xsd:dateTime Auxiliary job log creation date.

Data types 244

JobLogDetailAuxArray

Array of auxiliary job log detail types.

Parameters

Name Type Description

items types:JobLogDetailAux An array of auxiliary job log detail types.

Keywords

Parameters

Name Type Description

keyword xsd:string Keyword.
status xsd:boolean Keyword validity.
x xsd:int Keyword position on the x axis (in pixels).
y xsd:int Keyword position on the y axis (in pixels).
width xsd:int Keyword width in pixels.
height xsd:int Keyword height in pixels.

KeywordsArray

An array of keywords.

Parameters

Name Type Description

items types:Keywords An array of keywords.

KnockoutBackgroundOptions

Mask (knock-out) the background for selected images. This lets you overlay them in other layers with a transparency outside
of subject image. An optional parameter that is off by default.
KnockoutBackgroundOptions=[corner, tolerance, fill]
Data types 245

Parameters

Name Type Description

corner xsd:string Selects the corner you want to work with. corner accepts
these values:
• UpperLeft
• BottomLeft
• UpperRight
• BottomRight

tolerance xsd:double An optional setting that removes white space from image
edges based on transparency. Accepts a range of values
from 0.0 to 1.0. Specify:
• 0 to match colors exactly.
• 1 to enable the most color differences.

fillMethod xsd:string
Control pixel transparency in the location specified by
the corner variable. The fillMethod accepts these
values:
• FloodFill: Turns all pixels in the specified corner
transparent.
• MatchPixel: Turns all matching pixels transparent
regardless of location.

Example
<complexType name="KnockoutBackgroundOptions">
<sequence>
<!-- corner one of UpperLeft, BottomLeft, UpperRight, BottomRight -->
<element name="corner" type="xsd:string" minOccurs="1"/>
<!-- Tolerance real value between 0.0 and 1.0 -->
<element name="tolerance" type="xsd:double" minOccurs="0"/>
<!-- one of FloodFill or MatchPixel is required -->
<element name="fillMethod" type="xsd:string" minOccurs="1"/>
</sequence>
</complexType>

Used By
The KnockoutBackgroundOptions type is used by:
• UploadDirectoryJob
• UploadPostJob
• UploadUrlsJob

LayerViewInfo

Layer view properties.

Data types 246

Parameters

Name Type Description

url xsd:string Image server URL that represents the
template. Combines urlModifier and
urlPostAp- plyModifier fields.

urlModifier xsd:string Image serving protocol commands to

apply prior to request or
urlPostApplyModifier commands.

urlPostApplyModifier xsd:string Image serving protocol commands to

apply after urlModifier and request
commands.

ManualCropOptions

Manual crop options for images.

Parameters

Name Type Description

left xsd:int The left position of the manual crop in
pixels.
right xsd:int The right position of the manual crop in
pixels.
top xsd:int The top position of the manual crop in
pixels.
bottom xsd:int The bottom position of the manual crop
in pixels.

Mask

Masks part of an image. The mask is always associated with the image. Get a mask from ImageInfo.

Parameters

Name Type Description

maskHandle xsd:string Mask handle.
name xsd:string Mask name.
maskPath xsd:string Relative path to the mask.
maskFile xsd:string Mask file.
lastModified types:dateTime The date, time, and time zone the mask
was last modified.
Data types 247

MaskArray

An array of masks.

Parameters

Name Type Description

items types:Mask Array of masks.

MaskInfo

Mask file properties.

Parameters

Name Type Description

maskPath xsd:string Mask file path.
maskFile xsd:string Mask file name.

MasterVideoInfo

File information for master video assets.

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:string File name.
fileSize xsd:int File size.

MediaOptions

Generates thumbnail image for your video.

Parameters

Name Type Description

videoEncodingPresetsArray types:HandleArray An array of PropertySet handles
referencing video encoding presets for
transcoding videos.
Data types 248

Name Type Description

generateThumbnail xsd:boolean When true, the first frame of the video is
extracted and used as the thumbnail
image.
thumbnailOptions types:ThumbnailOptions Optional. Lets you choose a particular
video frame to use as the thumbnail
image.
To specify a thumbnail image, pass in the
time (in milliseconds from video start)
for the frame you want to use. Values
range from 0 to the end of the video.

Note: If you specify the time

incorrectly, generateThumbnail
defaults to true.

See ThumbnailOptions.

Example
<complexType name="MediaOptions">
<sequence>
<element name="videoEncodingPresetsArray" type="types:HandleArray" minOccurs="0"/>

<element name="generateThumbnail" type="xsd:boolean" minOccurs="0"/>

<element name="thumbnailOptions" type="types:ThumbnailOptions" minOccurs="0"/>
</sequence>
</complexType>

Used by
The mediaOptions type is used by:
• UploadDirectoryJob
• UploadPostJob
• UploadURLsJob

Metadata

A metadata field returned by searchAssets.

Parameters

Name Type Description

name xsd:string Metadata name.
value xsd:string Metadata value.
boolVal xsd:boolean Boolean metadata value (for
Boolean-typed fields only).
Data types 249

Name Type Description

longVal xsd:long Long metadata value (for int-typed fields
only).
doubleVal xsd:double Double metadata value (for float-typed
fields only).
dateVal xsd:dateTime Date metadata value (for date-typed fields
only).

MetadataArray

An array of metadata.

Parameters

Name Type Description

items type:Metadata An array of metadata.

MetadataCondition

Adds a search term for use with searchAssets.

Parameters

Name Type Description

fieldHandle xsd:string Field handle.
op xsd:string Choice of string comparison operators.
value xsd:string Value to test.
boolVal xsd:boolean Boolean comparison value (for
Boolean-typed fields only).
longVal xsd:long Long comparison value (for int-typed
fields only).
minLong xsd:long Minimum long value in range
comparison (for int-typed fields only).
maxLong xsd:long Maximum long value in range
comparison (for int-typed fields only).
doubleVal xsd:double Double comparison value (for float-typed
fields only).
minDouble xsd:double Minimum double value in range
comparison (for float-typed fields only).
maxDouble xsd:double Maximum double value in range
comparison (for float-typed fields only).
Data types 250

Name Type Description

dateVale xsd:dateTime Date comparison value (for date-typed
fields only).
minDate xsd:dateTime Minimum date value in range comparison
(for date-typed fields only).
maxDate xsd:dateTime Maximum date value in range
comparison (for date-typed fields only).
caseSensitive
Establishes case-sensitivity for the
Metadata Server. Used in the
searchAssetsByMetadata call.

See searchAssetsByMetadata.

MetadataConditionArray

An array of metadata conditons.

Parameters

Name Type Description

items types:MetadataCondition The array of metadata conditons.

MetadataDelete

Metadata to delete from the asset.

Parameters

Name Type Description

xsd:string
fieldHandle Metadata parameters to delete.

MetadataDeleteArray

An array of metadata to delete from the asset.

Parameters

Name Type Description

items type:Metadata An array of metadata parameters to
delete.
Data types 251

MetadataField

User-defined field definitions for specific assets.

Retrieve tag field definitions with the getMetadataFields or getAssetMetadataField operations.

Parameters

Name Type Description

fieldHandle xsd:string Metadata field handle.
name xsd:string Metadata field name.
type xsd:string Metadata field type.
defaultValue xsd:string Default value for the metadata field.
isRequired xsd:boolean Sets required status.
isUserDefined xsd:boolean Determines if the metadata field is defined by
the user or not.
isHidden xsd:boolean Hide or expose IPS system-specific metadata.
Returned from getMetadataFields and
getAssetMetadataFields.
isEnforced xsd:boolean
A boolean flag that indicates whether the
metadata field type is enforced (validated) when
the value is set.

If set to true, then a fault is thrown if an illegal

value is set in setAssetMetadata
/batchSetAssetMetadata.

initialTagValue xsd:string Allows you create a set of shared enumerated

values that selected tags can point to.

MetadataFieldArray

An array of metadata fields

Parameters

Name Type Description

items types:MetadataField Metadata field array.

MetadataPublishJobType

Publishes metadata to the metadata server.

Data types 252

Parameters

Name Type Description

forcePublish xsd:boolean Set to True to publish all data to the

metadata server again.

Note: Depending on the amount of

data, this can take several minutes
to a few hours.

Do not set this parameter if you want to

publish new or changed metadata only.

MetadataUpdate

Sets metadata values for a specific asset used with setAssetMetadata. Describes the changes you want to make to metadata.

Note: If the single value field is passed, the asset’s tag value will be reset to the specified tag value.

Parameters

Name Type Description

fieldHandle xsd:string Metadata field handle.
value xsd:string Metadata update value.
boolVal xsd:boolean Boolean metadata value (for
Boolean-typed fields only).
longVal xsd:long Long metadata value (for int-typed fields
only).
doubleVal xsd:double Double metadata value (for float-typed
fields only).
dateVal xsd:dateTime Date metadata value (for date-typed fields
only).
addTagValueArray types:StringArray
Adds to the existing tag value list for the
asset.
• Single-value tag fields store the last value
only.
• A fixed dictionary tag field returns a
fault if the value is not in the dictionary.

setTagValueArray types:StringArray Replaces the existing tag value list for the
asset.
• Single-value tag fields store the last value
only.
Data types 253

Name Type Description

• A fixed dictionary tag field returns a
fault if the value is not in the dictionary.

deleteTagValueArray types:StringArray Deletes the specified values from the

asset’s tag value list, if present.

MetadataUpdateArray

An array of metadata updates.

Parameters

Name Type Description

items types:MetadataUpdate Array of metadata updates.

MPEvent

A MediaPortal event.

Parameters

Name Type Description

eventType xsd:string Media Portal event type.
createDate xsd:dateTime Event creation date.
ipsUser xsd:string System or user triggering the event.
companyId xsd:int Company ID.
companyName xsd:string Comany name.
jobName xsd:string A unique job name.
jobDescription xsd:string A useful description for the job.
string1 xsd:string Holder for string information (optional).
string2 xsd:string Holder for string information (optional).
string3 xsd:string Holder for string information (optional).
string4 xsd:string Holder for string information (optional).
string5 xsd:string Holder for string information (optional).
int1 xsd:int Holder for integer information (optional).
int2 xsd:int Holder for integer information (optional).
int3 xsd:int Holder for integer information (optional).
int4 xsd:int Holder for integer information (optional).
int5 xsd:int Holder for integer information (optional).
Data types 254

Name Type Description

float1 xsd:double Holder for float information (optional).
float2 xsd:double Holder for float information (optional).
float3 xsd:double Holder for float information (optional).
time1 xsd:dateTime Holder for date/timestamp information
(optional).

MPEventArray

An array of MediaPortal events.

Parameters

Name Type Description

items types:MPEvent MediaPortal event array.

OperationFault

Detail message responding to one the URLs provided in the CDN invalidation request.
Supported Since

4.5.0, patch 2011-02

Parameters

Name Type Description

code xsd:int Error code provided from the CDN

reason xsd:string Error message provided from the CDN

OperationFaultArray

An array of messages responding to one the URL provided in the CDN invalidation request.
Supported Since

4.5.0, patch 2011-02

Parameters

Name Type Description

items types:OperationFault The list of messages resulting from the

CDN invalidate request.
Data types 255

OptimizeImagesJob

Details for an optimize images job.

Parameters

Name Type Description

emailSetting xsd:string An email settings field.

PdfInfo

PDF file properties.

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:int File name.
fileSize xsd:int File size.

PDFOptions

PDF file options.

Parameters

Name Type Description

process xsd:string Choice of "PDF processes."
resolution xsd:double File resolution.
colorspace xsd:string Post-script Colorspace Mode choice.
pdfCatalog xsd:boolean Whether to combine a multiple page PDF
into an eCatalog after rendering (default
is true).
extractSearchWords xsd:boolean Whether to extract search words from the
PDF file.
extractLinks xsd:boolean Whether to extract PDF links into image
maps assigned to the rasterized pages
within IPS.

PdfSettingsInfo

The properties of a PDF settings file asset.

Data types 256

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:string File name.
fileSize xsd:int File size.

Permission

Manages rights to access, modify, create, or delete assets by group.

Parameters

Name Type Description

groupHandle xsd:string Group handle.
groupName xsd:string Group name.
permissionType xsd:string Choice of permission type.
isAllowed xsd:boolean Determines if the permission is allowed.
isOverride xsd:boolean Determines if the permission overrides
another.

PermissionArray

An array of permissions.

Parameters

Name Type Description

items types:Permission The permissions array.

PermissonSet

Parameters

Name Type Description

PermissionSetHandle xsd:string Handle to a permissions set.
permissionArray types:PermissionArray An array of permissions.
Data types 257

PermissionSetArray

Parameters

Name Type Description

items types:PermissionSet Array of permission sets.

PermissionUpdate

Describes permission changes.

Parameters

Name Type Description

groupHandle xsd:string Group handle.
permissionType xsd:string Permission type.
isAllowed xsd:boolean Determines if the permission update is
allowed.
isOverride xsd:boolean Determines if the permission overrides
another.

PermissionUpdateArray

An array of permission updates.

Parameters

Name Type Description

items types:PermissionUpdateArray The permissions update array.

PerspectiveQuad

Image location coordinates returned by the getPhotoshopPath operation.

Parameters

Name Type Description

x0 xsd:double Upper left x-axis coordinate.
y0 xsd:double Upper left y-axis coordinate.
x1 xsd:double Upper right x-axis coordinate.
Data types 258

Name Type Description

y1 xsd:double Upper right y-axis coordinate.
x2 xsd:double Lower right x-axis coordinate.
y2 xsd:double Lower right y-axis coordinate.
x3 xsd:double Lower left x-axis cooridnate.
y3 xsd:double Lower left y-axis coordinate.

Example
The PerspectiveQuad type returns data in this order:
<complexType name="PerspectiveQuad">
<sequence>
<element name="x0" type="xsd:double"/>
<element name="y0" type="xsd:double"/>
<element name="x1" type="xsd:double"/>
<element name="y1" type="xsd:double"/>
<element name="x2" type="xsd:double"/>
<element name="y2" type="xsd:double"/>
<element name="x3" type="xsd:double"/>
<element name="y3" type="xsd:double"/>
</sequence>

PhotoshopOptions

Options for Photoshop images.

Parameters

Name Type Description

layerOptions types:PhotoshopLayerOptions Array of Photoshop layer options.
process xsd:string Photoshop process options:
• None
• MaintainLayers

PhotoshopLayerOptions

Photoshop image layer options.

Parameters

Name Type Description

layerNaming xsd:string Choice of Photoshop Layer Naming
Modes.
anchor xsd:string Choice of Photoshop Anchor Modes.
createTemplate xsd:boolean Whether to create a template from
Photoshop layers.
Data types 259

Name Type Description

extractText xsd:boolean Whether to extract text as text layers.
extendLayers xsd:boolean Whether to extend layers to full size of
background.

PostScriptInfo

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:string File name.
fileSize xsd:int File size.

PostScriptOptions

PostScript file options.

Parameters

Name Type Description

process xsd:string PostScript process choice.
resolution xsd:double File resolution.
colorspace xsd:string PostScript colorspace mode.
alpha xsd:boolean Whether to rasterize the file into an
image. If so, it will create a transparent
background if the original file if is defined
in this way. Generally used to create
overlaying logos.
extractSearchWords xsd:boolean Whether to extract search words from the
PostScript file.

PowerPointInfo

PowerPoint file options.

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:string File name.
Data types 260

Name Type Description

fileSize xsd:int File size.

PremierExpressRemixInfo

Properties of a PremierExpressRemix file asset.

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:string File name.
fileSize xsd:int File size.

Project

Set of named assets.

Parameters

Name Type Description

project Handle xsd:string Project handle.
name xsd:string Project name.

ProjectArray

An array of projects.

Parameters

Name Type Description

items types:Project The project array.

Property

A name and value pair.

Parameters

Name Type Description

name xsd:string Property name.
Data types 261

Name Type Description

value xsd:string Property value.

PropertyArray

An array of properties.

Parameters

Name Type Description

items types:Property The property array.

PropertySet

Type and value for a property set.

Parameters

Name Type Description

setHandle xsd:string Property set handle.
typeHandle xsd:string Handle to the property set type.
propertyArray types:PropertyArray Name-value pair. Can contain zero items.

PropertySetArray

An array of property sets.

Parameters

Name Type Description

items types:PropertySet Property set array.

PropertySetType

Valid values for the PropertySetType and createPropertySetTypeParam fields.

Values include:
• UserProperty
• CompanyProperty
• UserCompanyProperty
Data types 262

Parameters

Name Type Description

typeHandle xsd:string Type handle.
companyHandle xsd:string Company handle.

Note: The type is global if the

company handle is not present.

name xsd:string Type name.

propertyType xsd:string One of Property Set Types. See Input
(createPropertySetTypeParam).
allowMultiple xsd:boolean Whether to allow multiple property set
instances to be attached to an object for
this type.

PropertySetTypeArray

Property set type array.

Parameters

Name Type Description

items types:PropertySetType The property set type array.

PsdInfo

Photoshop file properties.

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:string File name.
optimizedPath xsd:string File path.
optimizedFile xsd:string File name.
fileSize xsd:int File size.

PublishContext

Defines a publish target for a company.

Data types 263

Parameters
Assets maintain a separate marker for each publish state and context. Set the publish state with setAssetsContextState.

Name Type Description

contextHandle xsd:string Handle to the publish context.

contextName xsd:string Name of the publish context.

contextType xsd:string Type of publish context. Includes:

• ImageServing
• ImageRendering
• Video
• ServerDirectory

PublishContextArray

An array of publish contexts.

Parameters

Name Type Description

PublishContextArray types:PublishContext An array of publish contexts.

PublishHistory

Publication history of an asset.

Parameters

Name Type Description

serverName xsd:string Name of the server that owns the publish
history.
contextName xsd:string Publish history context name.
publishFormat xsd:string Publish format.
lastPublished xsd:dateTime Date and time the asset was last
published.

PublishHistoryArray

An array of publish histories.

Data types 264

Parameters

Name Type Description

items types:PublishHistory The publish history array.

PublishStateUpdate

Parameters used to update the publish state of an asset.

Parameters

Name Type Description

assetHandle xsd:string Asset handle.
publishState xsd:string New publish state.

PublishStateUpdateArray

An array of publish state updates.

Parameters

Name Type Description

items types:PublishStateUpdate The array of publish state updates.

RenderSceneInfo

Render scene asset properties.

Parameters

Name Type Description

url xsd:string Image server URL that represents the
render scene.

ReprocessAssetsJob

Job type to allow reprocessing of previously uploaded master files, including reripping PDFs and reoptimizing images.

Parameters

Name Type Description

assetHandleArray types:HandleArray Asset handle.

Data types 265

Name Type Description

readyForPublish xsd:boolean Whether the files are marked ready for

publishing.

preservePublishState xsd:boolean Controls whether the publish state of an

existing asset is preserved when
overwriting. If not set, the company
default setting is used.

createMask xsd:boolean Whether to create a mask.

Controls preservation of any existing crop

preserveCrop xsd:boolean
definition. Defaults to true.

manualCropOptions types:ManualCropOptions Manual crop options.

autoColorCropOptions types:AutoColorCropOptions Options for automatic crops of images

based on color.

autoTransparentCropOptions types:AutoTransparentCropOptions Removes white space from the edges of

images, based on transparency.

photoshopOptions types:PhotoshopOptions Options for uploading Photoshop files to

the Image Server.

postScriptOptions types:PostScriptOptions Options for uploading PostScript files to

the Image Server.

pdfOptions types:PDFOptions Options for uploading PDF files to the

Image Server.

mediaOptions types:MediaOptions A/V media file options.

illustratorOptions types:IllustratorOptions Options for uploading Illustrator files to

the Image Server.

colorManagementOptions types:ColorManagementOptions Options that you can specify during an

upload. The set affects how the color is
managed for the upload.

autoSetCreationOptions types:AutoSetCreationOptions Array of automatic set generation scripts

to apply to uploaded files.

projectHandleArray types:HandleArray An array of project handles.

Data types 266

Name Type Description

emailSetting xsd:string Options for email settings.

postJobOnlyIfFiles xsd:boolean Whether to upload only files.

postHttpUrl xsd:string URL to file upload location.

postImageServingPublishJob types:ImageServingPublishJob Job details for an image serving publish

job to be run after the upload is complete.

postImageRenderingPublishJob types:ImageRenderingPublishJob Job details for an image rendering publish

job to be run after the upload is complete.

postVideoPublishJob types:VideoPublishJob Job details for a video publish job to be

run after the upload is complete.

inDesignOptions types:InDesignOptions Options for uploading InDesign files to

the image server.

knockoutBackground types:KnockoutBackgroundOptions Mask the background for selected images.

This lets you overlay them in other layers
with a transparency outside of subject
image.

Optional.

SeeKnockoutBackgroundOptions

unsharpMaskOptions types:UnsharpMaskOptions 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.

Notes

Choices for *CropOptions include:

• manualCropOptions
• autoColorCropOptions
• autoTransparentCropOptions

Choices for *PublishJob include:

• postImageServingPublishJob
• postImageRenderingPublishJob
• postVideoPublishJob
Data types 267

RipPdfsJob

A process that re-rips an existing PDF asset.

Note: This job type is deprecated. Transition to ReprocessAssetsJob for all future integrations.

Parameters

Name Type Description

pdfHandleArray types:HandleArray Handle to the array of PDF files to be

ripped.

createMask xsd:boolean Determines if you want to create a mask

or not.

manualCropOptions types:ManualCropOptions Manual cropping options.

autoColorCropOptions types:AutoColorCropOptions Automatic cropping options.

autoTransparentCropOptions types:PostTransparentCropOptions

postScriptOptions types:PostScriptOptions

pdfOptions types:PDFOptions

illustratorOptions types:IllustratorOptions

colorManagementOptions types:ColorManagementOptions

projectHandleArray types:HandleArray An array of project handles.

emailSetting xsd:string Email settings.

postHttpUrl xsd:string The URL where the files are being

uploaded to.

postImageServingPublishJob types:ImageServingPublishJob Job details for an image serving publish

job to be run after the upload is complete.

postImageRenderingPublishJob types:ImageRenderingPublishJob Job details for an image rendering publish

job to be run after the upload is complete.
Data types 268

Name Type Description

postVideoPublishJob types:VideoPublishJob Job details for a video publish job to be

run after the upload is complete.

inDesignOptions types:InDesignOptions Options for uploading Adobe InDesign

files to the image server.

knockoutBackground types:KnockoutBackgroundOptions Mask the background for selected images.

This lets you overlay them in other layers
with a transparency outside of subject
image.

Optional.

SeeKnockoutBackgroundOptions

Notes
Choices for *CropOptions include:

• manualCropOptions
• autoColorCropOptions
• autoTransparentCropOptions

Choices for *PublishJob include:

• postImageServingPublishJob
• postImageRenderingPublishJob
• postVideoPublishJob

RTFInfo

Properties of an RTF file asset.

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:string File name.
fileSize xsd:int File size.

ScheduledJob

A job that is scheduled to run.

Data types 269

Parameters

Name Type Description

companyHandle xsd:string Company handle.
jobHandle xsd:string Scheduled job handle.
name xsd:string Job name.
originalName xsd:string Original name of the scheduled job.
type xsd:string Job type.
submitUserEmail xsd:string The email address of the user who
scheduled the job.
locale xsd:string The locale to be used for job log details
and email localization. Locales are
specified as <language_code>[-
<country_code>], where the language
code is a lower-case, two-letter code as
specified by ISO-639, and the optional
country code is an upper-case, two-letter
code as specified by ISO-3166. For
example, the locale string for English
(United States) would be: en-US.
description xsd:string A description of the job as originally
specified in submitJob.
execSchedule xsd:string When the job is scheduled to run.
nextFireTime xsd:dateTime The date, time, and time zone when the
job will be fired.
timeZone xsd:dateTime The time zone of the scheduled job.
triggerState xsd:int Choice of job trigger state.
imageServingPublishJob types:ImageServingPublishJob Job details for an image serving publish
job.
imageServingRenderJob types:ImageServingRenderJob Job details for an image rendering job.
videoPublishJob types:VideoPublishJob Job details for a video publish job. See
VideoPublishJob.
serverDirectoryPublishJob types:ServerDirectoryPublishJob Job details for a server directory publish
job.
uploadDirectoryJob types:UploadDirectoryJob Job details for an upload directory job.
uploadUrlsJob types:UploadUrlsJob Job details for an upload URLs job.
optimizeImagesJob types:OptimizeImagesJob

ripPdfsJob types:RipPdfsJob

reprocessAssetsJob types:ReprocessAssetsJob

exportJob types:ExportJob Allow authorized export of previously

uploaded files. See Export Job.
Data types 270

Notes
When you specify a job type value in submitJob, the system returns a job based on that type. The following jobs can be returned:
• imageServingPublishJob
• imageRenderingPublishJob
• videoPublishJob
• serverDirectoryPublishJob
• uploadDirectorhJob
• uploadUrlsJob

ScheduledJobArray

An array of scheduled jobs.

Parameters

Name Type Description

items types:ScheduledJobs A scheduled jobs array.

SearchFilter

Filters that help you define search criteria to make searches more efficient.

Parameters

Name Type Description

folder xsd:string Specify the folder you want to search.

Leave blank to search across and entire
company.

includeSubfolders xsd:boolean Set to:

• True: To search the named folder and
all subfolders.
• False: To search the named folder only.

assetTypeArray type:StringArray A list of asset types that you want to

return in a search. For example, image.

excludeAssetTypeArray type:StringArray Specify an asset type to exclude from a

search. For example, image.

assetSubTypeArray type:StringArray A list of asset sub-types you want to

return in a search. For example, for an
AssetSet, you can search for the
MediaType sub-type.
Data types 271

Name Type Description

strictSubTypeCheck xsd:boolean
An optional boolean flag that specifies
whether to return assets with no subtype
when assetSubTypeArray is passed.

If true, then only assets with one of the

specified subtypes is returned.

If false, then assets with no subtype are

also returned.

Defaults is false.

excludeByproducts xsd:boolean Set to:

• True: To return original assets only.
• False: To return generated content.
For example, images from an uploaded
PDF.

projectHandle xsd:string Handle to the project you want to search.

publishState xsd:string Specify:

• MarkedForPublish to return
published assets only.
• NotMarkedForPublish to return
unpublished assets only.

Note: Leave blank to search for all

published state types.

trashState xsd:string Specify:

• Any to return assets regardless of their
trash state.
• NotInTrash to return 'normal' assets.
• InTrash to return assets from the trash.

SearchStrings

Search string record extracted from a PDF file.

Parameters

Name Type Description

searchString xsd:string Search string text.
keywordsArray types:KeywordsArray Array of keywords in the search string.
Data types 272

Name Type Description

status xsd:boolean True if the search string is valid and
enabled.
x xsd:int X axis position of the search string.
y xsd:int Y axis position of the search string.
width xsd:int Search string width.
height xsd:int Search string height.
fontName xsd:string Name of the font used in the search
string.
pointSize xsd:string Font size.

SearchStringsArray

An array of search strings.

Parameters

Name Type Description

items types:SearchStrings An array of search strings.

ServerDirectoryPublishJob

Publishes all the images, templates, and spin sets that are marked ready to publish to a server directory.

Parameters

Name Type Description

emailSettings xsd:string Choice of email settings.
httpCompletionUrl xsd:string URL to send a completion notice.

SetMetadataFault

Warning or error details for a sing update in a batchSetAssetMetadata operation.

Parameters

Name Type Description

assetHandle xsd:string The asset whose metadata was
unsuccessfully set.
fieldHandle xsd:string The handle to the metadata field whose
value was unsuccessfully set.
Data types 273

Name Type Description

code xsd:int Fault code.
reason xsd:string Fault description (plain-text).

SetMetadataFaultArray

An array of metadata faults.

Parameters

Name Type Description

items types:SetMetadataFault An array of metadata faults.

SetPropertySetPermissions

Parameters

Name Type Description

setHandle xsd:string Handle to the property set.

permissionsArray types:PermissionUpdateArray An array of permissions.

SvgInfo

Properties of an SVG file asset.

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:string File name.
fileSize xsd:int File size.

StringArray

An array of strings.

Parameters

Name Type Description

items xsd:string An array of strings.
Data types 274

SwcInfo

Properties of an SWC file asset.

Parameters

Name Type Description

originalPath xsd:string Path to the SWC file.

originalFile xsd:string File name.

fileSize xsd:int File size.

SystemFieldCondition

A system field search condition for the searchAssets operation.

For unary compares, pass exactly one value (boolVal, longVal, doubleVal, or dateVal) depending on the system field
type. For search ranges, pass min<Type> and max<Type> parameters and pass an op value of Between or NotBetween.

Parameters

Name Type Description

field xsd:string Choice of Asset Search System Fields.
op xsd:string Choice of String Comparison Operators.
value xsd:string Value to test against.
boolVal xsd:boolean Boolean comparison value.
longVal xsd:long Long comparison value.
minLong xsd:long Lower boundary of long range.
maxLong xsd:long Upper boundary of long range.
doubleVal xsd:double Double comparison value.
minDouble xsd:double Lower boundary of double range.
maxDouble xsd:double Upper boundary of double range.
dateVal xsd:dateTime Date comparison value.
minDate xsd:dateTime Date range minium.
maxDate xsd:dateTime Date range maximum.

Example
<systemFieldConditionArray>
<items>
<field>LastModified</field>
<op>Between</op>
<minDate>2007-08-01T00:00:00</minDate>
<maxDate>2007-12-01T00:00:00</maxDate>
Data types 275

</items>
</systemFieldConditionArray>

SystemFieldConditionArray

An system field condition array.

Parameters

Name Type Description

items types:SystemFieldConditions An array of system field conditions.

TagCondition

Defines search conditions for tag fields.

Parameters

Name Type Description

fieldHandle xsd:string Tag field handle.
op xsd:string Depends on the tag field type and whether
the value or valueArray field is used.
• If value is passed, op must be the string
constant Matches. The condition
matches any asset that is associated with
the tag value.
• If valueArray is passed, the op field
can be the constant MatchesAny for
either single or multivalued tag fields.
A MatchesAny condition matches any
asset that is associated with at least one
of the tag values in valueArray.
• For multi-valued tag fields, the op field
can be set to the constant MatchesAll
with the valueArray field. In this case,
the condition only matches assets that
are associated with all of the tag values
in valueArray (possibly in addition to
other tag values).

value xsd:string A matching value.

valueArray types:StringArray Multiple matching values.

TagConditionArray

An array of tag conditions.

Data types 276

Parameters

Name Type Description

items types:TagCondition An array of tag conditions.

TagConditionArray

An array of tag conditions.

Parameters

Name Type Description

items types:TagCondition An array of tag conditions.

TagFieldValues

An array of values for a tag field.

Parameters

Name Type Description

fieldHandle xsd:string Tag field handle.
valueArray xsd:StringArray An array of values for a tag field.

TagFieldValuesArray

An array of tag field values.

Parameters

Name Type Description

items types:TagFieldValues An array of tag field values.

TagValueUpdate

Defines old and new tag field values.

Parameters

Name Type Description

oldValue xsd:string Original tag field value.
newValue xsd:string New tag field value.
Data types 277

TagValueUpdateArray

An array of tag value updates.

Parameters

Name Type Description

items types:TagValueUpdate An array of tag value updates.

TagValueUpdateFault

The error thrown when a tag value update fails.

Parameters

Name Type Description

value xsd:string Tag value for which the update failed.
code xsd:int Error code number.
reason xsd:string Error message (plain-text).

TagValueUpdateFaultArray

An array of tag value update faults.

Parameters

Name Type Description

items types:TagValueUpdateFault An array of tag value update faults (error
messages).

TaskItemProgress

Task item progress information.

Parameters

Name Type Description

itemName xsd:string Name of the item being processed.
progress xsd:double Progress complete %.
progressMessage xsd:string Process message.
lastProgressUpdate xsd:dateTime Time of last update.
Data types 278

TaskItemProgressArray

An array of information about a task item.

Parameters

Name Type Description

items types:TaskItemProgress Task item progress array. Minimum
occurrence is zero. Maximum is
unbounded.

TaskProgress

Task progress information.

Parameters

Name Type Description

taskType xsd:string Task type description.
numProcessed xsd:int Number of task items already processed.
numProcessing xsd:int Number of task items currently in
process.
numPending xsd:int Number of pending task items (not yet
processed).
progress xsd:double % progress (range 0.0 - 1.0).
progressMessage xsd:string Progress message.
lastProgressUpdate xsd:dateTime Time the last progress information was
last updated.
taskItemProgressArray types:TaskItemProgressArray Array of task items.
taskState xsd:string Values include:
• Unknown: When the task monitor
transitions between states.
• New: Task monitor has been created but
has not accepted tasks yet.
• Processing: Task monitor is actively
processing tasks.
• Stopping: Task monitor is stopping a
job because of a stop job request.
• Done: Jobs assigned to the task monitor
jobs have been completed.
• Failed: Indicates a fatal error.
Data types 279

TaskProgressArray

A task progress array. Contains information about video transcoding tasks.

Parameters

Name Type Description

item types:TaskProgress Task progress items. Minimum
occurrence is zero. Maximum occurrence
is unbounded.

TemplateInfo

The properties of a template asset.

Templates are parameterized layer definitions that construct a layered image.

Parameters

Name Type Description

url xsd:string Image server URL that represents the
template.
urlModifier xsd:string

urlPostApplyModifier xsd:string

ThumbAssetUpdate

Thumbnail image update.

Parameters

Name Type Description

assetHandle xsd:string Asset handle.
thumbAssetHandle xsd:string Thumb asset handle.

ThumbAssetUpdateArray

An metadata updates for thumb assets.

Parameters

Name Type Description

items types:ThumbAssetUpdates An array of thumb asset updates.
Data types 280

ThumbnailOptions

An optional type that lets you choose a particular video frame to use as the thumbnail image.

Parameters

Name Type Description

thumbnailTime xsd:long
Sets in the time (in milliseconds from
video start) for the frame you want to use
for the video thumbnail. Values range
from 0 to the end of the video.

Note: The system uses the first

frame of the video for the thumbnail
if you specify the time incorrectly.
See MediaOptions.

Example
<complexType name="ThumbnailOptions">
<sequence>
<element name="thumbnailTime" type="xsd:long" minOccurs="0"/>
</sequence>
</complexType>

UnCompressOptions

Upload setting to process ZIP and TAR files as master assets (None) or to extract and upload their contents (UnCompress).

Note: None is default.

Parameters

Name Type Description

process xsd:string
Controls ZIP and TAR archive file
processing. Provides 2 options:
• None: Process as master assets.
• UnCompress: Extract and process
contents.

Note: String constants are case

sensitive. Use UnCompress, not
uncompress or unCompress.
Data types 281

Example
<!-- uncompress zip/tar/gzip files -->
<element name="unCompressOptions" type="types:UnCompressOptions" minOccurs="0"/>
<complexType name="UnCompressOptions">
<sequence>
<!-- Options: None (default),UnCompress -->
<element name="process" type="xsd:string"/>
</sequence>
</complexType>

Used By
The unCompressionOptions type is used by:
• UploadDirectoryJob
• UploadPostJob
• UploadUrlsJob

UnsharpMaskOptions

Settings that help improve image sharpness for optimized pyramid TIF files.
unsharpMaskOptions=[amount, radius, threshold, monochrome]

Parameters
Specify a value for unsharpMaskOptions options with minOccurs="n".

Name Type Description

amount xsd:double
Controls contrast applied to edge pixels.
• Range: 0.0 - 5.0
• Default: 0

radius xsd:double
Controls sharpness by setting the number of pixels
around the edge of an image. The correct value
depends on the size of the image.
• Range: 0.0 - 250.0
• Low values sharpen edge pixels only.
• High values sharpen a wider band of pixels.

threshold xsd:int
Determines how different pixels must be from the
surrounding area before they are considered edge
pixels and can be sharpened.
• Range: 0 - 255 (integers only).
• Default: 6

monochrome xsd:int
Values include 0 or 1 only.
Data types 282

Name Type Description

Set to 0 to apply to each color component separately

or to 1 to apply to image brightness (intensity) only.
The layer mask or composite mask is sharpened as
well .

monochrome is ignored for grayscale images.

Example
<element name="unsharpMaskOptions" type="types:UnsharpMaskOptions" minOccurs="0"/>
<complexType name="UnsharpMaskOptions">
<sequence>
<element name="amount" type="xsd:double" minOccurs="0"/>
<element name="radius" type="xsd:double" minOccurs="0"/>
<element name="threshold" type="xsd:int" minOccurs="0"/>
<element name="monochrome" type="xsd:int" minOccurs="0"/>
</sequence>
</complexType>

Used by
The unsharpMaskOptions type is used by:
• ReprocessAssetsJob
• UploadDirectoryJob
• UploadPostJob
• UploadUrlsJob

UploadDirectoryJob

Uploads files from specified server directories on a recurring basis.

Parameters

Name Type Description

autoColorOptions types:AutoColorOptions
Automatic image crop options (based on
color).

autoSetCreationOptions types:AutoSetCreateOptions
Array of automatic set generation scripts
to apply to uploaded files.

autoTransparentCropOptions types:AutoTransparentCropOptions
Removes white space from the edges of
images, based on transparency.

colorManagementOptions types:ColorManagementOptions
Options that you can specify during an
upload. The set affects how the color is
managed for the upload.
Data types 283

Name Type Description

createMask xsd:boolean
Whether to create a mask when uploading.

destFolder xsd:string
IPS folder for the files.

emailSetting xsd:string
Choice of email settings.

illustratorOptions types:IllustratorOptions
Options for uploading Illustrator files to
the image server.

includeSubfolders xsd:string
Whether to include subfolders when
uploading.

inDesignOptions types:InDesignOptions
Options for uploading InDesign files to
the server.

knockoutBackground types:KnockoutBackgroundOptions
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
Manual image crop options.

mediaOptions types:MediaOptions
Options that let you set a thumbnail image
from the video.

See MediaOptions.

overwrite xsd:string
File upload overwrite options.

pdfOptions types:PDFOptions
Options for uploading PDF files to the
image server.

photoshopOptions types:PhotoshopOptions
Options for uploading Photoshop files to
the image server.

postHttpUrl xsd:string
The URL of the file upload destination.

postImageRenderingPublish types:ImageRendingPublishJob
Details for an image rendering publish job
Job
that runs after the upload is complete.
Data types 284

Name Type Description

postImageServingPublishJob types:ImageServingPublishJob
Details for an image serving publish job
that runs after the upload is complete.

postJobOnlyIfFiles xsd:boolean
Whether to upload only files.

postScriptOptions types:PostScriptOptions
Options for uploading Post Script files to
the image server.

postVideoPublishJob types:VideoPublishJob
Details for a video publish job that runs
after the upload is complete.

preserveCrop xsd:boolean
Controls preservation of any existing crop
definition. Defaults to true.

preservePublishState xsd:boolean
Controls whether the publish state of an
existing asset is preserved when
overwriting. If not set, the company default
setting is used.

processMetadataFiles xsd:string
Whether to process separate metadata
XML files for this job.

projectHandleArray types:HandleArray
Array of project handles.

readyForPublish xsd:boolean
Determines if files are marked ready for
publishing.

serverDir xsd:string
Source upload directory.

unCompressOptions types:UnCompressOptions
Extract and process the contents of
uploaded TAR/ZIP files with these
optional settings.

See UnCompressOptions.

unsharpMaskOptions types:UnsharpMaskOptions
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 An additional metadata option for

everything in the upload job
Data types 285

Notes
For CropOptions, you can choose only one of the following:
• manualCropOptions
• autoColorCropOptions
• autoTransparentCropOptions
For PublishJob, you can choose only one of the following:
• postImageServingPublishJob
• postImageRenderingPublishJob
• postvideoPublishJob

UploadPostJob

Uses getActiveJobs to track desktop uploads.

See also Uploading assets by way of HTTP POSTs to the UploadFile Servlet.

Note: All POST requests for an upload job must originate from the same IP address.

Parameters

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.
Data types 286

Name Type Required? Description

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.

SeeKnockoutBackgroundOptions.

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.
Defaults is true.

preservePublishState xsd:boolean
Yes Controls whether the
publish state of an existing
Data types 287

Name Type Required? Description

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.

UploadUrl

For uploading assets via URL.

Parameters

Name Type Description

sourceUrl xsd:string The source URL the asset is uploaded
from.
destPath xsd:string The IPS file path and name of the file you
want to upload to.
Data types 288

UploadUrlArray

An array of URL for uploading assets.

Parameters

Name Type Description

items types:UploadUrl An array of URLs for uploading assets.

UploadUrlsJob

Uploads URLs from the location where you want to get files.

Parameters

Name Type Description

autoColorCropOptions types:AutoColorCropOptions Options for automatic crops of images
based on color.
autoSetCreationOptions types:AutoSetCreationOptions Array of automatic set generation scripts
to apply to uploaded files.
autoTransparentCropOptions types:AutoTransparentCropOptions Removes white space from the edges of
images, based on transparency.
createMask xsd:boolean Whether to create a mask.
colorManagementOptions types:ColorManagementOptions Options that you can specify during an
upload. The set affects how the color is
managed for the upload.
emailSetting xsd:string Choice of email settings.
IllustratorOptions types:IllustratorOptions Options for uploading Illustrator files to
the Image Server.
inDesignOptions types:InDesignOptions Options for uploading InDesign files to
the server.
knockoutBackground types:KnockoutBackgroundOptions Mask the background for selected images.
This lets you overlay them in other layers
with a transparency outside of subject
image. Optional.
SeeKnockoutBackgroundOptions.
manualCropOptions types:ManualCropOptions Options for manual crops of images.
mediaOptions types:MediaOptions Options that let you set a thumbnail image
from the video. See MediaOptions.
numUrls xsd:int Returns the number of URLs submitted in
a job. Used by getActiveJobs and
getScheduledJobs.
Data types 289

Name Type Description

overwrite xsd:boolean Whether to overwrite files when
uploading.
pdfOptions types:PDFOptions Options for uploading PDF files to the
Image Server.
photoshopOptions types:PhotoshopOptions Options for uploading Photoshop files to
the Image Server.
postHttpUrl xsd:string The URL where the files are being
uploaded.
postImageRenderingPublishJob types:ImageRendingPublishJob Details for an image rendering publish job
that runs after the upload is complete.
postImageServingPublishJob types:ImageServingPublishJob All media options.
postScriptOptions types:PostScriptOptions Options for uploading Post Script files to
the Image Server.
postVideoPublishJob types:VideoPublishJob Details for a video publish job that runs
after the upload is complete.
preserveCrop xsd:boolean Controls preservation of any existing crop
definition. Defaults to true
preservePublishState xsd:boolean 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 Array of project handles.
readyForPublish xsd:boolean Whether the files are marked ready for
publishing.
unCompressOptions types:UnCompressOptions Extract and process the contents of
uploaded TAR/ZIP files with these
optional settings. See UnCompressOptions.
unsharpMaskOptions types:UnsharpMaskOptions 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.
urlArray xsd:UrlArray An array of URLs that you want to upload.
xmpKeywords xsd:string
An additional metadata option for
everything in the upload job.

Notes
For CropOptions, you can choose only one of the following:
• manualCropOptions
• autoColorCropOptions
• autoTransparentCropOptions
Data types 290

For PublishJob, you can choose only one of the following:

• postImageServingPublishJob
• postImageRenderingPublishJob
• postvideoPublishJob

UrlArray

An array of URLS for invalidating CDN cache.

Supported Since

4.5.0, patch 2011-02

Parameters

Name Type Description

items xsd:string The list of URLs to invalidate. Limited to

maximum of 1000 URLs by the WSDL
definition.

User

A user of resources and types in the system.

Parameters

Name Type Description

userHandle xsd:string User handle.
firstName xsd:string User first name.
lastName xsd:string User last name.
email xsd:string email address.
defaultRole xsd:string Sets the role for a user in each company
they belong to. However, the user role
IpsAmin overrides other user roles.

isValid xsd:boolean Determines if the user is valid.

passwordExpires xsd:dateTime Sets password expiration date.

UserArray

An array of users.
Data types 291

Parameters

Name Type Description

items types:User An array of users.

VideoCaptionInfo

Video caption properties

Parameters

Name Type Description

originalPath xsd:string Relative path to the uploaded video.

originalFile xsd:string Name of the original video.

fileSize xsd:int File size.

VideoInfo

Video asset properties.

Parameters

Name Type Description

originalPath xsd:string Relative path to the uploaded video.
originalFile xsd:string Name of the original video file.
fileSize xsd:int File size.
imagePath xsd:string Relative path to the video file.
imageFile xsd:string File name of the video file.
optimizedPath xsd:string Path to the IPS optimized video file.
optimizedFile xsd:string File name of the IPS optimized video file.

VideoPublishJob

Publishes files to the configured video publish servers.

Parameters

Name Type Description

emailSetting xsd:string Choice of email settings.
Data types 292

Name Type Description

httpCompletionUrl xsd:string URL to send a completion notice.
contextHandle xsd:string Handle to the publish context.

ViewerPresetInfo

Properties of a viewer preset asset.

Parameters

Name Type Description

type xsd:string Choice of viewer type.
configSettingArray types:ConfigSettingArray Viewer configuration settings array.

ViewerSwfInfo

Properties of a viewer SWF file asset.

Parameters

Name Type Description

originalPath xsd:string Relative path to the originally uploaded
viewer SWF file.
originalFile xsd:string File name of the original viewer SWF file.
fileSize xsd:int File size.

VignetteInfo

Properties of a vignette asset.

Parameters

Name Type Description

originalPath xsd:string Path to the file.
originalFile xsd:string File name.
fileSize xsd:int File size.
imagePath xsd:string Path to the image.
imageFile xsd:string

optimizedPath xsd:string Optimized path to the file.

optimizedFile xsd:string Optimized file name.
Data types 293

WatermarkInfo

Properties of a watermark asset.

Parameters

Name Type Description

url xsd:string Image server URL that represents the
template.
urlModifier xsd:string

urlPostApplyModifier xsd:string

WindowCoveringInfo

Properties of a window covering file.

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:string File name.
fileSize xsd:int File size.
imagePath xsd:string Relative path to the image.
imageFile xsd:string File name of the window covering image.
optimizedPath xsd:string Optimized path to the file.
optimizedFile xsd:string Optimized file name.

WordInfo

Properties of a Word file.

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:string File name.
fileSize xsd:int File size.
Data types 294

XmlInfo

Properties of an XML file asset.

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:string File name.
fileSize xsd:int File size.

XmpKeywords

The extensible metadata platform keywords of an asset.

Parameters

Name Type Description

items xsd:string
A comma-separated list of keywords that
get merged into the dc:subject= XMP
property node. If a comma appears in any
of the individual values, it needs to be
escaped by a backslash (\) character. A
literal backslash is the usual
double-backslash (\\).

XslInfo

Properties of an XML transformation file asset.

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:string File name.
fileSize xsd:int File size.

ZipEntry

An entry in a ZIP file.

Data types 295

Parameters

Name Type Description

name xsd:string Entry name.
isDirectory xsd:boolean Determines if the entry is a directory.
lastModified xsd:dateTime Date and time of last modification.
compressedSize xsd:long Compressed size.
uncompressedSize xsd:long Uncompressed size.

ZipEntryArray

An array of ZIP entries.

Parameters

Name Type Description

items types:ZipEntry An array of ZIP entries.

ZipInfo

Properties of a ZIP archive asset.

Parameters

Name Type Description

originalPath xsd:string File path.
originalFile xsd:string File name.
fileSize xsd:int File size.

ZoomTarget

Properties of a Zoom target.

Parameters

Name Type Description

zoomTargetHandle xsd:string Zoom target handle.
name xsd:string Zoom target name.
xPosition xsd:int The X position of the zoom target.
yPosition xsd:int The Y position of the zoom target.
width xsd:int Zoom target width.
Data types 296

Name Type Description

height xsd:int Zoom target height.
userData xsd:string User data associated with the Zoom
target.
position xsd:int Allows Zoom targets associated with an
asset to be ordered based on position
lastModified xsd:dateTime Date of last modification.

ZoomTargetArray

An array of Zoom targets.

Parameters

Name Type Description

items types:ZoomTarget Array of Zoom targets.

ZoomTargetDefinition

Zoom target definition.

Parameters

Name Type Description

name xsd:string Target name.
xPosition xsd:int The X position of the zoom target.
yPosition xsd:int The Y position of the zoom target.
width xsd:int Zoom target width.
height xsd:int Zoom target height.
userData xsd:string Associated user data.

ZoomTargetDefinitionArray

Parameters

Name Type Description

items types:ZoomTargetDefinition An array of Zoom target definitions.
String constants 297

String constants

Active Job States

Used by ActiveJobs/state.

Values
• Unknown
• New
• WaitingClient
• WaitingCoordinator
• Running
• Stopping
• Done

Asset Search System Fields

Used by SystemFieldCondition/field.

Values
• Name
• Keywords
• Description
• Comments
• UserData
• Sku
• FileSize
• CreatedWith
• Created
• CreateUser
• LastModifyUser
• FileName

Asset Overwrite Modes

Used by setCompanySettingsParam/overwriteMode.

Values
• OverwriteFullName
• OverwriteAnyExt
• OverwriteFullNameAnyFolder
• OverwriteAnyExtAnyFolder
String constants 298

Asset Sort Fields

Used by searchAssetsParam/sortBy.

Values
• Created
• Modified
• Name
• AssetType
• FileSize

Asset Types

Describes values used by various input parameters. See the list in this article for details.

Used By
• Input(searchAssetsParam)/assetTypeArray
• Asset/type
• Input(createImageSetParam)
• Input(getFoldersParam)/assetTypeArray
• getFolderTreeParam/assetTypeArray
• Input(getMetadataFieldsParam)
• Input(saveMetadataFieldParam)/assetType
• Input(createImageSetParam)/type

Values
• Aco
• AdjustedView
• AnimatedGif
• Asset
• AssetSet
• Audio
• Cabinet
• Catalog
• ColorSwatch
• CuePoint
• Excel
• Flash
• Font
• IccProfile
• Illustrator
• Image
• ImageMap
• ImageSet
• InDesign
• LayerView
String constants 299

• Mask
• MasterVideo
• Pdf
• PDFSettings
• PostScript
• PowerPoint
• PremierExpressRemix
• PsdTemplate
• RenderScene
• RenderSet
• SpinSet
• Svg
• Template
• Video
• VideoCaption
• ViewerPreset
• ViewerSwf
• Vignette
• Watermark
• WindowsCovering
• Word
• Xml
• Xsl
• Zip Rtf
• ZoomTarget

AutoCrop Corner

Used by AutoCropColorOptions/corner.

Values
• BottomLeft
• BottomRight
• UpperLeft
• UpperRight

Color Management Modes

Used by ColorManagementOptions/colorManagement.

Values
• Default
• MaintainOriginal
• Convert
String constants 300

Color Spaces

Used by IccProfileFieldUpdate/colorSpace and IccProfileFieldUpdate/pcsType.

Values
• XYZ
• Lab
• Luv
• YCbCr
• Yxy
• RGB
• GRAY
• HSV
• HLS
• CMYK
• 2CLR
• 3CLR
• 4CLR
• 5CLR
• 6CLR
• 7CLR
• 8CLR
• 9CLR
• ACLR
• BCLR
• CCLR
• DCLR
• ECLR
• FCLR

Email Settings

Describes values used by various input parameters. See the list in this article for details.

Used By
• ImageServingPublishJob/emailSetting
• ImageRenderingPublishJob/emailSetting
• VideoPublishJob/emailSetting
• ServerDirectoryPublishJob/emailSetting
• UploadDirectoryJob/emailSetting
• UploadUrlJob/emailSetting

Values
• All
• Error
• ErrorAndWarning
String constants 301

• JobCompletion
• None

Font Styles

Used by FontFieldUpdate/style.

Values
• Bold
• Italic
• BoldItalic

Font Types

Used by FontFieldUpdate/type.

Values
• TTF
• OTF
• AFM
• PFM
• PFB
• TTC
• KERN

Generation Info

Used by getGenerationInfo/engine.

Values
• PhotoshopLayers
• PostScriptRip
• ImageConvert
• SceneAuthoring
• Aco

Illustrator Processes

Used by Illustrator/processes.

Values
• None
• Rasterize
String constants 302

Job Log File Types

Used by JobLogDetial/assetType.

Values
• NoType
• PublishCatalog
• OptimizedImage
• MasterImage
• SealedImage
• Mask
• Vignette
• Thumbnail
• ImageMap
• IccProfile
• Font
• Xsl
• Cabinet
• WindowCovering
• Video
• ViewerSwf
• Icon
• Video
• ViewerSwf
• Icon
• VideoEncodingXml
• ViewerConfigXml
• Template
• Catalog
• Xml
• ImageSet
• RenderSet
• SpinSet
• Svg
• Watermark
• Pdf
• Aco
• PsdTemplate
• Zip

Job Log Sort Fields

Used by getJobLogsParam/sortBy

Values
• JobName
String constants 303

• LogType
• StartDate
• CompanyName
• UserId
• Email
• FileErrorCount
• FileWarningCount
• FileSuccessCount

Job Log Types

Used by JobLogDetail/logType and JobLog/logType.

Values
• BeginImageServingPublish
• EndImageServingPublish
• ImageServingPublishSuccess
• ImageServingPublishError
• ImageServingPublishWarning
• BeginUpload
• EndUpload
• UploadError
• UploadSuccess
• UploadWarning
• BeginAssetMigration
• EndAssetMigration
• EndAssetMigration
• AssetMigrationFailure
• AssetMigrationSuccess
• BeginDelete
• EndDelete
• BeginEmptyTrash
• EndEmptyTrash
• EmptyTrashSuccess
• BeginGet
• EndGet
• GetFailure
• ReturnSuccess
• BeginImageRenderingPublish
• EndImageRenderingPublish
• ImageRenderingPublishError
• ImageRenderingPublishSuccess
• BeginImageRenderingPublishCleanup
• EndImageRenderingPublishCleanupFailure
• ImageRenderingPublishCleanupsuccess
• BeginMarkForPublish
• EndMarkForPublish
• MarkForPublishFailure
String constants 304

• MarkForPublishSuccess
• BeginMetadata
• EndMetadata
• MetadataFailure
• MetadataSuccess
• BeginPdfRip
• PdfRipError
• BeginImageServingPublishCleanup
• EndImageServingPublishCleanup
• ImageServingPublishCleanupFailure
• ImageServingPublishCleanupSuccess
• BeginPublishToCm
• EndPublishToCm
• PublishToCmError
• PublishToCmSuccess
• BeginServerDirectoryPublish
• EndServerDirectoryPublish
• ServerDirectoryPublishError
• ServerDirectoryPublishSuccess
• ServerDirectoryPublishWarning
• BeginPublishToWc
• PublishToWcSuccess
• BeginReoptimize
• endReoptimize
• ReoptimizeSuccess
• ReoptimizeFailure
• BeginRestoreTrash
• EndRestoreTrash
• RestoreTrashSuccess
• BeginTemplateMerge
• EndTemplateMerge
• TemplateMergeError
• TemplateMergeSuccess
• BeginTrash
• EndTrash
• TrashFailure
• TrashSuccess
• TrashWarning
• BeginUnmarkForPublish
• EndUnmarkForPublish
• UnmarkForPublishSuccess
• BeginUploadUrls
• EndUploadUrls
• BeginVideoPublish
• EndVideoPublish
• VideoPublishError
• VideoPubilshSuccess
• VideoPublishWarning
String constants 305

• BeginVideoPublishCleanup
• EndVideoPublishCleanup
• VideoPublishCleanupFailure
• VideoPublishCleanupSuccess
• DeleteFailure
• DeleteSuccess
• DuplicateSkipped
• FatalError
• FileBegin
• FileCancel
• FleEnd
• FileProgress
• FileUpdated
• InitiatingJobName
• JobClient
• JobType
• OriginalJobName
• TotalFileCount
• RecoverTrashSuccess

Job Trigger States

Used by ScheduledJob/triggerState.

Values
• Blocked
• Complete
• Error
• None
• Normal
• Paused
• UrlUpload
• MetadataUpload
• ImageOptimization
• Cleanup

Job Types

Used by ActiveJob/type and ScheduledJob/type.

Values
• ImageServingPublish
• ImageRenderingPublish
• ServerDirectoryPublish
• ServerDirectoryPublishWithTemplate
• VideoPublish
• UploadFromServerDirectory
String constants 306

• UrlUpload
• MetadataUpload
• ImageOptimization
• Cleanup

Metadata Field Types

Used by MetadataField/type, saveMetadataFieldParam/fieldType, and createMetadataField/fieldType.

Values
• Untyped
• Boolean
• BooleanTag: A special case of SingleFixedTag with a non-modifiable dictionary initialized to the values True and False.
• Color
• Date
• Dimension
• FileName
• Float
• Int
• MultiFixedTag: Zero or more string values from a closed dictionary. Only admin users can modify the dictionary.
• MultiTag: Zero or more string values.
• SingleFixedTag: A single string value from a closed dictionary. If setAssetMetadata or batchSetAssetMetadata are
called with a value not in the dictionary, a fault will be returned. Only admin users can modify the dictionary.
• SingleTag: Any single string value.
• String

Numeric/Date Comparison Operators

Used by SystemFieldCondition/op.

Values
• Equals
• NotEquals
• LessThan
• LessThanEquals
• GreaterThan
• GreaterThanEquals

PDF Processes

Used by PDFOptions/type.

Values
• None
• Rasterize
• Thumbnail
String constants 307

Permission Types

Used by PermissionsUpdate/permissionType, Permission/permissionType.

Values
• Read
• Write
• Delete

Photoshop Anchor Modes

used by PhotoshopOptions/anchor.

Values
• Center
• North
• Northwest
• West
• Southwest
• South
• Southeast
• East
• Northeast

Photoshop Layer Naming Modes

Used by PhotoshopOptions/layerNaming.

Values
• LayerName
• AppendNumber
• AppendName
• Folders

PostScript Colorspace Modes

Used by PostScriptOptions/colorspace.

Values
• Auto
• Rgb
• Cmyk
• Gray
String constants 308

Profile Classes

Used by IccProfileFieldUpdate/class.

Values
• Input
• Display
• Output
• DeviceLink
• ColorSpaceConversion
• Abstract
• NamedColor

Publish State

Used by searchAssetsParam/publishState, setAssetPublishStateParam/publishState and

ContextStateUpdate/publishState.

Values
• MarkedForPublish
• NotMarkedForPublish

Property Set Types

Used by PropertySetType

Values
• UserProperty
• CompanyProperty
• UserCompanyProperty

Publish Context

Used by getActivePublishContextsReturn/publishContext.

Values
• ImageServing
• ImageRendering
• Video
• ServerDirectory

Publish Types

Used by ImageServingPublishJob/publishType.
String constants 309

Values
• Full
• FullWithSearch
• Incremental

Region Shape

Used by ImageMap/shapeType and saveImageMapParam/shapType.

Values
• Rectangle
• Polygon

Search Match Modes

Used by searchAssetsParam/conditionMatchMode, searchAssetsParam/systemFieldMatchMode, and

searchAssetsParam/metadataMatchMode.

Values
• MatchAll
• MatchAny

Sort Directions

Used by searchAssetsParam/sortDirection and getJobLogsParam/sortDirection.

Values
• Ascending
• Descending

String Comparison Operators

Used by SystemFieldCondition/op and MetadataCondition/op.

Values
• Equals
• NotEquals
• Contains
• NotContains
• StartsWith
• EndsWith
String constants 310

Trash State

Used by searchAssetReturn/trashState.

Values
• NotInTrash
• InTrash
• InEmptiedTrash

User Char Filter Fields

Used by getUsersParam and getUserCharsParam/charField.

Values
• None
• FirstName
• LastName
• Email
• StartsWith
• EndsWith

User Roles

Describes values used by various parameters. See the list in this article for details

Used By
• User/role
• addUserParam/role
• setUserInfoParam/role
• getUsersParam/userRoleArray
• getUsersCharParam/userRoleArray

Values
• IpsAdmin
• IpsCompanyAdmin
• IpsUser
• WebServiceUser
• TrialSiteAdmin
• TrialSiteUser
• ImagePortalAdmin
• ImagePortalUser
• ImagePortalContrib
• ImagePortalContribUser
String constants 311

User Sort Fields

Used by getUsersParam/sortBy.

Values
• None
• FirstName
• LastName
• Email
• Role
• Valid
• PasswordExpiration

Viewer Type

Used by ViewerPresetInfo.

Values
• VideoPlayer
• Brochure
• BasicZoom
• AdvancedZoom
• Spin
• All custom types
Faults 312

Faults

authenticationFault

Thrown when a user cannot be authenticated.

Fault Types

ID Fault

10000 AUTHENTICATION_FAULT_CODE_NO_CREDENTIALS

10001 AUTHENTICATION_FAULT_CODE_INVALID_CREDENTIALS

10002 AUTHENTICATION_FAULT_CODE_INVALID_USER

Fault Fields

Name Type Description

code xsd:int Fault ID
reason xsd:string An informative message describing the
fault.

authorizationFault

Thrown when an authenticated user has insufficient permissions to accomplish a task.

Fault Types

ID Fault

20000 AUTHORIZATION_FAULT_CODE_INVALID_COMPANY

20001 AUTHORIZATION_FAULT_CODE_INVALID_REQUEST_USERNAME

20002 AUTHORIZATION_FAULT_CODE_INVALID_REQUEST_USER

20003 AUTHORIZATION_FAULT_CODE_NO_OPERATION_PERMISSION

20004 AUTHORIZATION_FAULT_CODE_NO_IMPERSONATION_PERMISSION

20005 AUTHORIZATION_FAULT_CODE_ILLEGAL_PARAMETER_VALUE

20006 AUTHORIZATION_FAULT_CODE_ILLEGAL_COMPANY

20007 AUTHORIZATION_FAULT_CODE_ILLEGAL_REQUEST_USER

20008 AUTHORIZATION_FAULT_CODE_ILLEGAL_ACCESS_GROUP

20009 AUTHORIZATION_FAULT_CODE_MISSING_PERMISSION
Faults 313

Fault Fields

Name Type Description

code xsd:int Fault ID

reason xsd:string An informative message describing the

fault.

ipsApiFault

Fault Types

ID Fault

30000 IPS_API_FAULT_CODE_EXCEPTION

30001 IPS_API_FAULT_CODE_INVALID_PARAMETER

30002 IPS_API_FAULT_CODE_MISSING_PARAMETER

30003 IPS_API_FAULT_CODE_INVALID_REQUEST_XML

Fault Fields

Name Type Description

code xsd:int Fault ID

reason xsd:string An informative message describing the fault.

Change log 314

Change log

Version 6.0

Operations: New and Modified

Describes new and changed operations methods for the IPS API version 6.

New Operations
• batchGetAssetPublishContexts
• getPublishContexts
• moveFolder
• setAssetsContexState
• updateAssetSet
• updateImageSet

Modified Operations
Added
• Added isHidden and initialTagValue to:
• saveMetadataField
• updateMetadataField
• createMetadataField
• Added thumbAssetHandle to:
• createImageSet
• createAssetSet
Added companyHandle to:
• getViewerConfigSettings
• setViewerConfigSettings
• updateViewerConfigSettings
• getSearchStrings
Added contextHandle to:
• getImageServingPublishSettings
• getImageRenderingPublishSettings
• setImageServingPublishSettings
• setImageRenderingPublishSettings
• Added includeInactive to:
• getUsers.
• getUserChars.
• Added permissionArray to createPropertySet.
• Added exportJob to submitJob.
Changed
Change log 315

• In addUser and setUser, changed role to defaultRole.

• In getCompanyMembers, changed userArray to memberArray.
• In getCompanyMembership, changed companyArray to membershipArray.
• In addUser, setCompanyMembership, and addCompanyMembership, changed membershipArray to
companyHandleArray.
• In getCompanyMembership, changed companyArray to membershipArray.
• In getUserChars, includeInvalid is now optional.

Removed
• Removed renameFiles from renameAsset.
• Removed getXMPPanelViewDefinition.
• Removed searchAssetsByFulltext and searchAssetsBySimilarity.

Data Types: New and Modified

Describes new and changed types for the IPS API version 6.

New Types
• AssetContextStateUpdate
• AssetContextStateUpdateArray
• AssetPublishContexts
• AssetPublishContextsArray
• CompanyMember
• CompanyMemberArray
• CompanyMembershipUpdate
• CompanyMembershipUpdateArray
• ContextStateUpdate
• ContextStateUpdateArray
• Export Job
• PermissionsSet
• PermissionsSetArray
• PublishContext
• PublishContextArray

Modified Types
Added
• Added numUrls to UploadUrlsJob.
• Added fileName to Asset.
• Added isHidden to MetadataField.
• Added taskState to TaskProgress.
• Added exportJob to ActiveJob and ScheduledJob.
• Added optmizedPath and optimizedFile to PsdInfo.
• Added contextHandle to:
• ImageRenderingPublishJob
• VideoPublishJob

• Added the following parameters to Asset:

Change log 316

• animatedGifInfo
• swcInfo
• cssInfo
• javascriptInfo

Changed
• In User, changed role to defaultRole.
• In Folder, changed permissions to permissionsSetHandle.
• In AssetSummary, type and name are now optional.

Version 4.5

Operations: New and Modified

Describes new and changed operations methods for the IPS API version 4.5.

New Operations
• addMediaPortalEvent
• addTagFieldValues
• cdnCacheInvalidation
• deleteTagFieldValues
• deleteTagFieldValues
• getDistinctMetadataValues
• getMediaPortalEvent
• getTagFieldValues
• getXMPPacket
• searchAssetsByFullText
• searchAssetsByMetadata
• setTagFieldValues
• updateTagFieldValues
• updateXMPPacket

Modified Operations
• Asset includes animatedGifInfo, swcInfo, cssInfo, and javascriptInfo parameters.
• createMetadataField includes an optional isHidden parameter.
• saveMetadataField includes an optional isHidden parameter.
• searchAssets
•
• The renameFiles parameter has been deprecated for prior releases and removed from the renameAsset operation. The
virtual file path is changed to match the new asset name (preserving the file extension), while physical file paths are not affected.
API clients need to remove references to this parameter when updating to the new API version.

Data Types: New and Modified

Describes new and changed data types for the IPS API version 4.5.
Change log 317

New Types
• AssetSummary
• AssetSummaryArray
• JobLogDetailAux
• JobLogDetailAuxArray
• MPEvent
• MPEventArray
• OperationFault
• OperationFaultArray
• PhotoshopOptions
• TagCondition
• TagConditionArray
• TagFieldValues
• TagFieldValuesArray
• TagValueUpdate
• TagValueUpdateArray
• TagValueUpdateFault
• TagValueUpdateFaultArray
• UrlArray

Modified Types
• Asset includes a new fileName field that returns the virtual file name.
• AssetSummary returns a type and name field
• MetadataField includes isHidden
• MetadataUpdate
• UploadUrlsJob requires a urlArray and adds an optional numUrls count

Restricted Use
These new or modified operations and data types available in the beta WSDL are not to be used outside of Scene7 developed
applications.
These operations and types are subject to disabling, change or deprecation with subsequent system updates.

New Types

• AssetPublishContexts
• AssetPublishContextsArray
• CompanyMetadataInfo
• CompanyMetadataInfoArray
• CreateVideoSitemapJob
• PublishContext
• PublishContextArray
• SearchFilter
• LongArray

New Operations

• applyMetadataTemplate
• batchGetAssetPublishContexts
Change log 318

• createCompanyMetadata
• deleteCompanyMetadata
• getCompanyMetadata
• getPublishContexts
• listCompanyMetadata
• removeMask
• removePropertySetPermissions
• searchAssetsBySimilarity
• searchAssetsByFulltext
• setAssetPublishState
• setPropertySetPermissions
• updateAssetSet
• updateCompanyMetadata
• updateImageSet
• updatePropertySetPermissions

Modified Types

• Changed ActiveJob to include a createVideoSitemapJob type

• Changed ScheduledJob to include a createVideoSitemapJob type
• Changed ImageServingPublishJob to include an optional contextHandle
• Changed ImageRenderingPublishJob to include an optional contextHandle
• Changed MetadataField to include an optional initialTagField
• Changed MetadataCondition to include and optional caseSensitive parameter
• Changed PropertySet to include an optional PermissionArray as permissions
• Changed UploadDirectoryJob to include optional xmpKeywords, xmpTemplateId and xmpTemplateOverride parameters
• Changed VideoPublishJob to include an optional contextHandle

Modified Operations

• Changed createAssetSet to include an optional thumbAssetHandle

• Changed createImageSet to include an optional thumbAssetHandle
• Changed createMetadataField to include an optional initialTagValue parameter
• Changed createPropertySet to include an optional PermissionUpdateArray as permissionArray
• Changed getImageServingPublishSettings to include an optional contextHandle parameter
• Changed getImageRenderingPublishSettings to include an optional contextHandle parameter
• Changed searchAssetsByFullText to include a series of optional parameters:

• SearchFilter as filters parameter

• sortBy
• sortDirection

• Changed searchAssetsByMetadata to include a series of optional parameters:

• SearchFilter as filters parameter

• sortBy
• sortDirection
Change log 319

• haystackSearch sequence of seven parameters

• Changed setAssetPublishState to include an optional HandleArray as contextHandleArray

• Changed setImageServingPublishSettings to include an optional contextHandle parameter
• Changed setImageRenderingPublishSettings to include an optional contextHandle parameter
• Changed submitJob to include an optional createVideoSitemap job type

Version 4.4

Operations: New and Modified

Describes new and changed operations methods for the IPS API version 4.4.

New Operations
• batchSetFontFields
• batchSetIccProfileFields
• createAssetSet
• getAssetMetadataFields
• getAssetSetDefinitions

Modified Operations
SearchAssets

Parameters added:
• assetSubtypeArray
• excludeByproductArray
• strictSubTypeCheck

Data Types: New and Modified

Describes new and changed data types for the IPS API version 4.4.

New Types
• AssetMetadataFields
• AssetMetadataFieldsArray
• AssetSetInfo
• AutoSetCreationOptions
• ExcludeByproductCondition
• ExcludeByproductArray
• FontFieldUpdate
• FontFieldUpdateArray
• IccProfileFieldUpdate
• IccProfileFieldUpdateArray
Change log 320

Modified Types
Asset

Parameters added:
• subtype
• assetSetInfo

JobLog

Parameters added:
• transferSuccessCount
• transferErrorCount
• transferWarningCount

PDFInfo

Parameters added:
• extractLinks

String Constants: New and Modified

Describes new and changed data types for the IPS API version 4.4.

New Constants
• AssetSet
• MasterVideo
• ColorSpaces
• FontStyles
• FontTypes
• ProfileClasses

Version 4.2

Data Types: New and Modified

Describes new and changed data types for the IPS API version 4.2.

New Types
• AudioInfo
• CuePointInfo
• PdfSettings
• PremeierExpressRemixInfo

Modified Types
Asset

Parameters added:
Change log 321

• readyForPublish
• trashState
• MaskInfo
• RTFInfo

Parameters removed:
• ImageSetInfo
• RenderSetInfo

ReprocessAssetsJob

Parameters added:
• preservePublishState
• preserveCrop
• readyForPublish

UploadDirectoryJob

Parameters added:
• preservePublishState
• preserveCrop
• videoEncodingPreset

UploadUrlsJob

Parameters added:
• preservePublishState
• preserveCrop

Version 4.0

New Additions and Changes

Describes new and implemented changes for the IPS API v4.0.
Implemented side-by-side API versions with separate WSDLs and schema namespaces.

• Previous API versions: IpsApi.wsdl, http://www.scene7.com/IpsApi/xsd.

• SPS 4.0 version: IpsApi-2008-01-15.wsdl, http://www.scene7.com/IpsApi/xsd/2008-01-15.

Added PostScriptOptions/alpha field.

Added VideoRootUrl and SwfRootUrl properties for getProperty operation.

Added optional appName and appVersion params to authHeader to track calling application. Added logging to
ipsApiService.log.

Added an optional serviceUrl param to the WSDL generation servlet. This is particularly useful for debug proxies. For
example: http://<server>/scene7/webservice/IpsApi-2008-01-15.wsdl?serviceUrl=http://localhost:8081

Implemented getZipEntries operation.

Change log 322

Implemented search ranges and typed comparison values for system field conditions.

Added 'Asset' asset type string constant, primarily to allow cross-asset metadata fields.

Implemented trashState param for searchAssets.

Implemented getAssetPublishHistory operation.

Added optional faultHttpStatusCode SOAP header to enable fault handling in Flex. For Flex, use
<faultHttpStatusCode>200</faultHttpStatusCode>. The default status code for fault responses is 500 (Internal
Server Error).

Added operations to restore assets from the trash and empty assets from the trash.

Implemented CRUD operations.

Added enabled flag to ImageMap type and saveImageMap operation.

Added support for Optimize Remaining Files jobs.

Added setAssetsPublishState for bulk publish state updates.

Added ImageServingPublishSettings, getImageServingPublishSettings, setImageServingPublishSettings.

Deprecated saveMetadataField operation in favor of new createMetadataField and updateMetadataField operations.

Implemented deleteAssetsParam batch delete operation.

Implemented moveAssetsParam batch move operation.

Implemented deleteMetadataField operation.

Implemented get/setImageRenderingPublishSettings, get/set/create/updateVignettePublishFormat

operations.

Implemented getAssetCounts.

Added support to setImageSetMembers for including RenderSet members in ImageSet assets.

Added replaceImage operation.

Added copyImage operation.

Added setUrlModifier operation and urlModifier/urlPostApplyModifier fields for LayerViewInfo, TemplateInfo,

and WatermarkInfo.

Added createDerivedAsset operation. Currently the ownerHandle must reference an Image asset and the type may be
AdjustedView or LayerView.

Added createTemplate operation. Currently this can be called to create Template or Watermark assets.

IPS company settings, CompanySettings, ported to Web services API.

Added excludeByproducts filter flag to searchAssets operation. Setting this flag to true runs PSDlayer images and PDF
ripped images.

Added getGenerationInfo operation.

Added SystemMessage property name to getProperty operation.

Modified some asset type string constants to match the corresponding Asset Info fields.

• WordDoc: Word
Change log 323

• ExcelDoc: Excel
• PowerPointDoc: PowerPoint
• RTFDoc: Rtf

Modified result format of batch operations to summarize success, warnings, and errors.

Implemented batchSetAssetMetadata batch metadata operation.

Implemented support for app-specific data.

Implemented support for boolean flags for createTemplate, extendLayers, and extractText for upload jobs to control
process of Photoshop processing (similar to changes for add file uploads).

Implemented setImageMaps and setZoomTargets operations.

Implemented ViewerPreset operations. The recognized types are:

• VideoPlayer (Video only publishes these viewers.)

• Brochure
• BasicZoom
• AdvancedZoom
• Spin
• Custom types

Viewer skins support two parameters: skinFg and skinBg. Backend code will do all the processing required to maintain
backward compatibility.

Implemented getAssociatedAssets operation.

Added ReprocessAssets job type to allow reprocessing of previously uploaded master files, including reripping PDFs and
reoptimizing images.

Renamed PropertySetType field type to propertyType. This affects the createPropertySetType parameter and
getPropertySetType/getPropertySetTypes response.

Implemented batchSetImageFields operation to support setting image user data and other editable image fields.

47 Added fileSize field to various asset info types:

• VignetteInfo
• CabinetInfo
• WindowCoveringInfo
• IccProfileInfo
• FontInfo
• XslInfo
• ViewerSwfInfo
• XmlInfo
• SvgInfo
• ZipInfo
• VideoInfo
Change log 324

• AcoInfo
• PdfInfo
• PsdInfo
• FlashInfo
• InDesignInfo
• PostScriptInfo
• IllustratorInfo
• WordInfo
• ExcelInfo
• PowerPointInfo
• IllustratorInfo
• WordInfo
• ExcelInfo
• PowerPointInfo
• RTFInfo

Implemented getActivePublishContexts operation. This operation returns an array of publish context names with active
publish servers for the specified company. Current publish context names are:

• ImageServing
• ImageRendering
• Video

Implemented getSearchStrings operation. It returns an array of search strings for the given asset.

Added locale parameters for jobs and a mechanism to set the locale for API operations. The locale string should be formatted
as <language_code>[-<country_code>]. The language code is a lowercase, two-letter code as specified by ISO-639, and
the optional country code is an uppercase, two-letter code as specified by ISO-3166.

Added optional locale parameter to the authHeader SOAP header to set the locale for API operations. If this parameter is not
present, the HTTP header Accept-Language will be used. If this header is also not present, the default locale for the IPS server
will be used.

Added get/set support for strongly typed metadata fields.

Implemented SOAP and HTTP header support for gzip response control.

Added gzipResponse flag to authHeader. If it is not present, the API will also check the HTTP Accept-Encoding header.

Added support to searchAssets for strongly typed metadata field conditions.

• For all field types, value may be passed with a string comparison operator (Equals, NotEquals, Contains, NotContains,
StartsWith, EndsWith)

• For Boolean fields, boolVal may be passed with the Equals op.
Change log 325

• For Int fields, longVal may be passed with a numeric comparison operator (Equals, NotEquals, LessThan,
LessThanEquals, GreaterThan, GreaterThanEquals) or minLong/maxLong may be passed with a numeric range
operations (Between, NotBetween).
• For Float fields, doubleVal may be passed with a numeric comparison operator (Equals, NotEquals, LessThan,
LessThanEquals, GreaterThan, GreaterThanEquals) or minDouble/maxDouble may be passed with a numeric
range operations (Between, NotBetween).
• For Date fields, you can pass dateVal with a numeric comparison operator (Equals, NotEquals, LessThan,
LessThanEquals, GreaterThan, GreaterThanEquals) or you can pass minDate/maxDate with a numeric range
operations (Between, NotBetween).

Added description, jobSubType, and originalJobName fields to JobLog type.

• originalJobName is the job name submitted to submitJob (without any uniqueness suffixes or follow-on job names).
• jobSubType is currently only used by ImageServingPublishJob jobs (where it is one of full, increment,
fullwithsearch, or fulloverride).

• description is currently an empty string for all job types, but will eventually contain summary job information, such as the
upload path.

In addition, the following fields are not included with both getJobLogs and getJobLogDetails. In prior versions they were
only available with getJobLogDetails.

• endDate (if the job has completed).

• fileDuplicateCount (previously it was always 0 with getJobLogs)
• fileUpdateCount (previously was always 0 with getJobLogs and included in fileSuccessCount; it is now split out into
separate fields).

Added assetHandle field to JobLogDetail type.

Added optional description parameter to submitJob. This is passed through for retrieval in getScheduledJobs,
getActiveJobs, and getJobLogs.

Deprecated the SKU system field. The field is ignored if it is passed in as a SystemFieldCondition to searchAssets.

Added excludeAssetTypeArray filter to searchAssets.

Added MaskInfo type to Asset.

Added new Asset Types for management by IPS:

Asset type Description

Illustrator Adobe Illustrator file.

PostScript EPS and PostScript files.

WordDoc Microsoft Word document for files ending with .doc.

ExcelDoc Microsoft Excel document for files ending with .xls.

Change log 326

Asset type Description

PowerPointDoc Microsoft PowerPoint document for files ending with .ppt.

RTFDoc RTF file for files uploaded ending with .rtf.

Added additional options to UploadDirectoryJob and UploadUrlsJob to control processing of Postscript, Illustrator, and
PDF files independently. All existing jobs will provide the necessary parameters to the each of the 3 processing pipelines so that
they will function exactly as done today. The original PostScriptOptions block is used to set the processing for Illustrator
and EPS/PS files. Optionally, specific file options blocks can be supplied to specify processing. The list of changes includes:

Field Parameter Value Description

PostScriptOptions process • None • Only manage the asset and

• Rasterize(default) do not create any derivatives
upon upload.
• Render the EPS and
PostScript file into an image
at the prescribed resolution
and color space.

alpha <boolean> Takes effect when rasterizing

the file into an image. It will
Optional.
create a transparent back-
ground if the original file is
defined in this way for
overlaying logos.

IllustratorOptions process • None • Only manage the asset and

• Rasterize (default) do not create any derivatives
upon upload.
• Render the file into an image
at the prescribed resolution
and color space.

resolution <integer> Rasterizing resolution.

colorspace Target color space for

rendering.

alpha Takes affect when rasterizing

the file into an image. Creates
Optional.
a transparent background if
Change log 327

Field Parameter Value Description

the original file is defined in

this way for creating overlaying
logos.

PDFOptions process • None • Only manage the asset and

• Rasterize (default) do not create any derivatives
upon upload.
• Render the file into an image
at the prescribed resolution
and color space.

resolution <integer> Rasterizing resolution.

colorspace Target color space for

rendering.

pdfCatalog <boolean> Defines whether to combine a

multiple page PDF into an
eCatalog after rendering
(default is true).

extractSearchWords <boolean> Defines whether words from

the PDF are extracted into the
DB for later supplying to a
search server (default is false).

You can also query from getScheduledJobs.

Modified the webservice.gzip.response configuration property to take one of the following values:

Value Description

never Do not gzip response.

soap Gzip response only if authHeader/gzipResponse is true.

accept Gzip if authHeader/gzipResponse is true, or no gzipResponse

header is present and HTTP Accept-Encoding header includes
gzip. (Default).

always Always gzip response, regardless of header values. Use this

value only for debugging purposes.
Change log 328

Version 3.8

Operations: New and Modified

Describes new and changed operations methods for the IPS API version 3.8.

New Operations
• setAssetPublishState
• saveZoomTarget
• deleteZoomTarget
• saveImageMap
• deleteImageMap
• createImageSet
• getImageSetMembers

Modified Operations
searchAssets
• The optional publishState parameter lets you search on the MarkedForPublish/NotMarkedForPublish asset state.

getJobLogs
• The optional userHandle parameter lets you retrieve job logs submitted by a specific user.

Data Types: New and Modified

Describes new and changed data types for the IPS API version 3.8.

New Types
• ImageSetMember
• ImageSetMemberArray
• ImageSetMemberUpdate
• ImageSetMemberUpdateArray

Modified Types
ZoomTarget

Fields added:
• name
• userData

String Constants: New and Modified

Describes new and changed string constants for the IPS API version 3.8.
Change log 329

New Constants
Region Shape
• Used by:ImageMap/shapeType, saveImageMapParam/shapeType
• Values: Rectangle and Polygon.

Publish State
• Used by: searchAssetsParam/publishState and setAssetPublishStateParam/publishState.
• Values: MarkedForPublish and NotMarkedForPublish.

Modified Constants
Asset Types
• Used by: createImageSetParam/type.
• Values: InDesign and Flash.

Version 3.7

Operations: New and Modified

Describes new and changed operations methods for the IPS API version 3.7.

New Operations
• moveAsset
• renameAsset
• deleteAsset
• createFolder
• deleteFolder
• getActiveJobs
• getScheduledJobs
• getJobLogs
• getJbLogDetails
• submitJob
• stopJob
• pauseJob
• resumeJob
• executeJob
• deleteJob

Modified Operations
searchAsset
Change log 330

• Removed name parameter.

• Added excludeFieldArray.

getFolders

• Added excludeFieldArray.

getFolderTree

• Added excludeFieldArray and getUniqueMetadataValues.

• Made fieldHandle a required parameter.

Data Types: New and Modified

Describes new and changed data types for the IPS API version 3.7.

New Types
• ZipInfo
• MetadataUpdate
• MetadataUpdateArray
• ActiveJob
• ActiveJobArray
• ScheduledJob
• ScheduledJobArray

Modified Types
Asset
• Added ZipInfo.

String Constants: New and Modified

Describes new and changed string constants for the IPS API version 3.7.

New Constants
• Job Types
• Active Job States
• Publish Types
• Job Trigger States
• Color Management Modes
• AutoCrop Corner
• Photoshop Layer Naming Modes
• Photoshop Anchor Modes
• PostScript Colorspace Modes
• Job Log Types
• Job Log File Types
• Job Log Sort Fields
• Email settings
Change log 331

Modified Constants
Asset Types
• Added Zip.
Uploading assets by way of HTTP POSTs to the 332
UploadFile Servlet

Uploading assets by way of HTTP POSTs to the UploadFile

Servlet
Uploading assets into Scene7 Production System involves one or more HTTP POST requests that set up a job to coordinate all
the log activity associated with the uploaded files.
Use the following URL to access the UploadFile Servlet:
https://<server>/scene7/UploadFile

Note: All POST requests for an upload job must originate from the same IP address.

Access URLs for Scene7 regions

Geographic location Production URL Staging URL (use for pre-production

development and testing)

North America https://s7sps1ssl.scene7.com/scene7/UploadFile https://s7sps1ssl-staging.scene7.com/scene7/UploadFile

Europe, Middle East, Asia https://s7sps3ssl.scene7.com/scene7/UploadFile https://s7sps3ssl-staging.scene7.com/scene7/UploadFile

Japan/Asia Pacific https://s7sps5ssl.scene7.com/scene7/UploadFile https://s7sps5ssl-staging.scene7.com/scene7/UploadFile

Workflow of the upload job

The upload job consists of one or more HTTP POSTs that use a common jobHandle to correlate processing into the same job.
Each request is multipart/form-data encoded and consists of the following form parts:

Note: All POST requests for an upload job must originate from the same IP address.

HTTP POST form Description

parts

auth Required.
An XML authHeader document specifying authentication and client information.

See Request authentication under SOAP.

uploadParams Required.

An XML uploadPostParams document specifying the upload parameters.

uploadPostParams element Type Description

name

companyHandle xsd:string Required.

Uploading assets by way of HTTP POSTs to the 333
UploadFile Servlet

HTTP POST form Description

parts

uploadPostParams element Type Description

name

Handle to the company to which the file

is being uploaded.

jobName xsd:string Either jobName or jobHandle is

required.

Name of the upload job.

jobHandle xsd:string Either jobName or jobHandle is

required.

Handle to an upload job started in a

previous request.

locale xsd:string Optional.

Language and country code for

localization.

description xsd:string Optional.

Description of job.

destFolder xsd:string Optional.

Target folder path to prefix to filename

property, particularly for browsers and
other clients that may not support full
paths in filename.

fileName xsd:string Optional.

Name of the target file. Overrides the

filename property.

endJob xsd:boolean Optional.

Default is false.

True if this is the last request for the job.

uploadParams types:UploadPostJob Optional if this is a subsequent request

for an existing active job. If there is an
Uploading assets by way of HTTP POSTs to the 334
UploadFile Servlet

HTTP POST form Description

parts

uploadPostParams element Type Description

name

existing job, uploadParams is ignored

and the existing job upload parameters
are used.

See UploadPostJob.

file params Optional.

You can include one or more files to upload with each POST request. Each file part can include a
filename parameter in the Content-Disposition header that is used as the target filename in IPS if no
uploadPostParams/fileName parameter is specified.

Within the <uploadPostParams> block is the <uploadParams> block that designates the processing of the included files.

See UploadPostJob.

While you might assume that the uploadParams parameter can change for individual files as a part of the same job, that is not
the case. Use the same uploadParams parameters for the entire job.

The initial POST request for a new upload job should specify the jobName parameter, preferably using a unique job name to
simplify subsequent job status polling and job log queries. Additional POST requests for the same upload job should specify the
jobHandle parameter instead of jobName, using the jobHandle value returned from the initial request.

The final POST request for an upload job should set the endJob parameter to true so that no future files will be POSTed for
this job. In turn, this allows the job to complete immediately after all POSTed files are ingested. Otherwise, the job times out if
no additional POST requests are received within 30 minutes.

UploadPOST response
For a successful POST request, the response body will be an XML uploadPostReturn document, as the XSD specifies in the
following:
<element name="uploadPostReturn">
<complexType>
<sequence>
<element name="jobHandle" type="xsd:string"/>
</sequence>
</complexType>
</element>

The jobHandle returned is passed in the uploadPostParams/jobHandle parameter for any subsequent POST requests for
the same job. You can also use it to poll job status with the getActiveJobs operation or to query the job logs with the
getJobLogDetails operation.

If there is an error processing the POST request, the response body consists of one of the API fault types as described in Faults.
Uploading assets by way of HTTP POSTs to the 335
UploadFile Servlet

Example POST request

POST /scene7/UploadFile HTTP/1.1
User-Agent: Jakarta Commons-HttpClient/3.1
Host: localhost
Content-Length: 362630
Content-Type: multipart/form-data; boundary=O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ

--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ
Content-Disposition: form-data; name="auth"
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 8bit

<authHeader xmlns="http://www.scene7.com/IpsApi/xsd/2014-04-03">
<user>sampleuser@test.com</user>
<password>*</password>
<locale>en-US</locale>
<appName>MyUploadServletTest</appName>
<appVersion>1.0</appVersion>
<faultHttpStatusCode>200</faultHttpStatusCode>
</authHeader>

--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ
Content-Disposition: form-data; name="uploadParams"
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 8bit

<uploadPostParam xmlns="http://www.scene7.com/IpsApi/xsd/2014-04-03">
<companyHandle>c|2101</companyHandle>
<jobName>uploadFileServlet-1376682217351</jobName>
<uploadParams>
<overwrite>true</overwrite>
<readyForPublish>true</readyForPublish>
<preservePublishState>true</preservePublishState>
<createMask>true</createMask>
<preserveCrop>true</preserveCrop>
<manualCropOptions>
<left>500</left>
<right>500</right>
<top>500</top>
<bottom>500</bottom>
</manualCropOptions>
<photoshopOptions>
<process>MaintainLayers</process>
<layerOptions>
<layerNaming>AppendNumber</layerNaming>
<anchor>Northwest</anchor>
<createTemplate>true</createTemplate>
<extractText>true</extractText>
<extendLayers>false</extendLayers>
</layerOptions>
</photoshopOptions>
<emailSetting>None</emailSetting>
</uploadParams>
</uploadPostParam>

--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ--
Content-Disposition: form-data; name="file1";
filename="ApiTestCo1/UploadFileServlet1376682217351//1376682217351-1.jpg"
Content-Type: application/octet-stream; charset=ISO-8859-1
Content-Transfer-Encoding: binary
<file bytes ... >
--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ--
Content-Disposition: form-data; name="file2";
filename="ApiTestCo1/UploadFileServlet1376682217351//1376682217351-2.jpg"
Content-Type: application/octet-stream; charset=ISO-8859-1
Content-Transfer-Encoding: binary
<file bytes ... >
--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ--
Uploading assets by way of HTTP POSTs to the 336
UploadFile Servlet

Example POST response – success

HTTP/1.1 200 OK
Content-Type: text/xml;charset=utf-8
Content-Length: 204
Date: Mon, 25 Jul 2016 19:43:38 GMT
Server: Unknown

'1.0' encoding='UTF-8'?><uploadPostReturn xmlns="http://www.scene7.com/IpsApi/xsd/2014-04-03">

<jobHandle>j|2101||uploadFileServlet-1376682217351|54091</jobHandle>
</uploadPostReturn>

Example POST response – error

HTTP/1.1 200 OK
Content-Type: text/xml;charset=utf-8
Content-Length: 210
Date: Mon, 25 Jul 2016 19:43:38 GMT
Server: Unknown

<?xml version='1.0' encoding='UTF-8'?><tns:authenticationFault

xmlns:tns="http://www.scene7.com/IpsApi/xsd"><tns:code>10001</tns:code><tns:reason>Invalid
username/password</tns:reason></tns:authenticationFault>