adobe experience cloud ips api · the ips web service is supported by a set of wsdl (web services...

Adobe® Experience Cloud

IPS API

Contents

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

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

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

Operations methods......................................................................................................24Operation 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

IPS APILast updated 2/27/2019

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


Contents

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


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


Contents

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


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


Contents

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


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


Contents

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


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


Contents

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


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


Contents

ZoomTarget....................................................................................................................................................................295

ZoomTargetArray.........................................................................................................................................................296

ZoomTargetDefinition................................................................................................................................................296

ZoomTargetDefinitionArray.....................................................................................................................................296

String constants............................................................................................................297Active 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


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.............................................................................................................................312authenticationFault.....................................................................................................................................................312

authorizationFault........................................................................................................................................................312

ipsApiFault......................................................................................................................................................................313

Change log....................................................................................................................314Version 6.0.......................................................................................................................................................................314

Operations: New and Modified.........................................................................................................................................................314

Data Types: New and Modified.........................................................................................................................................................315

Version 4.5.......................................................................................................................................................................316



Restricted Use..........................................................................................................................................................................................317

Version 4.4.......................................................................................................................................................................319



String Constants: New and Modified..............................................................................................................................................320


Contents

Version 4.2.......................................................................................................................................................................320


Version 4.0.......................................................................................................................................................................321

New Additions and Changes..............................................................................................................................................................321

Version 3.8.......................................................................................................................................................................328




Version 3.7.......................................................................................................................................................................329




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


About Scene7 Image Production System APIThe Scene7 IPS (Image Production System) Web Service API enables external applications and third-party developers toprogrammatically 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 beenspecifically 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.

17About Scene7 Image Production System API

Deprecated callsImage 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 thecdnCacheInvalidation API invalidates the cache almost immediately (~5 seconds). As such, polling for invalidation statusis no longer required.

18Deprecated calls

IPS Web Service WSDL versionsThe IPS Web Service is supported by a set of WSDL (Web Services Description Language) documents that are accessed fromany IPS installation on which the IPS Web Service component is installed. Each IPS API release includes a new WSDL file thatreferences a versioned target XML namespace. Prior WSDL namespace versions are also supported to allow for backwardscompatibility 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 theform:https://<IPS_hostname>:<IPS_port>/<IPS_webapp>/services/IpsApiService

Access URLs for Scene7 regions

Staging URL (use for pre-productiondevelopment and testing)

Production URLGeographic location

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

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

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

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 APIsupports WSDLs for the following versions:

API namespaceWSDLAPI release version

http://www.scene7.com/IpsApi/xsd/2014-04-03IpsApi-2014-04-03.wsdl6.8/2014R1



http://www.scene7.com/IpsApi/xsd/2010-01-31IpsApi-2010-01-31.wsdl4.5


19IPS Web Service WSDL versions

API namespaceWSDLAPI release version



http://www.scene7.com/IpsApi/xsdIpsApi.wsdlPre-4.0

Existing applications that need to be modified to use new features must upgrade to the latest API version and may need to makechanges 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 attributein 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 targetnamespace 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 inthe 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

DescriptionName

Valid IPS user email.user


http://www.w3.org/TR/xmlschema-0/

DescriptionName

Password for user account.password

Optional locale for request. See Locale for details.locale

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

appName

Calling application version.appVersion

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

gzipResponse

Optional parameter to override the HTTP status code for fault responses. By default, faultresponses return HTTP status code 500 (Internal Server Error). Some client platforms,

faultHttpStatusCode

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 APIversion.

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>[email protected]</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 alsospecify 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 (InternalServer 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 thenamespace http://www.scene7.com/IpsApi. For example:

<soap:Header xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <AuthUser xmlns="http://www.scene7.com/IpsApi">[email protected]</AuthUser>


<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 therequested 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 permissionsto perform certain folder and asset operations. The Operations reference section details the authorization requirements for eachoperation.

Sample SOAP request and response

The following example shows a complete addCompany operation, including HTTP headers:

POST /scene7/services/IpsApiService HTTP/1.1User-Agent: Axis/2.0SOAPAction: addCompanyContent-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>[email protected]</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 OKServer: Apache-Coyote/1.1Content-Type: text/xml;charset=UTF-8Transfer-Encoding: chunkedDate: Fri, 21 Jul 2006 20:47:55 GMT

<?xml version='1.0' encoding='utf-8'?><soapenv:Envelopexmlns: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


When an operation encounters an exception condition, a SOAP fault is returned as the body of the SOAP message in place ofthe normal response. For example, if a non-admin user attempts to send the previous addCompany request, the followingresponse is returned:

HTTP/1.1 500 Internal Server ErrorServer: Apache-Coyote/1.1Content-Type: text/xml;charset=UTF-8Transfer-Encoding: chunkedDate: Fri, 21 Jul 2006 16:36:20 GMTConnection: 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 methodsThis 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 subsequentoperation 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 becausetheir format can change between IPS releases. When you write interactive applications, you implement session timeouts anddiscard all handles between sessions, particularly after an IPS upgrade. When you write non-interactive applications, call theappropriate operations to retrieve handles each time the application is run. The following Java/Axis2 code samples show incorrectand 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");// INCORRECTsearchParam.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); //CORRECTsearchParam.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 apointer 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 operationstarget the calling user (the user whose credentials are passed in for authentication). However, admin users with the properpermissions can specify a different user. For example, the setPassword operation normally sets the password of the authenticateduser, 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 usersmust be members of the specified company. For operations that do not require a company context, the authenticated and targetusers must both be members of at least one common company.

The following operations can retrieve user handles:

24Operations methods

• 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. TheaccessUserHandle parameter allows an admin to impersonate another user. The accessGroupHandle parameter allowsthe 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 timeand memory required to process the request and reduce the size of the response data. The caller can request a specific list offields by passing a responseFieldArray parameter, or with an enumerated a list of excluded fields via the excludeFieldArrayparameter.

Both responseFieldArray and excludeFieldArray specify fields by using a node path separated by /. For example, tospecify 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-elementsin a complex type field (for example, assetArray/items/imageInfo/originalPath), then only those sub-elements areincluded.

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. Ifthe locale parameter is not present, the HTTP header Accept-Language will be used. If this header is also not present, thedefault 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.


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. Ifthe company name requested already exists in the system, it throws an ipsApiFault.

Authorized User Types

• IpsAdmin

• TrialSiteAdmin

• ImagePortalAdmin

Parameters

Input (addCompanyParam)

DescriptionRequiredTypeName

The name of the company toadd.

Yesxsd:stringcompanyName

The expiration date of thecompany. Provide the time

Noxsd:dateTimeexpires

zone with the request for thisfield. Time zones are adjustedto Central Time.

Output (addCompanyReturn)


Handle to and name, rootpath, expiration date, and timeof the new company.

Yesxsd:stringcompanyInfo

Examples

This example demonstrates a request to add a company to the IPS system and the response detailing the information about theadded company that is needed to perform other operations.


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.


• IpsAdmin• IpsCompanyAdmin• TrialSiteAdmin• ImagePortalAdmin

Parameters

Input (addCompanyMembershipParam)


The handle to the user whosemembership you want to add.

Noxsd:stringuserHandle

An array of companies thatyou're adding the user to.

Yestypes:CompanyMembershipUpdateArraymembershipArray

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|[email protected]</ns1:userHandle> <ns1:companyHandleArray> </ns1:items>47</ns1:items> </ns1:companyHandleArray></ns1:addCompanyMembershipParam>

Response

None.


addGroupMembers

Adds users from a specific company to a specific group.


• IpsAdmin• IpsCompanyAdmin• ImagePortalAdmin

Parameters

Input (addGroupMembersParam)


The handle to the company.Yesxsd:stringcompanyHandle

The group handle.Yesxsd:stringgroupHandle

An array of handles to userswho you want to add to agroup.

Yestypes:HandleArrayuserHandleArray

Output (addGroupMembersParam)


Examples

This example uses addGroupMembersParam to add a user to a single company. The IPS API does not return a response forthis 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|[email protected]</ns1:items></ns1:userHandleArray></ns1:addGroupMembersParam>

Response

None.

addGroupMembership

Adds a user to an array of groups.




Parameters

Input (addGroupMembershipParam)


Handle to the user whosegroup membership you wantto add.


Array of handles to the groupsyou want the company tobelong to.

Yesxsd:HandleArraygroupHandleArray

Output (addGroupMembershipParam)


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.


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

Parameters

Input (addProjectAssetsParam)



Handle to the companyassociated with the currentproject.

Yesxsd:stringcompanyHandle

Handle to the project you'readding assets to.

Yesxsd:stringprojectHandle

Array of assets you're addingto the current project.

Yesxsd:HandleArrayprojectHandleArray

Output (addProjectAssetsParam)


The number of assets addedsuccessfully.

Yesxsd:intsuccessCount

The number of warningsgenerated when the operation

Yesxsd:intwarningCount

attempted to add assets to aproject.

The number of errorsgenerated when the operation

Yesxsd:interrorCount

attempted to add assets to aproject.

Array of warnings generatedby assets when the operation

Noxsd:AssetOperationFaultArraywarningDetailHandle

attempted to add them to aproject.

Array of errors generated byassets when the operation

Noxsd:AssetOperationFaultArraycompanyHandle

attempted to add them to aproject.

Examples

This example adds a single asset (referenced by its handle) in an asset handle array to a project specified in the request. Theoperation 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>


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.



Parameters

Input (addTagFieldValuesParam)


The handle of the companycontaining the tag field.


The handle of the tag field tobe modified.

Yesxsd:stringfieldHandle

An array of tag values to addto the field's existingdictionary.

Yesxsd:stringvalueArray

Output (addTagFieldValuesParam)


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.


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



Parameters

Input (addUserParam)


The user's first name.Yesxsd:stringfirstName

The user's last name.Yesxsd:stringlastName

The user's email address.Yesxsd:stringemail

Sets the role for a user in eachcompany they belong to. Note,

Yesxsd:stringdefaultRole

however, the IpsAdmin roleoverrides other per-companysettings.

Sets the user's passwordYesxsd:stringpassword

Sets the password expirationperiod. Provide the time zone

Noxsd:dateTimepasswordExpires

when passing in the request.Time zones are adjusted toCentral Time.

Determines if the user is valid.Yesxsd:booleanisValid

An array of company handles.Yesxsd:CompanyMembershipUpdateArraymembershipArray

Output (addUserParam)


The handle to the user.Yesxsd:stringuserHandle

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>[email protected]</ns1:email> <ns1:defaultRole>TrialSiteUser</ns1:role>


<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|[email protected]</ns1:userHandle></ns1:addUserReturn>

batchGetAssetPublishContexts

Returns the publish contexts for assets marked for publication.


• 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)


Handle to the company.Yesxsd:stringcompanyHandle

A list of assets you want toquery for active (marked forpublish) contexts.

Yestypes:HandleArrayassetHandleArray

Output (batchGetAssetPublishContextsReturn)


An array of publish contextsin which each asset is markedfor publish.

Yestypes:assetPublishContextsArrayassetPublishContextsArray


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.



Parameters

Input (batchSetAssetMetadataParam)



The handle to the companywhose metadata you want toset in a batch operation.


The array of metadata updatesapplied to the assets.

Yestypes:BatchMetadataUpdateArrayupdateArray

Output (batchSetAssetMetadataParam)


The number of successfully setmetadata.


The number of warningsgenerated when the operationattempted to set metadata.


The number of errorsgenerated when the operationattempted to set metadata.


The array of details associatedwith the assets generating

Notypes:AssetOperationFaultArraywarningDetailArray

warnings when the operationattempted to batch setmetadata for the assets.

The array of details associatedwith the assets that generating

Notypes:AssetOperationFaultArrayerrorDetailArray

erros when the operationattempted to batch setmetadata 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>


<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.


• IpsUser• IpsAdmin• IpsCompanyAdmin• ImagePortalContrib• ImagePortalContribUser

Parameters

Input (batchSetFontFieldsParam)


Handle to the company thatcontains the fonts.


Array of font field updates.Yestypes:FontFieldUpdateArrayupdateArray

Output (batchSetFontFieldsParam)


The number of successfully setfont fields.


Number of warnings generatedwhen the operation attemptedto set font fields.


Number of errors generatedwhen the operation attemptedto set font fields.




The array of details associatedwith the assets that generated


warnings when the operationattempted to apply theupdates.



errors when the operationattempted to apply theupdates.

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.



Parameters

Input (batchSetIccProfileFields)



Handle to the company thatcontains the ICC profiles.


Array of ICC profile updates.Yesxsd:stringupdate array

Output (batchSetIccProfileFields)


The number of successfully setICC profile fields.




attempted to set the ICCprofile fields.



attempted to set the ICCprofile fields.







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>


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

batchSetImageFields

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



Parameters

Input (batchSetImageFields)


The handle to the companythat contains the image assets.


The array of image fieldupdates.

Yestypes:ImageFieldUpdateArrayupdateArray

Output (batchSetImageFields)


The number of successfully setimage fields.




attempted to set the imagefields.



attempted to set the imagefields.








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 handlesand contain resolution in pixels, x- and y-position anchor coordinates, and user data. The response indicates that fields for bothimages 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




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

Parameters

Input (batchSetThumbAssetParam)


The handle to the companythat contains the assets.


The array of updates.Yestypes:ThumbAssetUpdateArrayupdateArray

Output (batchSetThumbAssetParam)


The number of successfully setthumbnails.




attempted to set thethumbnails.



attempted to set thethumbnails.







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>


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 existingcache of HTTP responses.

cdnCacheInvalidation: About

CDN cache invalidation forces all HTTP requests for these URLs to be revalidated against the current published data on theScene7 network once this invalidation request is processed through the CDN network. Any URLs that are not connected to theScene7 service URL structure and directly matching the Scene7 company root ID assigned when the company is created willresult in an API fault for the entire request. Any invalid URLs that the CDN does not support that it considers invalid will alsoresult 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 thediscretion 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 basisor 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 APIsends 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 thatScene7 can deliver to the CDN partner on a single notification. Currently, that would be if the request exceeds 100 URLs, butis subject to change based at the request of the CDN partner.

Supported Since

6.0


• IpsAdmin• IpsCompanyAdmin

Parameters

Input (cdnCacheInvalidationParam)


The handle to the companyconnected with the URLs toinvalidate.




List of up to 1000 URLs toinvalidate from the CDN

Yestypes:UrlArrayurlArray

cache. All URLS must containthe Scene7 company root IDto be invalidated.

Output(cdnCacheInvalidationReturn)


A handle referencing the purge request.Yesxsd:stringinvalidationHandle

The cdnCacheInvalidation API nowinvalidates the cache almost immediately(~5 seconds). As such, polling forinvalidation status is generally no longerrequired.

Estimated seconds to completion of thepurge request. Clients should wait forthis time before polling status.

Yesxsd:intestimatedSeconds

Example

This example requests four URLs to be invalidated in the CDN cache. The response contains summary counts of the success ofthe 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 catalognamespace.



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

Parmaeters

Input (checkAssetNamesParam)


The handle to the companythat contains the user.

Noxsd:stringcompanyHandle

An array of asset names tocheck.

Yestypes:StringArrayassetNamesArray

Output (checkAssetNamesReturn)


An array of asset names in use.Yestypes:StringArrayinUseNameArray

Examples

This sample code requests the asset names in use for a specified company. The response returns an array of asset names that arein 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.




Parameters

Input (checkLoginParam)


The handle to the companythat contains the user.


The user's email address.Yesxsd:stringemail

The user's password.Yesxsd:stringpassword

Output (checkLoginParam)


User's log in status.Yesxsd:stringstatus

Examples

This sample code uses a company handle parameter, email address, and a password to determine if a user can log in to IPS. Ifthe 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>[email protected]</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



• IpsUser

• IpsAdmin

• IpsCompanyAdmin


• ImagePortalContrib

• ImagePortalContribUser

Parameters

Input (copyImageParam)


The handle to the companythat contains the image.


The handle to the image asset.Yesxsd:stringassetHandle

The handle to the folder wherethe image is to be copied.

Yesxsd:stringfolderHandle

Name of new image.Yesxsd:stringname

Yesxsd:stringurlModifier

Output (copyImageParam)


The handle to the copiedimage.

Yesxsd:stringassetHandle

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>


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.



Parameters

Input (createAssetSet)


The handle to the companythat will contain the asset set.


The handle to the folder inwhich the new asset set will becreated.


Asset name.Yesxsd:stringname

A unique identifier created bythe client for the asset set type.

Yesxsd:stringsubType

The parameters in the setdefinition string.

These must resolve to theformat specified by the targetviewer.

Noxsd:stringsetDefinition

Handle of the asset that acts asthe thumbnail for the new

Noxsd:stringthumbAssetHandle

image set. If not specified, IPStries to use the first image assetreferenced by the set.

Substitution Functions for setDefinition

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


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

ReturnsSubstitution Function

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

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

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

[<metadata_field_handle>])

The asset's catalog ID (for image-based assets only).Theassociated thumb asset's catalog ID (for other assets). If an

getThumbCatalogId([<asset_handle>])

associated thumb asset is not available, the function returns anempty string.

Sample Media setDefinition 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])}

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)


The handle to the asset set.Yesxsd:stringassetHandle

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 AdjustedViewderived type helps apply simple modifications to a single image (for example, by specifying a crop rectangle), while the LayerViewhelps create a multilayer view which may include text or additional images.


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



Parameters

Input (createDerivedAssetParam)


The handle to the companythat contains the asset from


which you will derive the newasset.

The handle to the masterImage asset from which thenew image will be derived.

Yesxsd:stringownerHandle

The handle to the folder inwhich the new derived assetwill be created.


The name of the derived asset.Yesxsd:stringname

The asset type of the newderived asset: AdjustedViewor LayerView.

Yesxsd:stringtype

Image serving or imagerendering protocol commands

Noxsd:stringurlModifier

applied before the request orurlPostApplyModifier

commands.

Image serving or imagerendering protocol commands

Noxsd:stringurlPostApplyModifier

applied after to the request orurlPostApplyModifier

commands.

Output (createDerivedAssetParam)



The handle to the derivedasset.


Examples

The sample code creates a derived asset with an adjusted view and urlModifier and urlPostApplyModifier with arbitraryvalues. 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.



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

Parameters

Input (createFolder)


The Handle to the companyYesxsd:stringcompanyHandle

The root folder used to retrievefolders and all subfolders to the

Yesxsd:stringfolderPath



leaf level. If excluded, thecompany root is used.

Output (createFolderParam)


Handle of the new folder.Yesxsd:stringfolderHandle

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.



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

Parameters

Input (createImageSetParam)


The handle to the companythat the image set belongs to.


The handle to the folder.Yesxsd:stringfolderHandle

Image set name.Yesxsd:stringname



Image set type.Yesxsd:stringtype

Handle of the asset that acts asthe thumbnail for the new


image set. If not specified, IPStries to use the first image assetreferenced by the set.

Output


The handle to the new imageset.


Examples

This code sample creates an image set specified by company, folder, name, and type. The response is an asset handle of the newlycreated 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.


• IpsAdmin

Parameters

Input (createMetadataFieldParam)

DescriptionRequiredTypeParameter name

Name of the company themetadata field belongs to.


Asset type.Yesxsd:stringassetType



Name of the metadata fieldthat you are creating.

Yesxsd:stringname

Metadata field type.

The metadata field typesconstant defines the availabletypes.

Yesxsd:stringfieldType

The default value of themetadata field to be created(for example, Scene 7).

Noxsd:stringdefaultValue

Default values are notsupported for tag field typesand must be omitted. If anon-empty default is specifiedfor a tag field type, a fault willbe returned.

Hide or expose IPSsystem-specific metadata.

Noxsd:booleanisHidden

A boolean flag that indicateswhether the metadata field is

Noxsd:booleanisEnforced

enforced (validated) when thevalue is set.

If set to true, then a fault isthrown if an illegal value is setin setAssetMetadata/batchSetAssetMetadata.

Allows you create a set ofshared enumerated values thatselected tags can point to.

Noxsd:stringinitialTagValue

Output (createMetadataFieldReturn)


The handle to the newmetadata field.


Examples

This code sample creates a string type metadata field called createMetadataField. The response returns the handle to thenew metadata field.


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.



Parameters

Input (createProjectParam)


The handle of the companyassociated with the newproject.


New project name.Yesxsd:stringprojectName

Output (createProjectParam)


The handle to the new project.Yesxsd:stringprojectHandle

Examples

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

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


<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 theproperty 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 willreplace the existing one.



Parameters

Input (createPropertySetParam)


The handle to the property settype.

Yesxsd:stringtypeHandle

The handle to the primaryowner of the property set.

Yesxsd:stringprimaryOwnerHandle

The handle to the secondaryowner of the property set.

Noxsd:stringsecondaryOwnerHandle

The array of properties.Yestypes:PropertyArraypropertyArray

types:PermissionUpdateArraypermissionArray

Output (createPropertySetParam)


The handle to the newproperty set.

Yesxsd:stringsetHandle

Examples

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

Request<createPropertySetParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15"> <typeHandle>pt|10801</typeHandle> <primaryOwnerHandle>u|41|[email protected]</primaryOwnerHandle> <propertyArray> <items> <name>application_project_whatever</name>


<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.



Parameters

Input (createPropertySetTypeParam)


The handle to the companythat owns the property set


type. If companyHandle is notpassed and the caller is anIpsAdmin, a global propertyset type will be created.

The name of the property settype.

Yesxsd:stringname

Choice of property set types.Yesxsd:stringpropertyType

Determines if your programcan have multiple propertysets.

Yesxsd:booleanallowMultiple

Output (createPropertySetTypeReturn)


A handle to the type.Yesxsd:stringtypeHandle


Examples

This code sample creates a property set with a name and type specified by the PropertySet Types constant. The handle tothe company that owns the property set type. If companyHandle is not passed and the caller is an IpsAdmin, a global propertyset 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 priorto any user-supplied commands on the URL. The urlPostApplyModifier parameter specifies protocol commands appliedafter any URL commands, which will override any conflicting user-supplied settings.


• IpsUser• IpsAdmin• ImagePortalAdmin• ImagePortalContrib• ImagePortalContribUser

Parameters

Input (createTemplateParam)


The company that the templatebelongs to.


The folder handle thatrepresents the folder where thetemplate resides.


Template name.Yesxsd:stringname

Template type.Yesxsd:stringtype

Specifies the Image Servercommands stored in the IS


catalog that are applied priorto any user-suppliedcommands on the URL.



Specifies protocol commandsapplied after any URL


commands, which willoverride any conflictinguser-supplied settings.

Output (createTemplateParam)


The handle to the template.Yesxsd:stringassetHandle

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 isapplied when the assets are published.



Parameters

Input (createViewerPresetParam)



The handle of the companythat contains the viewer presetsand assets.


The handle of the folder thatcontains the assets.


Viewer name.Yesxsd:stringname

Viewer type.Yesxsd:stringtype

An array that contains names,values, and handles of imagesthat you're applying presets to.

Notypes:ConfigSettingArrayconfigSettingArray

Output (createViewerPresetReturn)


Handle of the preset to theviewer.

Yesxsd:stringviewerPresetHandle

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.


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 vignetteformat sizes for publishing.



Parameters

Input (createVignettePublishFormatParam)


Handle to the company thevignette belongs to.


Name to identify the vignettepublishing format.

Yesname

Specifies the target width of theresulting vignette view inpixels.

YestargetWidth

Use zero so the output vignettehas the same size as the mastervignette.

Creates a pyramid vignetteoptimized for zooming on the

YestargetHeight

Image Rendering server.Starting at the maximum size,set by the Target Vignette Sizefields, this creates multiple sizeviews in a single vignetteoutput file. Each subsequentview size is halved until thewidth and height are within128x128 pixels.

Specifies the width of eachresulting thumbnail in pixels.

YescreatePyramid

This setting is optional. Leaveas zero for no thumbnail file.

Specifies the file format for thepublished vignettes. Given a

YesthumbWidth



new version of ImageAuthoring and an oler versionof the Image Rendering Server,you must specify a vignetteversion that yourImageRendering Server canread. If you specify a higherversion, the Image Renderingserver cannot read thepublished vignettes. Set to zeroto publish vignettes at thelatest version.

Specifies the character theseparates the vignette name

YessaveAsVersion

and the suffix indicating itswidth.

Specifies the character theseparates the vignette name

YessizeSuffixSeparator


Applies sharpening to themain view image for each

Nosharpen

puvlish vignette sizeSharpening can compensatefor blurring when thevignetters are scaled.

Digital unsharp masking is aflexible and powerful way to

YesusmAmount

increase sharpness, especiallyin scanned images. Thiscontrols the magnitude of eachovershoot (how much darkerand light the edge bordersbecome).

Affects the size of the edges tobe enhanced or how wide the

YesusmRadius

edge rims become, so a smallerradium enhances smaller-scalledetail. Higher radius values cancause halos at the edges. Finedetail needs a smaller radius astiny detail of the same size orsmaller than the radius is lost.



Controls the minimumbrightness change to be

YesusmThreshold

sharpened or how far apartadjacent tonal values must bebefore the filter works. Thissetting can sharpen morepronouced edges while leavingmore subtle edges untouched.THe allowable range ofthreshold of 0 to 255.

Output (createVignettePublishFormatReturn)


The handle to the createdvignette format.

Yesxsd:stringvignetteFormatHandle

Examples

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

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.


• IpsUser• IpsAdmin• IpsCompanyAdmin


• ImagePortalAdmin• ImagePortalContrib• ImagePortalContribUser

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

Parameters

Input (deleteAssetParam)


The handle to the company towhich the folder belongs.


The handle to the asset todelete.


Output (deleteAssetParam)


Examples

This sample code deletes any type of asset from a specific company. It requires an asset handle, which you must obtain fromanother 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)



The handle to the company theassets belong to.


The array of assets to bedeleted.


Output (deleteAssetsParam)


The number of successfullydeleted assets.


The assets that generated awarning when the operationtried to delete them.


The assets that generated anerror when the operation triedto delete them.




a warning when the operationtried to delete them.



an error when the operationtried 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 Webservices 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>


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


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

Parameters

Input (deleteAssetMetadataParam)




The handle to the asset todelete.


Metadata to delete from theasset.

Yesxsd:stringmetadataDelete

Array of metadata to deletefrom the asset.

Yestypes:MetadataDeleteArraydeleteArray

Output (deleteAssetMetadataParam)


Examples

MetadataDelete

<complexType name="MetadataDelete"> <sequence> <element name="fieldHandle" type="xsd:string"/>


</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.



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

Parameters

Input (deleteFolderParam)




The handle to the folder todelete.


Output (deleteFolderParam)


Examples

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

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


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

None.

deleteGroup

Deletes a group.



Parameters

Input (deleteGroupParam)


The handle to the companythat belongs to the group thatyou want to delete.


The handle to the group thatyou want to delete.

Yesxsd:stringgroupHandle

Output (deleteGroupParam)


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.


• IpsUser• IpsAdmin• IpsCompanyAdmin• ImagePortalAdmin


Parameters

Input (deleteImageFormatParam)


The handle to the companythat contains the image formatthat you want to delete.


The handle to the imageformat you want to delete.

Yesxsd:stringimageFormatHandle

Output (deleteImageFormatParam)


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.



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

Parameters

Input (deleteImageMapParam)



The handle to the companythat contains the image map todelete.


The handle to the image mapto delete.

Yesxsd:stringimageMapHandle

Output (deleteImageMapParam)


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.


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

Parameters

Input (deleteJobParam)


The handle to the company towhich the job belongs.


The handle to the job to delete.Yesxsd:stringjobHandle

Output



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 obtainfrom 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.



Parameters

Input (deleteMetadataFieldParam)


The handle to the companythat contains the metadatafield to be deleted.


The handle to the metadatafield to be deleted.


Output (deleteMetadataFieldParam)


Examples

This code sample deletes a company's metadata field. It uses the company handle and metadata handle as fields in thedeleteMetadataFieldParam 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


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 fromIPS.



Parameters

Input (deleteProjectParam)


The name of the companyassociated with the project.


The handle to the project to bedeleted.


Output (deleteProjectReturn)


Examples

This code sample uses the company handle and the project handle as fields in the deleteProjectParam sent to the IPS Webservices 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.




• TrialSiteAdmin• ImagePortalAdmin

Parameters

Input (deletePropertySetParam)


The handle to the property setto be deleted.

Yesxsd:stringsetHandle

Output (deletePropertySetParam)


Examples

This code sample uses the set’s handle as a field in the deletePropertySetParam sent to the IPS Web services server in orderto 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.



Parameters

Input (deletePropertySetTypeParam)


The handle to the property settype to be deleted.


Output (deletePropertySetTypeParam)



Examples

This code sample uses the type’s handle as a field in the deletePropertySetTypeParam sent to the IPS Web services serverin 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.



Parameters

Input (deleteTagFieldValuesParam)




The handle of the tag field tobe modified.


An array of tag values to bedeleted from the field’sdictionary.

Yestypes:StringArrayvalueArray

Output (deleteTagFieldValuesParam)


Examples

RequestdeleteTagFieldValuesParam 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


None.

deleteVignettePublishFormat

Deletes a vignette publish format.



Parameters

Input (deleteVignettePublishFormatParam)


The handle to the company towhich the vignette belongs.


The handle to the vignettepublish format to be deleted.


Output (deleteVignettePublishFormatParam)


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.


• IpsUser• IpsAdmin• IpsCompanyAdmin• ImagePortalAdmin• ImagePortalContrib




Parameters

Input (deleteZoomTargetParam)


The handle to the company towhich the zoom target belongs.


The handle to the zoom targetto delete.

Yesxsd:stringzoomTargetHandle

Output (deleteZoomTargetParam)


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, theylive in the Trash until the next cleanup job (normally nightly) when they are finally purged from the system. If they time out ofthe trash, assets are cleaned off as part of that same cleanup activity. The time out is configurable (defaults is 7 days).


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


Parameters

Input (emptyAssetsFromTrashParam)


The handle to the companythat owns the assets.


The array of handles thatrepresent the items to beemptied from the trash.


Output (emptyAssetsFromTrashParam)


The number of assetssuccessfully emptied from thetrash.

Yesxsd:IntsuccessCount


Yesxsd:IntwarningCount

attempted to empty assets fromthe trash.


Yesxsd:InterrorCount

attempted to empty assets fromthe trash.



warnings when the operationattempted to empty them fromthe trash.



errors when the operationattempted to empty them fromthe trash.

Examples

This code sample uses the company’s handle and an asset handle array that contains handles to the assets to be emptied fromthe 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>


</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.


• IpsUser

• IpsAdmin

• TrialSiteAdmin

• TrialSiteAdmin

• TrialSiteUser




Parameters

Input (executeJobParam)


The handle to the company towhich the job belongs.


The handle to the job to run.Yesxsd:stringjobHandle

Output (executeJobReturn)


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


None.

forceRepublishAssets

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



Parameters

Input (forceRepublishAssetsParam)


Handle to the companycontaining assets to reset.


Designates that the files for theasset are republished to the

Noxsd:booleanrepublishFiles

delivery servers. Defaults totrue.

Designates that the catalogmetadata used to serve the asset

Noxsd:booleanresyncCatalog

is synced to guarantee that it iscurrent. This parameter is usedto resolve race conditions thatmight occur on near concurrentupdates to the same record.Defaults to false.

Array of handles to assetswhose publish status is to bereset.


Output (forceRepublishAssetsParam)


Array of publish state updates.Yestypes:PublishStateUpdateArraypublishStateUpdateArray


generatePassword

Generates a new password.


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

Parameters

Input (generatePasswordParam)

None.

Output (generatePasswordParam)


A new password.Yesxsd:stringpassword

Examples

This code sample generates a password. It is unusual because the request is simply a parameter without any enclosed elementsor 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.


• IpsUser• IpsAdmin• IpsCompanyAdmin• TrialSiteAdmin• TrialSiteUser


• ImagePortalAdmin• ImagePortalContrib• ImagePortalContribUser

Parameters

Input (getActiveJobsParam)


The handle to the company.Noxsd:stringcompanyHandle

The handle to the job.Noxsd:stringjobHandle

Original job name.Noxsd:stringoriginalName

Output (getActiveJobsReturn)


Array of active jobs.Yesxsd:stringjobArray

Examples

This code sample returns all active jobs of a company running in IPS. In this case, the response is unusual because the IPSscheduling coordinator is disabled with no active jobs running. Under normal circumstances, the response would return anumber 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 oneactive server defined for the context.


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



Parameters

Input (getActivePublishContextsParam)


The handle to the company toquery for active publishcontexts


Output (getActivePublishContextsReturn)


The array of active publishcontexts, which may include

Yestypes:StringArraycontextArray

zero or more values fromPublish Context.

getAllCompanies

Returns an array of all companies.


• IpsAdmin

Parameters

Input (getAllCompaniesParam)


Set to true to return expiredand non-expired companies.

Yesxsd:booleanincludeExpired

Output (getAllCompaniesReturn)


The array of companies.Yestypes:CompanyArraycompanyArray

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>


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.



Parameters

Input (getAllUsersParam)


Set to:Yesxsd:booleanincludeInvalid

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

Output (getAllUsersReturn)


Array of all users.Yestypes:UserArrayuserArray

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>


Response<ns1:getAllUsersReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd"> <ns1:userArray> <ns1:items> <ns1:userHandle>201|[email protected]</ns1:userHandle> <ns1:firstName>333</ns1:firstName> <ns1:lastName>333</ns1:lastName> <ns1:email>[email protected]</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 (datatype xsd:int), allowing the representation of multiple asset types per element of the array.



Parameters

Input (getAssetCountsParam)


The handle to the companywith assets you want to count.


Output (getAssetCountsReturn)


An array of asset types, eachwith its own count field,

Notypes:AssetCountArraycountArray

allowing the representation ofmultiple asset types perelement of the array.


Examples

This code sample uses the company’s handle as a field in the getAssetCountsParam sent to the IPS Web services server inorder 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 thatasset. The logMessage response field is localized based on the authHeader field.



Parameters

Input (getAssetJobLogsParam)


The handle to the company towhich the asset belongs.


The handle to asset with thejob logs to be retrieved.


Output (getAssetJobLogsReturn)



Job log array.Yestypes:AssetJobLogArrayjobLogArray

Examples

This code sample retrieves the job logs of a specific asset. The response returns a job log array with detailed information aboutall 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>[email protected]</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>[email protected]</submitUserEmail> <logDate>2008-06-11T11:38:48.547-07:00</logDate> </items> </jobLogArray></getAssetJobLogsReturn>

getAssetMetadataFields

Returns all metadata fields, grouped by asset type.


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

Parameters

Input (getAssetMetadataFieldsParam)



The handle to the companywhose metadata you want toretrieve.


Output (getAssetMetadataFieldsReturn)


Array of metadata fields, byasset type.

Yestypes:AssetMetadataFieldsArrayassetFieldArray

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.



Parameters

Input (getAssetPublishHistoryParam)



The handle to the companywith the asset publish history.


The asset with the publishhistory you want to examine.


Output (getAssetPublishHistoryReturn)


The asset's publish history.Yestypes:PublishHistoryArraypubHistoryArray

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.



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

Parameters

Input (getAssetParam)



The company handle.Yesxsd:stringcompanyHandle

Impersonate a specific user.Used by administrators only.

Noxsd:stringaccessUserHandle

Filter by group.Noxsd:stringaccessGroupHandle

The root folder to retrievefolders and all subfolders to the

Yesxsd:HandleArrayassetHandleArray


Fields and sub-fields includedin the response.

Notypes:StringArrayresponseFieldArray

Fields and sub-fields excludedfrom the response.

types:StringArrayexcludeFieldArray

Outpub (getAssetsReturn)


Array of assets matching thefilter criteria.

Notypes:AssetArrayassetArray

getAssetsByName

Returns assets based on an array of asset names.


• IpsUser• IpsAdmin• IpsCompanyAdmin• TrialSiteAdmin• TrialSiteUser• ImagePortalAdmin


• ImagePortalContrib• ImagePortalContribUser

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

Parameters

Input (getAssetsByNameParam)



Provides access as anotheruser. Available toadministrators only.


Used to filter by a specificgroup.

Noxsd:stringaccessGroupHandle

Array of asset names toretrieve.

Yestypes:StringArraynameArray

Array of asset types allowed forretrieved assets.

Notypes:StringArrayassetTypeArray

Array of Asset Types excludedfor retrieved assets.

Notypes:StringArrayexcludeAssetTypeArray

Array of asset subtypes allowedfor retrieved assets.

Notypes:StringArrayassetSubTypeArray

If true andassetSubTypeArray is not

Noxsd:booleanstrictSubTypeCheck

empty, only assets whosesubtypes are inassetSubTypeArray arereturned.

If false, then assets with nodefined subtype are included.

The default value is false.

Contains a list of fields andsubfields included in theresponse.


Contains a list of fields andsubfields excluded from theresponse.

Notypes:StringArrayexcludeFieldArray

Output (getAssetsByNameReturn)



Array of assets that match thefilter 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.



Parameters

Input (getAssociatedAssetsParam)



Handle to the company thatowns the asset.


Asset handle.Yesxsd:stringassetHandle

The array of response fieldsdesired. See response-


FieldArray/excludeFieldArrayin the Introduction.

The array of excluded responsefields. See response-


FieldArray/excludeFieldArrayin the Introduction.

Output (getAssociatedAssetsReturn)


Array of set and templateassets containing the speci-fied asset.

Notypes:AssetArraycontainerArray

Array of assets contained bythe specified set or templateasset.

Notypes:AssetArraymemberArray

Array of assets referenced in alayer or template URL.

Notypes:AssetArraylayerReferenceArray

Array of assets that own thespecified asset.

Notypes:AssetArrayownerArray

Array of assets that were usedto generate the specified asset.

Notypes:AssetArrayderivedArray

The generatorArray liststhe way this asset was created.

Notypes:GenerationInfoArraygeneratorArray

For example, ifassetHandler was an imagepage of a PDF, then this wouldcontain the PDF processor tooland reference the PdfFile asset.



The generatedArray invertsthe way this asset was created.

Notypes:GenerationInfoArraygeneratedArray

For example, thegeneratedArray couldcontain the list of imagesgenerated from thisassetHandler if this was aPdfFile asset.

The thumb asset informationassociated with the request

Notypes:AssetthumbAsset

asset. If no thumb asset isassigned, the field is omittedin the response.

You can use the parameters responseFieldArray or excludeFieldArray to limit the response size. In particular, theGenerationInfo items returned in generatorArray or generatedArray default to include both the originator and thegenerated asset records. For a PDF asset type, this behavior results in unwanted multiple copies of the "originator" PDF assetrecord 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 includesa 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>


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>


<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.


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

Parameters

Input (getAutoCropRectParam)

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


The handle to the company with theasset you want to work with.


The handle to the asset you want towork with.


Compute crop rectangle based oncolor. See AutoColorCropOptions.

Notypes:AutoColorCropOptionsautoColorCropOptions

Compute crop rectangle based ontransparency. SeeAutoTransparentCropOptions.

Notypes:AutoTransparentCropOptionsautoTransparentCropOptions

Output (getAutoCropRectReturn)



The starting left pixels coordinate of thecomputed crop region.

Yesxsd:intxOffset

The starting top pixel coordinate of thecomputed crop region.

Yesxsd:intyOffset

Width of the computed crop region (in pixels).Yesxsd:intwidth

Height of the computed crop region (in pixels).Yesxsd:intheight

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 theexpiration date. You must specify either companyHandle or companyName whose information you want to retrieve.


• IpsUser

• IpsAdmin

• TrialSiteAdmin

• TrialSiteUser


• ImagePortalUser



Parameters

Input (getCompanyInfoParam)



The handle of the companywhose information you wantto obtain.

Either companyHandle orcompanyName is required.

xsd:stringcompanyHandle

The name of the companywhose information you wantto obtain.

Either companyHandle orcompanyName is required.

xsd:stringcompanyName

Output (getCompanyInfoReturn)


Handle and other descriptiveinformation about thecompany.

Yestypes:CompanycompanyInfo

Examples

This code sample returns all information about a company by using a company name and handle. It returns data similar to theresponse 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.




Parameters

Input (getCompanyMembersParam)


The handle to the companywhose members you want toobtain.


Include invalid companies.Yesxsd:booleanincludeInvalid

Output (getCompanyMembersReturn)


Array of user memberships.Yestypes:CompanyMemberArraymemberArray

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|[email protected]</userHandle> <firstName>Peter</firstName> <lastName>Bayol</lastName> <email>[email protected]</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.


• IpsUser• IpsAdmin• IpsCompanyAdmin• TrialSiteAdmin• ImagePortalAdmin• TrialSiteUser• ImagePortalAdmin


• ImagePortalUser• ImagePortalContrib• ImagePortalContribUser

Parameters

Input (getCompanyMembershipParam)


The handle to the user whosememberships you want toobtain.


Output (getCompanyMembershipReturn)


Array of companymemberships.

Yestypes:CompanyMembershipArraymembershipArray

Examples

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

Request<ns1:getCompanyMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd"> <ns1:userHandle>70|[email protected]</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.




Parameters

Input (getCompanySettingsParam)


The handle to the companywhose settings you wish toretrieve.


Output (getCompanySettingsReturn)


Company settings.Yestypes:CompanySettingssettings

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.).


• IpsAdmin• IpsCompanyAdmin• TrialSiteAdmin



Parameters

Input (getDiskUsageParam)


The handle to the companywhose disk usage you want toobtain.


Output (getDiskUsageReturn)


Array of company disk use.Yestypes:DiskUsageArraydiskUsageArray

Examples

The name of this request is misleading. Rather than returning merely a scalar value that reflects how much disk space a companyis 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.




Parameters

Input (getDistinctMetadataValuesParam)


The handle to the companythat you want to get data for.


Metadata key in dot notation.Yesxsd:stringmetadataKey

Output (getDistinctMetadataValuesReturn)


Values of the requestedmetadata field.

Yestypes:ValueArrayvalueArray

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>[email protected]</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>


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 sharethe same name will cause a namespace conflict, even if they're in different folder hierarchies.



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

Parameters

Input (getFoldersParam)



Used by administrators toimpersonate a specific user.


Filter by a specific group.Noxsd:stringaccessGroupHandle


Noxsd:stringfolderPath


Returns folders that onlycontain specified asset types.


Contains a list of fields thatyou want to include in theresponse.


Contains a list of fields youwant to exclude from theresponse.



Output (getFoldersReturn)


An array of folders that matchthe filter criteria. The response

Notypes:FolderArrayfolderArray

is limited to 100,000 foldersmaximum.

types:PermissionSetArraypermissionsSetArray

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,000folders


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


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

Parameters

Input (getFolderTreeParam)



Used only by administratorsto impersonate a specific user.


Used to filter by a specificgroup, including any of thoseto which the company belongs.



Noxsd:stringfolderPath


A value of zero gets thetop-level folder. Any other

Yesxsd:intdepth

value specifies the depth todescend into the tree.

Returns folders that onlycontain specified asset types.


Contains a list of fields thatyou want to include in theresponse.


Contains a list of fields thatyou want to exclude in theresponse.


Output (getFolderTreeReturn)


The hierarchy of folders in atree structure. The response is

Notypes:foldersfolders

limited to a maximum of100,000 folders.

types:PermissionSetArraypermissionSetArray


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 intothe 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>


<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 aboutassets generated from the specified asset. generateHandle returns information about steps used to generate the specified assetor file.



Parameters

Input (getGenerationInfoParam)


The handle to the company.Yesxsd:string

The engine that was used inthe generation. See Font Styles.

Noxsd:string

The handle of the asset toquery for generated assets.

Noxsd:string

The handle of the asset toquery for assets and enginesused in its generation.

Noxsd:string

Properties included in theoperation.

Noxsd:StringArray

Properties excluded from theoperation.

Noxsd:StringArray

Output (getGenerationInfoReturn)



Array of generationinformation.

Yestypes:GenerationInfoArraygenerationArray

Examples

This code sample returns information about assets generated from a specific asset. It does not retrieve information about stepsused 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.



Parameters

Input (getGroupMembersParam)



The handle to the group.xsd:stringgroupHandle

Output (getGroupMembersReturn)


An array of user handles.Yestype:HandleArrayuserHandleArray


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|[email protected]</items> </userHandleArray></getGroupMembersReturn>

getGroupMembership

Returns the members of a group.



Parameters

Input (getGroupMembershipParam)


The handle to the user.Noxsd:stringuserHandle

The handle to the company.Noxsd:stringcompanyHandle

Output (getGroupMembershipReturn)


Array of groups.Yestypes:GroupArraygroupArray

Examples

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

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


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.



Parameters

Input (getGroupsParam)



Output (getGroupsReturn)


Array of groups.Yestypes:GroupArraygroupArray

Examples

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

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.



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

Parameters

Input (getImageFormatsParam)


The handle to the companywith the image formats youwant to obtain.


Output (getImageFormatsParam)


The image format array.Yestypes:ImageFormatArrayimageFormatArray

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.




Parameters

Input (getImageRenderingPublishSettingsParam)


The handle to the companywhose image rendering


publishing settings you wish toget.

Handle to the publish context.Yesxsd:stringcontextHandle

Output (getImageRenderingPublishSettingsReturn)


Image rendering publishingsettings.

Yestype:ConfigSettingArraypublishSettingsArray

getImageServingPublishSettings

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



Parameters

Input (getImageServingPublishSettingsParam)


The handle to the companywith the image serving publishsettings.


Handle to the publish context.Yesxsd:stringcontextHandle

Output


Array of image server publishsettings.

Yesxsd:stringpublishSettingArray

getImageSetMembers

Gets an array of members that are in an image set.



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

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

Parameters

Input (getImageSetMembersParam)


The handle to the companythat contains the image set.


The image set asset handle.Yesxsd:stringassetHandle

Output (getImageSetMembersReturn)


Array of image set members.Notypes:ImageSetMemberArraymemberArray

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.


• IpsUser• IpsAdmin


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

Parameters

Input (getJobLogsParam)


The company handle.Noxsd:stringcompanyHandle

Gets logs for jobs submitted bya specific user.


Lets you select sort fields.Noxsd:stringsortBy

Sort order (ascending ordescending).

Noxsd:stringsortDirection

The date and time of the startof the job log. Provide the time

Noxsd:dateTimestartDate

zone with the request for thisfield.

The date and time of the endof the job log. Provide the time

Noxsd:dateTimeendDate

zone with the request for thisfield.

Maximum number of rows toreturn.

Noxsd:intnumRows

Output (getJobLogsReturn)


Array of job logs.Yestypes: JobLogArrayjobLogArray

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 companyand user.

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


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>[email protected]</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.


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

Parameters

Input (getJobLogDetailsParam)


The handle to the company towhich the job log belongs.


A handle to an active orcompleted job.

Noxsd:stringjobHandle

Original name of the job log.Noxsd:stringoriginalName

One or more Log Typeconstants. If present, only the

Notypes:StringArraylogTypeArray

specified log types will be



returned. By default, all logtypes are returned.

Maximum number ofdetailArray items to return.

Noxsd:intrecordsPerPage

The maximum and defaultvalue is 1000.

Page number ofrecordsPerPage-results toreturn. The default value is 1.

Noxsd:intresultsPage

One of the Job Detail Sort Fieldconstant values (Date or

Noxsd:stringsortBy

LogType). The default value isDate.

One of the Sort Directionstring constants. The defaultvalue is ascending.


Output (getJobLogDetailsReturn)


Array of job logs.Yestypes:JobLogArrayjobLogArray

Examples

This code sample returns all the job log details for a specific company. The first array contains standard job log details. Anembedded 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>[email protected]</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> <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.



Parameters

Input (getMetadataFieldsParam)


The company handle.Yesxsd:stringcompanyHandle

Asset types from which toobtain metadata.

Yesxsd:stringassetType

Output (getMetadataFieldsParam)


Examples

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


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.


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

Note: Requires read access to the asset.

Parameters

Input (getOriginalFilePathsParam)



Array of handles to assetswhose original file path youwant to obtain.


Output (getOriginalFilePathsReturn)


The array of strings thatrepresent the original filepaths.

Yestypes:StringArrayoriginalFileArray


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.


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

Parameters

Input (getPhotoshopPathParam)


Handle to the company withthe image you want to workwith.


Handle to the image asset.Yesxsd:stringassetHandle

Name of the Photoshop pathyou want to return.

Yesxsd:stringpathName

Output (getPhotoshopPathReturn)



Returns image coordinatesbased on the path. SeePerspectiveQuad.

Yestypes:PerspectiveQuadperspectiveQuad

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.


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

Parameters

Input (getPhotoshopPathNamesParam)


Handle to the company that containsthe image you want to work with.


Handle to the image asset.Yesxsd:stringassetHandle

Output (getPhotoshopPathNamesReturn)



An array of Photoshop pathnames in an image.

Yestypes:StringArraypathNameArray

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.


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

Parameters

Input (getProjectsParam)



Output (getProjectsReturn)


The array of projectsassociated with the company.

Yestypes:ProjectArrayprojectArray

Examples

This code sample returns all project handles in a project array.


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.



Parameters

Input (getPropertyParam)


The name of the property toget.

Yesxsd:stringname


Output (getPropertyReturn)


The property value.Yesxsd:stringvalue

Examples

This code sample uses an IPS Properties string constant to return a specific value. In this example, the IPS property is the versionof 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.



Parameters

Input (getPropertySetsParam)


The handle to the property settype.


The primary owner of the databound to the database object.

Yesxsd:stringprimaryOwnerHandle

An optional secondary ownerof the data.

Noxsd:stringsecondaryOwnerHandle

Output (getPropertySetsReturn)



Arry of property sets.Yestypes:PropertySetArraysetArray

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|[email protected]</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 thehandle to the type as well as the property type.




Parameters

Input (getPropertySetTypeParam)


The handle to the company.Optional because a property


set type can belong to multiplecompanies.

Property set type name.Yesxsd:stringname

Output (getPropertySetTypeReturn)


The type structure thatcontains a:

Yestypes:PropertySetTypetype

• Handle.• Type name.• Property type.• Value that indicates if the

type allows multiple propertytypes.

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.


• IpsUser• IpsAdmin• IpsCompanyAdmin• TrialSiteAdmin


• TrialSiteUser• ImagePortalAdmin• ImagePortalUser• ImagePortalContrib• ImagePortalContribUser

Parameters

Input (getPropertySetTypesParam)


The handle to the companythat the property set types areassociated with.

Omit if you want to returnglobal property set types.


Output (getPropertySetTypesReturn)


An array of property set typesassociated with the specified

Yestypes:PropertySetTypeArraytypeArray

company, or the globalproperty set types if nocompany 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>


getPublishContexts



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

Parameters

Input (getPublishContextsParam)



The type of publish contextyou want to return. Includes:

Noxsd:stringcontextType

• ImageServing• ImageRendering• Video• ServerDirectory

Output (getPublishContextsReturn)


An array of publish contextsfor a company, filtered bycontext type if required.

Yestypes:PublishContextArraypublishContextArray

Examples

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


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.



Parameters

Input (getScheduledJobsParam)



Job handle.Noxsd:stringjobHandle

The name specified bysubmitJob.

Noxsd:stringoriginalName

Output (getScheduledJobsReturn)



Array of scheduled jobs.Yestypes:ScheduledJobArrayjobArray

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>[email protected]</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 aboutthe asset.



Parameters

Input (getSearchStringsParam)



Handle to the asset.Yesxsd:stringassetHandle

Output (getSearchStringsReturn)



An array of asset searchstrings.

Yestypes:SearchStringssearchStringArray

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.


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

Parameters

Input (getSystemPropertiesParam)

None.

Output (getSystemPropertiesReturn)


An array of system properties.Yestypes:PropertyArraypropertyArray

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"/>


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.



Parameters

Input (getTagFieldValuesReturn)




An array of field handles to tagvalues you want returned.

Yestypes:HandleArrayfieldHandleArray

Output (getTagFieldValuesReturn)


An array of the tag values inthe dictionary for eachrequested field.

Yestypes:TagFieldValuesArrayfieldArray


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.



Parameters

Input (getUniqueMetadataValuesParam)



Handle to metadata field.Noxsd:stringfieldHandle

Output (getUniqueMetadataValuesReturn)



type:StringArrayvalues

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.



Parameters

Input (getUserCharsParam)


Determines the Trash State tosearch for.

Yesxsd:stringcharField

Include or exclude inactiveusers. Non-IPS Admin users

Yesxsd:booleanincludeInactive

must be an active member ofat least one company to beauthorized to make any APIcalls. An authorization faultwill be returned if the user hasno active companymemberships.

Include or exclude invalidusers.

Noxsd:booleanincludInvalid



Filter results based oncompany.

Notypes:HandleArraycompanyHandleArray

Filters results based on groups.Notypes:HandleArraygroupHandleArray

Filters results based on userrole.

Notypes:StringArrayuserRoleArray

Enable >1 character.Noxsd:intnumChars

Output (getUserCharsReturn)


An array of character prefixes.Yestypes:StringArrayuserCharsArray

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.


• IpsUser• IpsAdmin• IpsCompanyAdmin• TrialSiteAdmin


• TrialSiteUser• ImagePortalAdmin• ImagePortalUser• ImagePortalContrib• ImagePortalContribUser

Parameters

Input (getUserInfoParam)


Handle to the user whoseinformation you want toreturn.


User email address.Noxsd:stringemail

Output (getUserInfoReturn)


The first name, last name,email address, and role of a

Yestypes:UseruserInfo

user, as well as whether theuser is valid and when theuser’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|[email protected]</ns1:userHandle> <ns1:firstName>FirstName</ns1:firstName> <ns1:lastName>LastName</ns1:lastName> <ns1:email>[email protected]</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 andfilter by character.





Include or exclude inactiveusers. Non-IPS Admin users

Noxsd:booleanincludeInactive

must be an active member ofat least one company to beauthorized to make any APIcalls. An authorization faultwill be returned if the user hasno active companymemberships.

Lets you include/excludeinvalid users.

Noxsd:booleanincludeInvalid

Filter results by company.Notypes:HandleArraycompanyHandleArray

Filter results by group.Notypes:HandleArraygroupHandleArray

Filter results by user role.Notypes:StringArrayuserRoleArray

Filter results by field's stringprefix (see Trash State).

Noxsd:stringcharFilterField

Filter results by a specificcharacter.

Noxsd:stringcharFilter

Choice of user sort fields.Noxsd:stringsortBy

Returns specified number ofrecords per page.


Results page.Noxsd:intresultsPage

Output (getUsersReturn)


An array of users.Yestypes:UserArrayuserArray

Examples

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

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


<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|[email protected]</userHandle> <firstName>Kris</firstName> <lastName>Magnusson</lastName> <email>[email protected]</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.



Parameters

Input (getViewerConfigSettingsParam)



Handle to the asset.Yesxsd:stringassetHandle

Output (getViewerCoinfigSettingsReturn)


Viewer type to which theconfiguration settings apply.

Yesxsd:stringtype

Array of viewer configurationsettings.

Yestypes:ConfigSettingsArrayconfigSettingsArray


getVignettePublishFormats

Authorizied User Types


Parameters

Input (getVignettePublishFormatsParam)



Output (getVignettePublishFormatsReturn)


Array of vignette publishformats.

Yestypes:VignettePublishFormatArrayvignetteFormatArray

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.




• IpsCompanyAdmin• ImagePortalAdmin• ImagePortalUser• ImagePortalContrib• ImagePortalContribUser

Parameters

Input (getXMPPacketParam


The company handle with thepacket you want to return (e.g.,c|656).


The asset for which the XMPpacket should be retrieved.


Output (getXMPPacketReturn)


zlib-compressed XMP packet.Yesxsd:Base 64 binarycompressedPacket

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.




Parameters

Input (getZipEntriesParam)


The handle to the companythat contains the Zip file.


Handle to the Zip file.Yesxsd:stringassetHandle

Output (getZipEntriesReturn)


Array of entries in a Zip file.Yestypes:ZipEntryArrayzipArray

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.




Parameters

Input (moveAssetParam)



Handle to the asset you wantto move.


Handle to the destinationfolder.


Output (moveAssetReturn)


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 theassetMoveArray. Each AssetMove field contains a destination folder.




Parameters

Input (moveAssetsReturn)


The handle to the companywith assets to be moved.


An asset move array. Itcontains an asset and an assetdestination folder.

Yestypes:AssetMoveArrayassetMoveArray

Output (moveAssetsReturn)


Successfully moved assetcount.


Count of assets that generatedwarnings when the operationattempted to move them.


Count of assets that generatederrors when the operationattempted to move them.


AssetOperationFaultsthatcontain the:


• Assets that threw thewarnings.

• Warning codes.• Reason for the warning.

AssetOperationFaultsthatcontain 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 andits 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>


</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.



Parameters

Input (moveFolderParam)



Folder handle.Yesxsd:stringfolderHandle

Handle to the destinationfolder.

Yesxsd:stringdestFolderHandle

Output (moveFolderReturn)


Handle to the moved folder.Yesxsd:stringfolderHandle

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>


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

pauseJob

Pauses an active job.



Parameters

Input (pauseJobParam)



Handle to the job you want topause.

Yesxsd:stringjobHandle

Output (PauseJobReturn)


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.




Parameters

Input (removeAssetPermissionsParam)



The handle to the asset withpermissions you want toremove.


Output (removeAssetPermissionsReturn)


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.



Parameters

Input (removeCompanyMembershipParam)



The handle to the user with themembership you want toremove.


The handle to the companythat you're removing the userfrom.

Yestypes:HandleArraycompanyHandleArray

Output (removeCompanyMembershipReturn)


Examples

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

Request<ns1:removeCompanyMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd"> <ns1:userHandle>621|[email protected]</ns1:userHandle> <ns1:companyHandleArray> <ns1:items>47</ns1:items> </ns1:companyHandleArray></ns1:removeCompanyMembershipParam>

Response

None.

removeFolderPermissions

Removes folder permissions.



Parameters

Input (removeFolderPermissionsParam)


The handle to the companywith folders with permissionsyou want to remove.


Handle to the folder.Yesxsd:stringfolderHandle



When true:Yesxsd:booleanupdateChildren

• Permissions removalpropagates through all of thefolder permission operations.

When false:

• The operation affects thespecified folder only.

Output (removeFolderPermissionsReturn)


Examples

This code sample removes permissions from a folder and its sub-folders. Set updateChildren to false if you need to removepermissions 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.



Parameters

Input (removeGroupMembersParam)



The handle to the companywith the users you want towork with.


Group handle.Yesxsd:stringgroupHandle

An array of handles for userswhose group memberships youwant to remove.


Output (removeGroupMembersParam)


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|[email protected]</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.



Parameters

Input (removeGroupMembershipParam)



The handle to the companywhose group membership youwant to remove.


The array of handles to groupsfrom which you want thecompany to be removed.

Yestypes:HandleArraygroupHandleArray

Output (removeGroupMembershipReturn)


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.


• IpsUser• IpsCompanyAdmin• ImagePortalAdmin• ImagePortalContrib• ImagePortalContribUser

Parameters

Input (removeProjectAssetsParam)


The handle to the companywith the assets you want tomove.


The handle to the projectassets you want to move.




Array of handles to the assetsyou want to move.


Output (removeProjectAssetsReturn)


Successfully removed assetcount.




attempted to remove assetsfrom the project.



attempted to remove assetsfrom the project.



warnings when the operationattempted to remove themfrom the project.



errors when the operationattempted to remove themfrom 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.


Note: The renameFiles parameter has been deprecated for prior releases and removed from renameAsset. The virtualfile 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.


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


Parameters

Input (renameAssetParam)


The handle to the company towhich the asset belongs.


The handle to the asset youwant to rename.


Asset's new name.Yesxsd:stringnewName

If the validateName is trueand the asset type requires a

Yesxsd:booleanvalidateName

unique IPS ID, then the newname is checked for globaluniqueness and renameAssetthrows a fault if it is notunique.

Output (renameAssetReturn)

The IPS API does not return a response for this operation. See the description of the <ns1:validateName> element for caveatsabout 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>


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

Response

None.

renameFolder

Renames a folder.




Parameters

Input (renameFolderParam)


Handle to the company withfolders you want to rename.


Handle to the folder.Yesxsd:stringfolderHandle

New folder name.Yesxsd:stringfolderName

Output (renameFolderReturn)


Handle to the renamed folder.Yesxsd:stringfolderHandle

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>


renameProject

Renames a project.



Parameters

Input (renameProjectParam)


Handle to the company withthe project you want torename.


Handle to the project.Yesxsd:stringprojectHandle

New project name.Yesxsd:stringprojectName

Output (renameProjectParam)


The handle of the renamedproject.


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.




Parameters

Input (replaceImageParam)


The handle to the companywith the image you want toreplace.


The handle to the asset youwant to replace.


Image Server commands thatgenerate new image data.


Output (replaceImageReturn)


Handle to the new asset.Yesxsd:stringassetHandle

Examples

This code sample replaces an image and and applies a urlModifier with a command that specifies that the Image Server willtake 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.


• IpsUser


• IpsAdmin• IpsCompanyAdmin• ImagePortalAdmin• ImagePortalContrib• ImagePortalContribUser

Parameters

Input (restoreAssetsFromTrashParam)


The handle to a company withthe assets you want to restore.


Array of handles for the assetsyou want to restore.


Output (restoreAssetsFromTrashReturn)


Number of assets successfullyremoved from the trash.


Number of warnings generatedwhen the operation attemptedto restore assets from the trash.


Number of errors generatedwhen attempting to restoreassets from the trash.




warnings when the operationattempted to restore assetsfrom the trash.



errors when the operationattempted to restore assetsfrom 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>


<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.



Parameters

Input (resumeJobParam)


The handle to the companywith the job you want torestart.


The handle to the paused job.Yesxsd:stringjobHandle

Output (resumeJobReturn)


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.


saveGroup

Create or edit a group.



Parameters

Input (saveGroupParam)


The handle to the companywith the group you want tosave.


The handle to the group.Noxsd:stringgroupHandle

Group name.Yesxsd:stringname

false is default.Yesxsd:booleanisSystemDefined

Output (saveGroupReturn)



Examples

This code sample creates a group that belongs to a specific company. If the group already exists, it is saved with the parametervalues 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 &. Get the urlModfiervalue from the IPS user interface.




Parameters

Input (saveImageFormatParam)


The handle to the companywith the image format youwant to work with.


Image format handle you wantto save.

Noxsd:stringimageFormatHandle

Image format name.Yesxsd:stringname

This can be any IPS protocolquery string. The easiest way


to generate a URL modifier isto create one with the IPS userinterface and then cut andpaste the query string.

Output (saveImageFormatReturn)


Handle to the image format.Yesxsd:stringimageFormatHandle

Examples

This code sample creates an image format. In this example, urlModifier was determined by its value in the IPS user interfacewith 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&hei=400&fmt=jpeg&qlt=750&op_sharpen=0& resMode=bicub&op_usm=0.0,0.0,0,0&iccEmbed=0 </urlModifier></saveImageFormatParam>

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


saveImageMap

Create a new image map or edit an existing map.




Parameters

Input (saveImageMapParam)


The handle to the companywith the image map you wantto save.


The handle to the image assetto which the image mapbelongs.


The handle to the image map.Creates an image map ifNULL.

Noxsd:stringimageMapHandle

The name of the image mapthat is created or saved.

Yesxsd:stringname

Choice of Region Shape.Yesxsd:stringshapeType

A comma-delimited list ofpoints that define the region.

Yesxsd:stringregion

The href value associatedwith the image map asspecified in the IPS interface.

Yesxsd:stringaction

To obtain the href value, clickthe image in the IPS interface,copy and paste the URL intothis element, and then formatthe IPS URL as a proper URL.



For example, & becomes&.

The order in the list of imagemaps (the Z axis).

Yesxsd:intposition

Yesxsd:booleanenabled

Output (saveImageMapReturn)


The handle to the new oredited image map.

Yesxsd:stringimageMapHandle

Examples

This code sample creates a new image map for an asset. It uses a shape type determined by a region shape string constant andreturns 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& iRow=1&iRows=1&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.



Parameters

Input (saveMetadataFieldParam)




Field handle.Noxsd:stringfieldHandle

Choice of asset types fromwhich to save metadata.

Yesxsd:stringassetType

Field name.Yesxsd:stringname

Choice of metadata field types.Yesxsd:stringfieldType

Default value of the fields forall assets.

Yesxsd:stringdefaultValue







Output (saveMetadataFieldReturn)


Handle of the new metadatafield.


Examples

This code sample creates a new metadata field constrained by the Asset Type and Metadata Field Types string constants. If thefieldHandle element has a valid field handle value, it changes the metadata values and gets the same field handle that youspecified 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>


saveZoomTarget

Create or edit a zoom target.

Authorized User Type


Parameters

Input (saveZoomTargetParam)


The handle to the companywith the zoom target you wantto save.


The handle to the zoom target.Yesxsd:stringassetHandle

Edits or creates a zoom target.Noxsd:stringzoomTargetHandle

Zoom target name.Yesxsd:stringname

Left pixel location.Yesxsd:intxPosition

Top pixel location.Yesxsd:intyPosition

Zoom target width.Yesxsd:intwidth

Zoom target height.Yesxsd:intheight

For customer-specificinformation. Can contain anytype of data.

Yesxsd:stringuserData

Output (saveZoomTargetReturn)


Handle to the newly createdzoom target.

Yesxsd:stringzoomTargetHandle

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>


<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 thefolder 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 subsetof the totalRows, name, handle, type, and subType fields. To return larger sets, set up paging with the resultPageparameter.

Limit Result File Size with responseFieldArray or excludeFieldArray

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


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

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

Parameters

Input (searchAssetsParam)


DescriptionRequired?TypeName

The handle to the company with the assetsyou want to search.


Lets administrators work as a different user.Noxsd:stringaccessUserHandle

Lets administrators work as part of adifferent group.


The root path for searching for assets. Ifomitted, the company root folder is used.

Noxsd:stringfolder

Set to true to search subfolders.Noxsd:booleanincludeSubfolders

Publish state choice.Noxsd:stringpublishState

Trash state choice. Default is NotInTrash.Noxsd:stringtrashState

Choice of Search Match Modes forcombining results of keywordArray,

Noxsd:stringconditionMatchMode

conditionMatchMode

systemFieldConditionArray, andmetadataConditionArray. Default isMatchAll.

Notypes:StringArraykeywordArray

Note: Deprecated parameter. It isadvised that you do not use it.

A string array of keywords to match.

Choice of Search Match Modes forcombining systemFieldConditionmatches. Default is MatchAll

Noxsd:stringsystemFieldMatchMode

.

The array of system field conditions.Notypes:SystemFieldConditionArraysystemFieldConditionArray

Search Match Modes string constants. Thedefault is MatchAll.

Noxsd:stringtagMatchMode

An array of tag field search predicates.Notypes:TagConditionArraytagConditionArray

Predicates are combined according to thetagMatchMode setting, and then combinedwith any terms in keywordArray,systemFieldConditionArray, andmetadataConditionArray according tothe conditionMatchMode setting.



Search Match Modes for combiningmetadataCondition matches. Default isMatchAll.

Noxsd:stringmetadataMatchMode

The array of metadata field searchconditions.

Notypes:MetadataConditionArray

metadataConditionArray

Array of Asset Types to include in search.Notypes:StringArrayassetTypeArray

Array of Asset Types to exclude from search.Notypes:StringArrayexcludeAssetTypeArray

A list of sub type names to filter against.Notypes:StringArrayassetSubTypeArray

If true and assetSubTypeArray is notempty, only assets whose sub types are in

Noxsd:booleanstrictSubTypeCheck

assetSubTypeArray are returned. Iffalse (default), then assets with no definedsub type are returned.

If true, byproduct assets generated duringingestion of a master asset, such as ripped

Noxsd:booleanexcludeByproducts

PDF page images, are excluded from searchresults. Default is false.

Array of byproduct asset generationconditions to exclude from search results. If

Notypes:ExcludeByproductArray

excludByproductArray

present, this parameter overrides theexcludeByproducts setting.

Handle of a project containing the assets tosearch.

Noxsd:stingprojectHandle

Maximum number of results to return.Noxsd:intrecordsPerPage

Specifies the page of results to return, basedon recordsPerPage page size.


Choice of asset sort fields.Noxsd:stringsortBy

Choice of sort direction.Noxsd:stringsortDirection

Contains a list of fields and subfields forinclusion in the response.


Contains a list of fields and subfields forexclusion from the response.


Output (searchAssetsReturn)



Number of rows a searchreturns when records per pageare not limited.

Noxsd:inttotalRows

Assets that the search returns.Notypes:AssetArrayassetArray

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 theyare 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 exampleto 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>




Parameters

Input (searchAssetsByMetadataParam)



Filters that help you definesearch criteria.

Notype:SearchFilterFilter

See SearchFilter.

Conditions that define searchcriteria. See below foradditional information.

Notype:MetadataConditionArraymetadataConditionArray

Additional fields you want tohave populated on the

Notype:StringArrayresponseMetadataArray

response in the asset summary.The fields must be specified inthe normalized format.

The number of assets returnedby the response. The defaultvalue is 1000.


Specifies the page of results toreturn, based onrecordsPerPage page size.


Sort by selected asset field.Noxsd:stringsortBy

Choice of sort direction.Ascending is default.


Output (searchAssetsByMetadataReturn)



Number of matches.Noxsd:inttotalRows

Array of assets returned by thesearch.


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:


• 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>[email protected]</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>[email protected]</createUser> <lastModified>2009-11-19T07:21:25.487-08:00</lastModified> <lastModifyUser>[email protected]</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>


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.



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

Parameters

Input (setAssetsContextStateParam)



An array of assets and theirnew publish states.

Yestypes:AssetsContextStateUpdateArrayassetsContextHandle

Output (setAssetsContexStateReturn)


The number of assetssuccessfully changed.


The number of warningsgenerated when the operationattempted to modify assets.


The number of errorsgenerated when the operationattempted to modify assets.


Array of errors generated byassets when the operationattempted to modify them.


Examples

This code sample sets the publication state of an asset using NotMarkedForPublish.


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.




• IpsCompanyAdmin• ImagePortalAdmin• ImagePortalContrib• ImagePortalContribUser

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

Parameters

Input (setAssetMetadataParam)


The handle to the companywith the asset you want toupdate.


The handle to the asset.Yesxsd:stringassetHandle

Updates in a metadata updatearray.

Yestypes:MetadataUpdateArrayupdateArray

Output (setAssetMetadataReturn)


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 thepermissions of its parent unless you call removeAssetPermissions.





Parameters

Input (setAssetPermissonsParam)


The handle to the companythat contains the folder youwant to work with.


Folder handle.Yesxsd:stringassetHandle

Permissions array.Yestypes:PermissionsUpdateArraypermissionArray

Output (setAssetPermissonsReturn)


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.


• IpsUser• IpsAdmin• IpsCompanyAdmin• ImagePortalContrib• ImagePortalContribUser



Parameters

Input (setAssetPublishStateParam)




Available states:Yesxsd:stringpublishState

• MarkedForPublish• NotMarkedForPublish

contextHandleArray

Output


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.




Parameters

Input (setAssetsPublishStateParam)



Company handle.Yesxsd:stringcompanyHandle

Array of publish state valuesfor the assets.

Yestypes:PublishStateUpdateArraypublishStateUpdateArray

Output (setAssetsPublishStateParam)


The number of successfullyupdated assets.


The number of assets thatgenerated a warning when theoperation tried to update them.


The number of assets thatgenerated an error when theoperation tried to delete them.


Details associated with theasset updates that generated awarning.


Details associated with theasset updates that generated anerror.


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>


setAssetSetDefinition

Updates the set definition for an existing Asset Set.



Parameters

Input (setAssetDefinitionParam)


The handle to the companywith the asset set.


Asset set handleYesxsd:stringassetHandle

Definition string. See below.Yesxsd:stringsetDefinition

Output (setAssetSetDefinitionReturn)


setDefinition Parameter: About

setDefinition Functions

Specify setDefinition substitution functions in-line. These are resolved during a catalog lookup or on publication. Substitutionstrings 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 stringgets copied to the output string during resolution.

Returns the Asset'sSubstitution Function

Master file path.getFilePath([asset_handle])

Catalog ID.getCatalogd([asset_handle])

Metadata value.getMetaData([asset_handle],[metadata_field_handle])


Returns the Asset'sSubstitution Function

Catalog ID. Applies to image-based assets (Image, AdjustedView, Layer View).

For other assets, returns the thumb asset's catalog ID (if any).If no thumb asset is associated with the asset, the functionreturns an empty string.

getThumbCatalogId([asset_handle])

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.



Parameters

Input (setCompanyMembershipParam)


User handle.Noxsd:stinguserHandle



Array of companies.Yestypes:CompanyMembershipUpdateArraymembershipArray

Output (setCompanyMembershipParam)


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|[email protected]</ns1:userHandle> <ns1:companyHandleArray> <ns1:items>137</ns1:items> </ns1:companyHandleArray></ns1:setCompanyMembershipParam>

Response

None.

setCompanySettings

Sets various company-specific configuration values.



Parameters

Input (setCompanySettingsParam)



Asset overwrite mode.Noxsd:stringoverwriteMode

Set to true to preserve thepublish state when an asset isre-uploaded.

Noxsd:booleanretainPublishState

IccProfile asset to use asdefault source color profile.

Noxsd:stringdefaultSourceProfileHandle

IccProfile asset to use asdefault display color profile.

Noxsd:stringdefaultDisplayProfileHandle



XSL asset used for mappingIPTC and EXIF metadata toIPS metadata fields.

Noxsd:stringiptcExifMappingXsltHandle

XSL asset used to map XMPmetadata to IPS metadatafields.

Noxsd:stringxmpMappingXsltHandle

Minimum free disk space (inKB) available before a warningmessage is sent.

Noxsd:intdiskSpaceWarningMin

Set to true to send companyadministrators a notification

Noxsd:booleanemailTrashCleanupWarning

whenever assets are emptiedfrom trash.

Output (setCompanySettingsReturn)


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.



Parameters

Input (setFolderPermissionsParam)





Sets permissions on childrenthat belong to the folder.

Yesxsd:booleansetChildren

Permissions array.Yestypes:PermissionUpdateArraypermissionArray

Output (setFolderPermissionsReturn)


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 anyof the users in the user handle array do not belong to the company specified in the company handle,



Parameters

Input (setGroupMembersParam)






Array of handles for userswhose group membership youwant to set.


Output (setGroupMembesReturn)


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|[email protected]</ns1:items> </ns1:userHandleArray></ns1:setGroupMembersParam>

Response

None.

setGroupMembership

Sets group membership for a user.



Parameters

Input (setGroupMembershipParam)


The handle to the user whosegroup membership you wantto set.


Company handle.Noxsd:stringcompanyHandle

The array of handles to groupsto which the user to belongs.

Yestypes:HandleArraygroupHandleArray

Output (setGroupMembershipReturn)



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|[email protected]</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 thesecond image map overlays the first, the third overlays the second, and so on.



Parameters

Input (setImageMapsParam)




Array of predefined imagemaps.

Yestypes:ImageMapDefinitionArrayimageMapArray

Output (setImageMapsReturn)


An array with image maphandles applied to the asset.

Yestypes:HandleArrayimageMapHandleArray

Examples

This code sample sets 2 image maps for an image asset. The code specifies shape type, region, and action taken when the imagemaps are invoked. The response contains an array with handles to the image maps.


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.



Note: The user must have read and write access to the image set asset and read access to each member asset.

Parameters

Input (setImageSetMembersParam)



Image set handle.Yesxsd:stringassetHandle

Array of asset members thatbelong to the image set.

Yestypes:ImageSetMemberUpdateArraymemberArray

Output (setImageSetMembersReturn)



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)



For Scene 7 developers only.Yestypes:ConfigSettingArraypublishSettingsArray

Handle to the publish context.Noxsd:stringcontextHandle

setImageServingPublishSettings

For Scene 7 developers only. Refer to the Image Rendering Material Catalog Reference–Catalog Attributes section.

Parameters

Input


Company handle.Yesxsd:stringCompanyHandle

For Scene 7 developers only.Yestypes:ConfigSettingArraypublishSettingsArray

Handle to the publish context.Noxsd:stringcontextHandle

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.


Authorized User types

Note: Only the IpsAdmin user type is authorized to run setPassword calls against other users.

• IpsAdmin

• IpsCompanyAdmin

• IpsUser

• TrialSiteAdmin

• TrialSiteUser




• ImagePortalUser

Parameters

Input (setPasswordParam)


User handle.Noxsd:stringuserHandle

Password.Yesxsd:stringpassword

The following requirements are enforced on thechosen 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 soforth.

• Special symbol characters. For example, youcan use any of the following: ` ~ ! @ # $% ^ * ( ) _ + - = { } | [ ] & \ :

" ; ' < > ? , . /



Determines password expiration date.Noxsd:dateTimepasswordExpires

Note: Provide the time zone with therequest for this field. Time zones areadjusted to Central Time.

Output (setPasswordReturn)


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|[email protected]</ns1:userHandle> <ns1:password>@Do6e$ySt3mz</ns1:password></ns1:setPasswordParam>

Response

None.

setProjectAssets

Assign or update assets in a project.



Parameters

Input (setProjectAssetsParam)


Company handle.Yesxsd:stringcompanyName

Project handle.Yesxsd:stringprojectHandle

The array of asset handles youwant to associate with theproject.



Output (setProjectAssetsReturn)


The number of successfullyadded 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.



Parameters

Input



Tag field handle.Yesxsd:stringfieldHandle

An array of tag values thatreplace the field's existing

Yestypes:StringArrayvalueArray

dictionary. Asset associationsare maintained when a newvalue matches an existingvalue.

Output (setTagFieldValuesReturn)



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 representationof the asset without destroying it.

For Image Serving, commands in the urlModifier parameter are published in the Modifier catalog field and applied prior toany commands specified on the request URL. Commands in urlPostApplyModifier will be published to the PostModifiercatalog field and will override any commands on the request URL or in urlModifier. For Image Rendering, the commandsin urlModifier and urlPostApplyModifier are concatenated and published to the Modifier catalog field.



Parameters

Input (setUrlModifierParam)




Image Serving or ImageRendering protocol commands

Noxsd:stringurlModifier

to apply prior to request orurlPostApplyModifier

commands.



Image Serving or ImageRendering protocol commands


to apply after urlModifierand request commands.

Output (setUrlModifierReturn)


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.)



Parameters

Input (setUserInfoParam)


User handle.Noxsd:stringuserHandle

First name.Yesxsd:stringfirstName

Last name.Yesxsd:stringlastName

User email.Yesxsd:stringemail

Sets the role for a user in eachcompany they belong to. Note,

Yesxsd:stringdefaultRole

however, the IpsAdmin roleoverrides other per-companysettings.



Set's password expiration date.Noxsd:dateTimepasswordExpires

Determines if user is a validIPS user.

Yesxsd:booleanisValid

An array of company handles.Yestypes:CompanyMembershipUpdateArraymembershipArray

Output (setUserInfoReturn)


Examples

Request<setUserInfoParam xmlns="http://www.scene7.com/IpsApi/xsd"> <firstName>test</firstName> <lastName>test</lastName> <email>[email protected]</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.



Parameters

Input (setViewerConfigSettingsParam)




Asset name.Yesxsd:stringname

The type of asset you want toapply the viewer configurationto.

Yesxsd:stringtype



The array ofConfigSettings applied tothe asset..

Yestypes:ConfigSettingArrayconfigSettingArray

Output (setViewerConfigSettingsParam)


setZoomTargets

Sets the zoom target associated with an asset image. It overwrites existing zoom targets.

Authorizied User Types


Parameters

Input (setZoomTargetsParam)



Asset with the zoom target youwant to set.


Array of zoom targetdefinitions.

Yestypes:ZoomTargetDefinitionArrayzoomTargetArray

Output (setZoomTargetsReturn)


The set of handles to the zoomtargets created by thisoperation.

Yestypes:HandleArrayzoomTargetHandleArray

Examples

This code sample defines an array of zoom targets by name, position (x and y axis), width, height, and assigns the array to anasset. 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>


<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.



Parameters

Input (stopJobParam)



Handle to the job you want tostop.

Yesxsd:stringjobHandle

Output (stopJobReturn0



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.


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

Parameters

Input (submitJobParam)



Handle to the user whosubmitted the job.


Note: The system sendsemail to the userspecified byuserHandle. IfuserHandle is notprovided, the person whosubmitted the jobreceives the emails.

Job name.Yesxsd:stringjobName



The locale used for job logdetails and email localization.

Noxsd:stringlocale

Locales are specified as<language_code> and[<country_code>], wherethe language code is alower-case, two- letter code asspecified by ISO-639, and theoptional country code is anupper-case, two-letter code asspecified by ISO-3166. Forexample, the locale string forEnglish (United States) wouldbe: en-US.

Date and time to run the job.Noxsd:dateTimeexecTime

Note: Provide the timezone with the request.Time zones are adjustedto the time zone of thetarget IPS server.

Determines when to run thejob.

Noxsd:stringexecSchedule

Can be a cron string that runsthe job on a recurring basis.

The schedule is always relativeto the server’s local time zone.See the IPS documentation forthe custom schedule format.

Job description.Noxsd:stringdescription

Export previously uploadedfiles.

Notypes:ExportJobexportJob

See ExportJob.

Details for an image servingpublish job.

Notypes:ImageServingPublishJobimageServingPublishJob



Details for an image renderingpublish job.

Notypes:ImageRenderingPublishJobimageRenderingPublishJob

Details for an video publishjob.

Notypes:VideoPublishJobvideoPublishJob

See VideoPublishJob.

Details for an server directorypublish job.

Notypes:ServerDirectoryPublishJobserverDirectoryPublishJob

Details for an upload directoryjob.

Notypes:UploadDirectoryJobuploadDirectoryJob

Details for an upload URL job.Notypes:UploadUrlsJobuploadUrlsJob

Notypes:OptimizeImagesJoboptimizeImagesJob

Notypes:RipPdfsJobripPdfsJob

Notypes:ReprocessAssetsJobreprocessAssetsJob

Process an asset list into setsusing Automated Set Scripts.

Notypes:AutomatedSetGenerationJobautomatedSetGenerationJob

SeeAutomatedSetGenerationJob.

Output (submitJobReturn)


Job handle.Yesxsd:stringjobHandle

Examples

This code sample submits an image serving publish job to IPS and returns a job handle. Choose only one type of job in therequest. Because userHandle was omitted, email notifications are sent to the user who submitted the job. This sample job runsimmediately 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>


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 onlyone of the following:

• imageServingPublishJob• imageRenderingPublishJob• videoPublishJob• serverDirectoryPublishJob• uploadDirectoryJob• uploadUrlsJob

updateAssetPermissons

Updates asset permissions.



Parameters

Input (updateAssetPermissionsParam)




Permissions you want to applyto the asset.

Yestypes:PermissionUpdateArrayupdateArray

Output (updateAssetPermissionsReturn)


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>


</ns1:items> </ns1:updateArray></ns1:updateAssetPermissionsParam>

Response

None.

updateAssetSet

Updates an asset set.

Parameters

Input (updateAssetSetParam)


The handle to the companythat contains the image set youwant to modify.


The handle to the image setyou want to modify.


Resets image set members.Noxsd:stringsetDefinition

The handle of the asset thatacts as the thumbnail for theimage set.


Output (updateAssetSetReturn)


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.




Parameters

Input (updateFolderPermissionsParam)




Determines whether to updatechildren with permissions setfor the top-level folder.

Yesxsd:booleanupdateChildren

The array of permissionupdates you want to apply tothe folder.

Yestypes:PermissionUpdateArrayupdateArray

Output (updateFolderPermissionsReturn)


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)



The handle to the companythat contains the image set youwant to modify.


The handle to the image setyou want to modify.

Ysxsd:stringassetHandle

Resets image set members.Notypes:ImageSetMemberUpdateArraymemberArray

The handle of the asset thatacts as the thumbnail for theimage set.


Output (updateImageSetReturn)


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.




Parameters

Input (updateMetadataFieldParam)



Metadata field handle.Yesxsd:stringfieldHandle

Metadata field name.Noxsd:stringname

Metadata field value.Noxsd:stringdefaultValue







Lets you create a set of sharedenumerated values thatselected tags can point to.

Noxsd:stringinitialTagValue

Output (updateMetadataFieldReturn)


Metadata field handle.Yesxsd:stringfieldHandle

Examples

This code sample updates assigns a new name and default value to a metadata field. The response returns a handle to the updatedfield.

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>


updatePropertySet

Uses a property array to update a property set.



Parameters

Input (updatePropertySetParam)


Handle to the property set.Yesxsd:stringsetHandle

Set to true to replaceproperties.

Noxsd:stringreplaceProperties

Array of updated propertiesfor the property set.

Yestypes:PropertyArraypropertyArray

Output (updatePropertySetReturn)


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>


</propertyArray></updatePropertySetParam>

Response

None.

updateTagFieldValues

Updates tag dictionary values for a tag field.



Parameters

Input (updateTagFieldValuesParam)



Tag field handle.Yesxsd:stringfieldHandle

Array of tag field values thatyou want to update.

Yestypes:TagValueUpdateArrayupdateArray

Note: Updates tag stringvalues only. Does notaffect asset associations.

Output (updateTagFieldValuesReturn)


The number of successfullyupdated tag fields.


The number of warningsgenerated when the operationattempted to update tag fields.


The number of errorsgenerated when the operationattempted to update tag fields.



Notypes:TagValueUpdateFaultArraywarningDetailArray

warnings when the operationattempted to update tag fields.




Notypes:TagValueUpdateFaultArrayerrorDetailArray

errors when the operationattempted 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.


• IpsAdmin• IpsCompanyAdmin• TrialSiteAdmin



Parameters

Input (updateViewerConfigSettingsParam)




Array of configuration settingsyou want to apply to theviewer.

Yestypes:ConfigSettingArrayconfigSettingArray

Output (updateViewerConfigSettingsReturn)


updateVignettePublishFormat

Updates the vignette publish format settings.



Parameters

Input (updateVignettePublishFormatParam)



Publish format handle.Yesxsd:stringvignetteFormatHandle

Publish format name.Noxsd:stringname

Specifies the target width of theresulting vignette view in

Yesxsd:inttargetWidth

pixels. Use zero so the outputvignette has the same size asthe master vignette.

Specifies the target height ofthe resulting vignette view in

Yesxsd:inttargetHeight

pixels. Use zero so the outputvignette has the same size asthe master vignette.



Creates a pyramid vignetteoptimized for zooming on the

Yesxsd:booleancreatePyramid

Image Rendering server.Starting at the maximum size,set by the Target Vignette Sizefields, this creates multiple sizeviews in a single vignetteoutput file. Each subsequentview size is halved until thewidth and height are within128x128 pixels.

Specifies the width of eachresulting thumbnail in pixels.

Yesxsd:intthumbWidth

This setting is optional. Leaveas zero for no thumbnail file.

Specifies the file format for thepublished vignettes. Given a

Yesxsd:intsaveAsVersion

new version of ImageAuthoring and an olderversion of the ImageRendering Server, you mustspecify a vignette version thatyour ImageRendering Servercan read. If you specify ahigher version, the ImageRendering server cannot readthe published vignettes. Set tozero to publish vignettes at thelatest version.

Specifies the character thatseparates the vignette name

Yesxsd:stringsizeSuffixSeparator


Applies sharpening to themain view image for each

Noxsd:intsharpen

publish vignette size.Sharpening can compensatefor blurring when the vignettesare scaled.

Digital unsharp masking is aflexible and powerful way to

Yesxsd:doubleusmAmount

increase sharpness, especiallyin scanned images. This



controls the magnitude of eachovershoot (how much darkerand lighter the edge bordersbecome).

Affects the size of the edges tobe enhanced or how wide the

Yesxsd:doubleusmRadius

edge rims become, so a smallerradius enhances smaller-scaledetail. Higher radius values cancause halos at the edges. Finedetail needs a smaller radius astiny detail of the same size orsmaller than the radius is lost.

Controls the minimumbrightness change to be

Yesxsd:intusmThreshold

sharpened or how far apartadjacent tonal values must bebefore the filter works. Thissetting can sharpen morepronouced edges while leavingmore subtle edges untouched.The allowable range ofthreshold is 0 to 255.

Output (updateVignettePublishFormatReturn)


Handle to the updated vignettepublish 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>


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.


• IpsUser• IpsAdmin• IpsCompanyAdmin• ImagePortalAdmin• ImagePortalUser• ImagePortalContrib• ImagePortalcontribUser

Parameters

Input (updateXMPPacketParam)




zlib-compressed XMP packetyou want to set or update.

Yesxsd:Base 64 binarycompressedPacket

Output (updateXMPPacketReturn)


Returns true if the packet wasupdated.

Yesxsd:booleansuccess

Examples

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

<ns:compressedPacket>H4sIAAAAAAAAAAGqAVX+eNqNU9FumzAUfc9XWN5rwTbpUGNBpC3RtpdqU9NOe3XABTRsU9sM8vezMUUp6qQhhDg+955zfX2djXQUneCWgVG00tAxh6xUZ07dv19GEEwh9ncOP3kC/LrQ5KcAxxlGBUwxSEpPtLUm3NyDBeIdIghISkTuKU3qLwfzAQZkunymD8cvs5lDOayt7ShCwzDEwzZWukJkt9sh7ESSyEVE5iItGyNpPniJoHHkptBNZxslgcfsrHqbQ7jxTkG8q5VVplbdYiFNPO0tLpRAC41IjNF1YlksGV2v26mkskC85YJLa1w8CfGLBH3SFZfFJYfbFXFglldKO+bn/ZpqrFv+xsS519WKO1mX9yyoHppveRXrgWTlxX9qJk0ojHG9eaBP3PtKnNaNRNJkq6lNC8bO5sugbVa5/4Hnd05blc9y1zmGCCI0zcO50PyK40+q4LbWPt3IqGmykqnONnVgUUYNvsdfOH6wzN6C03OMd6zQb0KpSh3LPyoIWfgNKX1Vz4i8rx5MSHHyX/D3L1+gMvRUL7NWE+sFH8+TvNxla7tx+8xdjuhqNPERMBaoBAAA=</ns:compressedPacket></ns:updateXMPPacketParam>


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


Data types

AcoInfo

Properties of an ACO asset.

Parameters

DescriptionTypeName

ACO file path.xsd:stringoriginalPath

ACO file name.xsd:stringoriginalFile

ACO file size.xsd:intfileSize

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

DescriptionTypeName

Handle to the company.xsd:stringcompanyHandle

Handle to the job.xsd:stringjobHandle

Unique name for the job.xsd:stringname

Original name of the ActiveJob typesubmitted with the job.

xsd:stringoriginalName

Choice of job types returned by thesystem.

xsd:stringtype

208Data types

DescriptionTypeName

Choice of active job states returned by thesystem.

xsd:stringstate

email address of the user who scheduledthe job.

xsd:stringsubmitUserEmail

The locale for job log details and emaillocalization.

Specify locales as<language_code>[-<country_code>],

xsd:stringlocale

where the language code is a lower-case,two-letter code as specified by ISO-639,and the optional country code is anupper-case, two-letter code as specifiedby ISO-3166. For example, the localestring for English (United States) wouldbe: en-US.

Job description originally specified insubmitJob.

xsd:stringdescription

Name of the server running the job.xsd:stringserverName

Date, time, and time zone for the activejob.

xsd:dateTimestartDate

Total size of the active job.xsd:stringtotalSize

Job progress (i.e., how close the job is tocompletion).

xsd:intprogress

A text message that describes jobprogress.

xsd:intprogressMessage

Date, time, and time zone of the lastprogress update.

xsd:dateTimelastProgressUpdate

Asynchronous task progress information.types:TaskProgressArraytaskProgressArray

Job details for an image serving publishjob.

types:ImageServingPublishJobimageServingPublishJob

Job details for an image rending publishjob.

types:ImageServingRenderJobimageServingRenderJob

Job details for a video publish job.types:VideoPublishJobvideoPublishJob

Job details for a server directory publishjob.

types:ImageServingPublishJobserverDirectoryPublishJob

Job details for an upload URLs job.types:UploadUrlsJobuploadUrlsJob

types:RipPdfsJobripPdfsJob

209Data types

DescriptionTypeName

types:OptimizeImagesJoboptimizeImagesJob

types:ReprocessAssetsJobreprocessAssetsJob

Job detail tracking desktop upload.types:UploadPostJobuploadPostJob

Allow authorized export of previouslyuploaded files. See Export Job.

types:ExportJobexportJob

ActiveJobArray

An array of active jobs.

Parameters

DescriptionTypeName

Array of active jobs.types:ActiveJobitems

AnimatedGifInfo

Properties of an Animated GIF file asset.

Parameters

DescriptionTypeName

Path to the GIF file.xsd:stringoriginalPath

File name.xsd:stringoriginalFile

Path to the IPS-optimized image file.xsd:stringoptimizedPath

The IPS-optimized image file.xsd:stringoptimizedFile

File size.xsd:intfileSize

Asset

An object or container in the folder hierarchy.

210Data types

http://microsite.omniture.com/t2/help/en_US/s7/ips_api/#ExportJob

Parameters

DescriptionTypeName

acoInfo

Details about an animated GIF file.types:AnimatedGifInfoanimatedGifInfo

Asset handle.xsd:stringassetHandle

assetSetInfo

Properties for a cabinet asset type.types:CabinetInfocabinetInfo

Date and time the asset was uploaded.xsd:dateTimecreated

Email address of the user who created theasset.

xsd:stringcreateUser

Details about a CSS file.types:CssInfocssInfo

cuePointInfo

excelInfo

Returns the virtual filename. The fullvirtual file path is folder+fileName.

xsd:stringfileName

flashInfo

Folder that contains an asset.xsd:stringfolder

Handle to the asset's parent folder.xsd:stringfolderHandle

Properties for a font asset.type:fontInfofontInfo

Properties for an ICC profile asset.types:IccProfileInfoiccProfileInfo

illustratorInfo

Properties for an image asset.types:ImageInfoimageInfo

inDesignInfo

Relative URL representing a thumbnailview of the asset.

xsd:stringipsImageUrl

Details about a JavaScript file.types:JavascriptInfojavascriptInfo

Date and time the asset was last modified.xsd:dateTimelastModified

Email address of the user who lastmodified the asset.

xsd:stringlastModifyUser

Properties for a layer view asset.types:LayerViewInfolayerViewInfo

maskInfo

masterVideoInfo

211Data types

DescriptionTypeName

Array of metadata values associated withthe asset.

types:MetadataArraymetadataArray

Asset name.xsd:stringname

pdfInfo

Properties of a PDF settings asset.types:PdfSettingsInfopdfSettingsInfo

permissions

postScriptInfo

powerPointInfo

premiereExpressInfo

List of project names.xsd:stringprojects

psdInfo

Sets a flag to indicate if an asset should bepublished or not.

xsd:booleanreadyForPublish

Properties of a render scene asset.types:RenderSceneInforenderSceneInfo

rtfInfo

Generic asset subtype that supportssubtype values (for example, AssetSet).

xsd:stringsubType

Properties of an SVG asset.types:SvgInfosvgInfo

Properties of an SWC asset.types:SwcInfoswcInfo

Properties of a template asset.types:TemplateInfotemplateInfo

Indicates if an asset is in the trash or live(see "Trash State" for values).

xsd:stringtrashState

Asset type. See Asset Types for values.xsd:stringtype

Properties of a video caption asset.types:VideoCaptionInfovideoCaptionInfo

Properties of a video asset.videoInfo

Properties of a viewer preset asset.types:ViewerPresetInfoviewerPresetInfo

Properties of a viewer SWf asset.types:ViewerSwfInfoviewerSwfInfo

Properties of a vignette asset.types:VignetteInfovignetteInfo

Properties of a watermark asset.types:WatermarkInfowatermarkInfo

Properties of a window covering asset.types:WindowCoveringInfowindowCoveringInfo

wordInfo

212Data types

DescriptionTypeName

Properties of an XML asset.types:XmlInfoxmlInfo

Properties of an XSL asset.types:XslInfoxslInfo

zipInfo

AssetArray

An array of assets.

Parameters

DescriptionTypeName

Asset array.types:Assetitems

AssetContextStateUpdate

Set a new set of publish state flags for the publish context associated with an asset.

Parameters

DescriptionTypeName

Handle to the asset you want to update.xsd:stringassetHandle

An array of publish contact states for theasset you want to update.

types:ContextStateUpdateArraycontextStateUpdateArray

AssetContextStateUpdateArray

An array of asset context state updates.

Parameters

DescriptionTypeName

An array of asset context state updates.types:AssetsContextStateUpdateitems

AssetCount

Asset types and count for a company.

Asset types include ViewerSWf, PDF, Cabinet, and others.

DescriptionTypeName

Type of asset associated with count.xsd:stringassetType

213Data types

DescriptionTypeName

Number of assetType assets in thecompany.

xsd:intcount

AssetCountArray

An array of asset counts.

Parameters

DescriptionTypeName

Array of asset counts.types:AssetCountitems

AssetJobLog

The details of a job log entry associated with a particular asset. Data returned by getAssetJobLogs.

Parameters

DescriptionTypeName

Job handle.xsd:stringjobHandle

Job Name.xsd:stringjobName

Message in the job log.

logMessage response field is localizedbased on authHeader locale field.

xsd:stringlogMessage

Type of job in the log entry.xsd:stringlogType

email of user who submitted the job.xsd:stringsubmitUserEmail

Job date.xsd:dateTimelogDate

Array of auxiliary job log messages foreach job log.

types:JobLogDetailArrayauxArray

AssetJobLogArray

Array of asset job logs.

Parameters

DescriptionTypeName

Array of asset job logs.types:AssetJobLogitems

214Data types

AssetMetadataFields

Returns metadata field definitions for specified asset types.

Parameters

DescriptionTypeName

Asset type associated with field definitions(see "Asset Types" for values).

xsd:stringassetType

Array of metadata field definitionsassociated with the asset type specified inassetType.

types:MetadataFieldArrayfieldArray

AssetMetadataFieldsArray

An array of AssetMetadataFields. Used by getAssetMetadataFields to return all asset metadata fields in a single callwith results grouped by asset type.

Parameters

DescriptionTypeName

An AssetMetadataFields array item.types:AssetMetadataFieldsitems

AssetMove

A handle to an asset and the handle to where it will be moved.

Parameters

DescriptionTypeName

The handle to the asset you want to move.xsd:stringassetHandle

The handle to the destination folder.xsd:stringfolderHandle

AssetMoveArray

Array of asset moves.

Parameters

DescriptionTypeName

Array of asset moves.type:AssetMoveitems

215Data types

AssetOperationFault

Contains information about warning or error conditions generated during a batch asset operation. The code and reason fieldscorrespond to the fault message fields that would have been thrown for the equivalent non-batch operation.

Parameters

DescriptionTypeName

Asset handle for the failed operation.xsd:stringassetHandle

Operation fault code.xsd:intcode

Fault description or reason.xsd:stringreason

AssetOperationFaultArray

An array of asset operation faults.

Parameters

DescriptionTypeName

An array of asset operation fault items.types:AssetOperationFaultitems

AssetPublishContexts

Maps an asset to the PublishContexts in which an asset is marked for publication.

Parameters

DescriptionTypeName

Handle to the asset.xsd:stringassetHandle

An array of publish contexts in which theasset is marked for publication.

types:PublishContextArraypublishContextArray

AssetPublishContextArray

Parameters

DescriptionTypeName

An array of asset publish contexts.types:AssetPublishContextAssetPublishContextArray

216Data types

AssetSetInfo

Properties for AssetSet type assets.

Parameters

DescriptionTypeName

Asset set definition formatted accordingto the requirements of the targeted IS

xsd:stringsetDefinition

Viewer. Can contain optional IPSsubstitution parameters.

AssetSummary

Metadata search results that contain summarized information about an asset.

Parameters

DescriptionTypeName


Asset type. The "Asset Types" constantdefines the possible values. Optional.

xsd:stringtype

Asset name. Optional.xsd:stringname

The folder that contains the asset.xsd:stringfolder

Asset's file name.xsd:stringfilename

Asset creation date.xsd:dateTimecreated

The user who created the asset.xsd:stringcreateUser

The date that the asset was last updated.xsd:dateTimelastModified

The last user who modified the asset.xsd:stringlastModifyUser

Array of metadata values associated withthe asset.

types:MetadataArraymetadataArray

Defines the precision in case of asimilarity search (0 = no match, 1 = exactmatch).

xsd:doublescore

Holds detailed information about similarareas as a result of a similarity search.

xsd:stringscoreDetail

217Data types

AssetSummaryArray

An array of asset summaries.

Parameters

DescriptionTypeName

Array of asset summaries.types:AssetSummaryitems

AudioInfo

Properties of an audio file asset.

Parameters

DescriptionTypeName

Path to the audio file.xsd:stringoriginalPath



AutoColorCropOptions

Options for automatically cropping images based on color.

Parameters

DescriptionTypeName

Choice of AutoCrop Corner.xsd:stringcorner

Color match specification. Uses:xsd:doubletolerance

• 0 to match colors exactly.• 1 to enable the most color differences.

AutomatedSetGenerationJob

Group files into sets using an asset handle list array.

218Data types

Parameters

DescriptionTypeName

An array of asset handles used to create the set.

By default, 1000 is the maximum number ofassets you can have in the array.

types:HandleArrayassetHandleArray

Path to the folder where you want to save thesets. Saves to company root folder by default.

xsd:stringdestFolder

Sets a flag to indicate if the assets should bepublished or not.


An array of set generation scripts you can runon the uploaded files. SeeAutoSetCreationOptions

types:AutoSetCreationOptionsautoSetCreationOptions

Set up an automated email notification for thejob.

xsd:stringemailSetting

emailSetting Options

The emailSetting parameter includes the following options:

ReturnsOption

All job notifications (errors, warnings, completion) to the specified recipient.All

Job errors to the specified recipient.Error

Job errors and warnings to the specified recipient.ErrorAndWarning

A job completion notification to the specified recipient.JobCompletion

The job does not send any job notifications to the specified recipient.None

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 uploadedassets.

219Data types

Parameters

DescriptionTypeName

Array of PropertySet handles defining theautomatic set generation scripts appliedduring upload.

types:HandleArrayautoSetsArray

AutoTransparentCropOptions

Options used when automatically cropping images based on transparency.

Parameters

DescriptionTypeName

Removes white space from image edgesbased on transparency. Uses:

xsd:doubletolerance


BatchMetadataUpdate

Updates metadata in batch mode.

Parameters

DescriptionTypeName

Array of asset handles.types:HandleArrayassetHandleArray

Array of metadata update handles.types:MetadataUpdateArrayupdateArray

BatchMetadataUpdateArray

An array of batch metadata updates.

Parameters

DescriptionTypeName

The array of batch updates.types:BatchMetadataUpdateitems

CabinetInfo

Properties of a cabinet asset.

220Data types

Parameters

DescriptionTypeName

Relative path to the original cabinet.xsd:stringoriginalPath

Cabinet name.xsd:stringoriginalFile

Cabinet size.xsd:intfileSize

Relative path to the cabinet associatedwith the vignette.

xsd:stringimagePath

File name of cabinet associated with thevignette.

xsd:stringimageFile

Path to the IPS-optimized cabinet.xsd:stringoptimizedPath

IPS-optimized cabinet file.xsd:stringoptimizedFile

ColorManagementOptions

Options specified during upload. Affects how color is managed for the upload.

Parameters

DescriptionTypeName

Color management mode choice.xsd:stringcolorManagement

Source profile handle.xsd:stringsourceProfileHandle

Output profile handle.xsd:stringoutputProfileHandle

Company

Represents a company.

Parameters

DescriptionTypeName

Company handle.xsd:stringcompanyHandle

Company name.xsd:stringname

Root path of the company.xsd:stringrootPath

Date and time the company expires.xsd:dateTimeexpires

221Data types

CompanyArray

An array of companies

Parameters

DescriptionTypeName

An array of companies.types:Companyitems

CompanyMember

Describes the different companies a user belongs to.

Parameters

DescriptionTypeName

User name.types:Useruser

Role the user has for each company theybelong to.

xsd:stringrole

Sets the user's status for each companythey belong to.

xsd:booleanisActive

CompanyMemberArray

Parameters

DescriptionTypeName

types:CompanyMemberitems

CompanyMembership

Parameters

DescriptionTypeName

types:Companycompany

xsd:stringrole


xsd:booleanisActive

222Data types

CompanyMembershipArray

Parameters

DescriptionTypeName

types:CompanyMembershipitems

CompanyMembershipUpdate

Parameters

DescriptionTypeName

Handle to the company.xsd:stringcompanyHandle

The role a user has for each company theybelong to.

xsd:stringrole


xsd:booleanisActive

CompanyMembershipUpdateArray

Parameters

DescriptionTypeName

types:CompanyMembershipUpdateitems

CompanyMetadataInfo

Holds information about a company metadata object like ID, name, and type.

Parameters

DescriptionTypeName

223Data types

CompanyMetadataInfoArray

An array of CompanyMetadataInfo elements.

Parameters

DescriptionTypeName

CompanySettings

Company-specific configuration settings.

Parameters

DescriptionTypeName

Determines whether to overwrite imagesin current folder with same base imagename and extension.

xsd:stringoverwriteMode

Specifies whether a replacement imageuploaded into IPS should retain the

xsd:booleanretainPublishState

existing “Ready to Publish” setting orwhether it should be as specified by theupload.

Specifies the default source color profile(Coated FOGRA27 (ISO 126472:2004))

types:AssetdefaultSourceProfile

automatically applied as part of the “Usedefault Color Behavior”when addingCMYK image files.

Specifies the default internal color profile(U.S. Web Coated (SWOP)

types:AssetdefaultDisplayProfile

v2)automatically applied as part of the“Use default Color Behavior” whenadding CMYK image files.

The extraction of IPTC and EXIF imageheader data into IPS requires a conversion

types:AssetiptcExifMappingXslt

from internal field names to user-definedfield names for the company. Determinesan XSL translation table (default is “Donot extract any IPTC or EXIF fields”) foruploaded images.

The extraction of XMP image header datainto IPS requires a conversion from

types:AssetxmpMappingXslt

internal field names to user-defined fieldnames for the company. Determines an

224Data types

DescriptionTypeName

XSL translation table (default is “Do notextract any XMP fields”) for uploadedimages.

Minimum amount of image directory freedisk space before a warning is sent out.

xsd:intdiskSpaceWarningMin

Determines whether to send emails beforeitems placed into the trash can areautomatically deleted.

xsd:booleanemailTrashCleanupWarning

Determines whether to upload JavaScriptfiles. This is a potential security risk, souse this option with care.

types:AssetjavascriptUploadEnabled

ConfigSetting

Used by Scene7 developers only.

Parameters

DescriptionTypeName

Configuration name.xsd:stringname

Configuration value.xsd:stringvalue

Handle to the stored configuration.xsd:stringhandle

ConfigSettingArray

An array of configuration settings.

Parameters

DescriptionTypeName

An array of configuration settings.types:ConfigSettingitems

ContextStateUpdate

Updates publish context state for an asset.

Parameters

Set an asset's publish context state with setAssetsContextState.

DescriptionTypeName

Handle to the publish context.xsd:stringcontextHandle

225Data types

DescriptionTypeName

The asset's updated published state forthe specified publish context. Includes:

xsd:stringpublishState

• MarkedForPublish• NotMarkedForPublish•

ContextStateUpdateArray

An array of context state updates.

Parameters

DescriptionTypeName

An array of context state updates.types:ContextStateUpdateContextStateUpdateArray

CreateVideoSitemapJob

Creates a video site map.

Parameters

DescriptionTypeName

Generates the site map when set to true.xsd:booleanforceUpdate

Note: If the Sitemap GenerationConfiguration is set to manual andforceUpdate is not set, the sitemap will not be generated.

CssInfo

Properties of an CSS file asset.

Parameters

DescriptionTypeName

Path to the CSS file.xsd:stringoriginalPath



226Data types

CuePointInfo

Properties of a CuePoint file asset.

Parameters

DescriptionTypeName

CuePoint file path.xsd:stringoriginalPath

CuePoint file name.xsd:stringoriginalFile

CuePoint file size.xsd:intfileSize

DiskUsage

Disk space statistics for an asset or folder.

Parameters

DescriptionTypeName


Company name.xsd:stringcompanyName

Number of stored images.xsd:intimageCount

Total file side in kilobytes.xsd:longdiskSpaceUsage

Date, time, and time zone the DiskUsagetype was last modified.

xsd:dateTimelastModified

DiskUsageArray

An array of disk usage.

Parameters

DescriptionTypeName

Array of disk usage.types:DiskUsageitems

EmailConfirmation

Sends an email to a designated recipient in response to a cdnCacheInvalidation operation.

227Data types

Parameters

DescriptionTypeName

If true, includes the user's web service useraccount, which is a list of emails

xsd:booleanccOriginator

designated to receive an emailconfirmation from the Scene7 CDN.

An array of email addresses (5 maximum)designated to receive the confirmationnotification from the Scene7 CDN.

types:EmailArrayccOthersArray

EmailArray

An array used to designate the originator or a list of up to 5 email addresses to receive the confirmation notification.

Parameters

DescriptionTypeName

email addresses.xsd:stringitems

ExcludeByproductArray

Supports byproduct filtering in the searchAssets operation.

Parameters

DescriptionTypeName

Item in the array.types:ExcludeByproductConditionitems

ExcludeByproductCondition

Determines which generation engine and generated asset type to exclude from search results.

Parameters

DescriptionTypeName

The generation engine that created assetsyou want to exclude. See Generation Infofor values.

xsd:stringengine

Excluded asset type. See Asset Types forvalues.

xsd:stringgeneratedAssetType

228Data types

ExcludeMasterVideoFromAVS

Excludes the master video from the adaptive video set.

Parameters

DescriptionTypeName

Excludes the master video file from theadaptive video set.

xsd:booleantrue|false

Defaults to true.

ExcelInfo

Properties of a Microsoft Excel file.

Parameters

DescriptionTypeName

Path to the file.xsd:stringoriginalPath



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

DescriptionTypeName

List of assetHandle which are required to be exported. SeeHandleArray.

types:HandleArrayassetHandleArray

Specifies the type of export.Possible Values: [orig, convert]xsd:stringfmt

229Data types

DescriptionTypeName

• 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

Specifies the ImageServer rendering URL string, which is appendedto the ExportJob convert request.

xsd:stringis_modifier

Refer to the IS documentation for details about sending the ISmodifiers.

xsd:stringmacro

Choice of email setting. Possible values:xsd:stringemailSetting

• All• Error• ErrorAndWarning• JobCompletion• None

Specifies the IP address of the client or customer who initiated theexport request.

xsd:stringclientId

Note: this parameter is not actively populated currently and isstrictly reserved for future usage only.

For ExportJob requests where fmt=convert and both is_modifier and macro are provided, the destination file respectsthe format provided by macro. For example:

input_file = fileToExport.jpgis_modifer = &fmt=pngmacro=$test$ output_file = fileToExport.tiff

FlashInfo

Properties of a Flash file.

Parameters

DescriptionTypeName

File path.xsd:stringoriginalPath



230Data types

http://microsite.omniture.com/t2/help/en_US/s7/is_ir_api/

Folder

Hierarchical file or asset storage object. Folders can contain one (or more) subfolders.

Parameters

DescriptionTypeName

Folder handle.xsd:stringfolderHandle

Folder path.xsd:stringpath

Last modification date.xsd:dateTimelastModified

Last modification date for subfolders andfolder child assets.

xsd:dateTimechildLastModified

Folder permissions handle.xsd:stringpermissionsSetHandle

Determines if a folder has subfolders.types:BooleanhasSubfolder

An array of subfolders in a folder.types:FolderArraysubfolderArray

FolderArray

An array of folders.

Parameters

DescriptionTypeName

Array of folders.types:Folderitems

FontFieldUpdate

Update information for font properties.

Parameters

DescriptionTypeName

Font asset handle.xsd:stringassetHandle

Font name.xsd:stringfontName

PostScript font name.xsd:stringpostscriptName

Rich Text font name.xsd:stringrtfName

Font family name.xsd:stringfontFamily

Font style (see Font Styles for values).xsd:stringstyle

Font type name.xsd:stringtypeName

Font type (see Font Types for values).xsd:stringtype

231Data types

FontFieldUpdateArray

An array of font field updates.

Parameters

DescriptionTypeName

An item in the font field update array.types:FontFieldUpdateitems

FontInfo

Font asset properties.

Parameters

DescriptionTypeName

Font path.xsd:stringoriginalPath

Font name.xsd:stringoriginalFile

Font size.xsd:intfileSize

GenerationAttribute

A name-value pair that contains information about an asset generation step. See getGenerationInfo.

Parameters

DescriptionTypeName

Attribute name.xsd:stringname

Attribute value.xsd:stringvalue

GenerationAttributeArray

Array of generation attributes.

Parameters

DescriptionTypeName

The array of generation attributes.types:GenerationAttributeitems

232Data types

GenerationInfo

PostScript file properties.

Parameters

DescriptionTypeName

Generation engine used (see "GenerationInfo" for values).

xsd:stringengine

Asset record of master asset used ingeneration.

types:Assetoriginator

Asset record of generated asset.types:Assetgenerated

Array of attributes associated withgeneration process.

types:GenerationAttributeArrayattributeArray

GenerationInfoArray

An array of generation properties.

Parameters

DescriptionTypeName

An array of generation properties.types:GenerationInfoitems

Group

Named set of users used for assigning permissions.

Parameters

DescriptionTypeName

Group handle.xsd:stringgroupHandle


Group name.xsd:stringname

Whether the group is defined by thesystem.

xsd:stringis SystemDefined

GroupArray

Array of groups.

233Data types

Parameters

DescriptionTypeName

Array of groups.types:Groupitems

HandleArray

An array of handles.

Note: The array can contain any type of handles required to perform an operation.

Parameters

DescriptionTypeName

An array of handles.xsd:stringitems

IccProfileFieldUpdate

Update information for ICC profile properties.

Parameters

DescriptionTypeName

Handle of the ICC Profile asset to update.xsd:stringassetHandle

Profile classes (see “Profile Classes” forvalues).

xsd:stringclass

Profile color space (see “Color Spaces”for values).

xsd:stringcolorSpace

Profile connection space (see “ColorSpaces” for values).

xsd:stringpcsType

IccProfileFieldUpdateArray

An array of ICC profile field update items.

Parameters

DescriptionTypeName

IccProfileFieldUpdate array item.types:IccProfileUpdateitems

IccProfileInfo

Properties of an ICC profile asset.

234Data types

Parameters

DescriptionTypeName

ICC profile path.xsd:stringoriginalPath

Name of the original ICC profile.xsd:stringoriginalFile

ICC profile size.xsd:intfileSize

IllustratorInfo

Properties of an Adobe Illustrator file.

Parameters

DescriptionTypeName




IllustratorOptions

Options for an Adobe Illustrator file.

Parameters

DescriptionTypeName

Choice of Illustrator processes.xsd:stringprocess

File resolution.xsd:stringresolution

Target color space.xsd:stringcolorSpace

Whether to rasterize the file into animage. If so, create a transparent

xsd:booleanalpha

background if the original file is definedin this way for creating overlaying logos.

ImageFieldUpdate

Updates the image field associated with an image asset.

Parameters

DescriptionTypeName


Image resolution in pixels per inch.xsd:doubleresolution

235Data types

DescriptionTypeName

X axis image anchor.xsd:intanchorX

Y axis image anchor.xsd:intanchorY

Value of userData metadata field, whichis published to the image serving user datacatalog field.

xsd:stringuserData

ImageFieldUpdateArray

An array of image field updates.

Parameters

DescriptionTypeName

Array of image field updates.types:ImageFieldUpdateitems

ImageFormat

Unstructured named set of image output settings.

Not an asset type.

Parameters

DescriptionTypeName

Image format handle.xsd:stringimageFormatHandle

Image format name.xsd:stringname

Image server URL that represents theimage format.

xsd:stringurlModifier

ImageFormatArray

Array of image formats.

Parameters

DescriptionTypeName

Array of image formats.types:ImageFormatitems

ImageInfo

Properties of an image asset.

236Data types

Parameters

DescriptionTypeName

Relative path to the original file.xsd:stringoriginalPath


Path to the IPS-optimized image file.xsd:stringoptimizedPath

The IPS-optimized image file.xsd:stringoptimizedFile

Path of the mask of the image.xsd:stringmaskPath

Filename of the mask.xsd:stringmaskFile

Image width in pixels.xsd:intwidth

Image height in pixels.xsd:intheight

Image size in bytes.xsd:intfileSize

Pixels per inch.xsd:doubleresolution

Product ID.xsd:stringsku

Image description.xsd:stringdescription

Comments (deprecated).xsd:stringcomments

User information associated with theimage (deprecated).

xsd:stringuserData

Horizontal anchor point in pixels.xsd:intanchorX

Vertical anchor point in piexels.xsd:intanchorY

Image server URL parameter.xsd:stringurlModifier

Parameters concatenated to the end ofthe urlModifier. Query string format

xsd:stringurlPostApplyModifier

list of parameters that are commands tothe image server. Values are in the imageserver protocol guide.

237Data types

DescriptionTypeName

Array of zoom targets (5 max).types:ZoomTargetArrayzoomTargets

Masks array.types:MaskArraymasks

Image maps array.types:ImageMapsArrayimageMaps

ImageMap

Target for a click action in the browser.

Always associated with an image. You can get an ImageMap target from ImageInfo.

Parameters

DescriptionTypeName

Image map handle.xsd:stringimageMapHandle

Image map name.xsd:stringname

Image map coordinates. Format is basedon the HTML <area> tag attribute.

xsd:stringregion

Other attributes to include in the HTML<area> tag, including the href URL.

xsd:stringaction

A RegionShape value.xsd:booleanshapeType

Position in the format of the HTML<area> element’s coords attribute. Forexample: coords ="0,0,84,128".

xsd:stringposition

True if image map is enabled.xsd:booleanenabled

Date and time the image map was lastmodified.

xsd:dateTimelastModified

ImageMapArray

An array of image maps.

Parameters

DescriptionTypeName

The image map array.types:ImageMapitems

238Data types

ImageMapDefinition

Target definition for a click action in the browser.

Parameters

DescriptionTypeName

The name of the image map definition.xsd:stringname

One of region shape values.xsd:stringshapeType

Image map coordinates. The format isbased on the HTML <area> tagattributes.

xsd:stringregion

Other attributes to include in the HTML<area> tag, including the href URL.

xsd:stringaction

True if the image map is enabled.xsd:booleanenabled

ImageMapDefinitionArray

An array of image map definitions.

Parameters

DescriptionTypeName

Array of image map definitions.types:ImageMapDefinitionitems

ImageRenderingPublishJob

Publishes files to the image rendering servers.

Parameters

DescriptionTypeName

Choice of email settings.xsd:stringemailSetting

URL to send a completion notice.xsd:stringhttpCompletionUrl


ImageServingPublishJob

Publishes files to the image servers.

239Data types

Parameters

DescriptionTypeName

One of the available publish types.xsd:stringpublishType



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. Thevalue is forced to true for eCatalog and RenderSet sets.

Parameters

DescriptionTypeName

Assets in the image set array.type:Assetasset

Starts a new page. Setting is ignored andvalue is forced to true for eCatalog andRenderSet sets.

xsd:booleanpageReset

ImageSetMemberArray

An array of image set members.

Parameters

DescriptionTypeName

The array of image set members.types:ImageSetMemberitems

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

DescriptionTypeName

Asset handle in the image set memberarray.

xsd:stringassetHandle

240Data types

DescriptionTypeName

Resets the page.

Setting is ignored and value is forced totrue for ImageSet and SpinSet.

xsd:booleanpageReset

ImageSetMemberUpdateArray

An array of image set member updates.

Parameters

DescriptionTypeName

The array of image set member updates.types:ImageSetMemberUpdateitems

InDesignInfo

InDesign file properties.

Parameters

DescriptionTypeName




JavascriptInfo

Properties of a JavaScript file asset.

Parameters

DescriptionTypeName

Path to the JavaScript file.xsd:stringoriginalPath



JobLog

The job log after the job has run.

241Data types

Parameters

DescriptionTypeName


Job handle.xsd:stringjobHandle

Job name.xsd:stringjobName

The original name submitted for the jobwith submitJob.

xsd:stringoriginalJobName

The email address of the user whosubmitted the job.


Choice of job log types.xsd:stringlogType

Additional job information.xsd:stringjobSubType

The start date, time, and time zone of thejob.

xsd:dateTimestartDate

The end date, time, and time zone of thejob.

xsd:dateTimeendDate

A description of the job as originallyspecified in submitJob.


Number of files successfully processed.xsd:intfileSuccessCount

Number of files that caused an error.xsd:intfileErrorCount

Number of files that generated a warning.xsd:intfileWarningCount

Number of duplicate files.xsd:intfileDuplicateCount

Number of files updated.xsd:intfileUpdateCount

Number of files processed by the loggedjob.

xsd:inttotalFileCount

Number of successful transfers.xsd:inttransferSuccessCount

Number of transfer errors.xsd:inttransferErrorCount

Number of transfer warnings.xsd:inttransferWarningCount

Whether the job generated a fatal error.xsd:booleanfatalError

The total number of rows matching thequery, which may be larger than the sizeof detailArray due to page size limits.

xsd:intdetailTotalRows

The array of details about the logged job.types:JobLogDetailArraydetailArray

JobLogArray

An array of job logs.

242Data types

Parameters

DescriptionTypeName

The array of job logs.types:JobLogitems

JobLogDetail

Job log information.

Parameters

DescriptionTypeName

Messages in the job log.xsd:stringlogMessage

Job log file type.xsd:stringlogType

Name of asset in the job log (optional).xsd:stringassetName

Choice of asset type.xsd:stringassetType

Asset handle referenced in the job log.xsd:stringassetHandle

Provides additional detailed job loginformation beyond the five job log typesdescribed above.

types:JobLogDetailAuxArrayauxArray

JobLogDetailArray

Array of job log details.

Parameters

DescriptionTypeName

An array of job log details.types:JobLogDetailitems

JobLogDetailAux

Contains supplementary messages associated with the main job log message (JobDetail). Includes warnings and other detailsassociated with the currently processed asset.

Parameters

DescriptionTypeName

An auxiliary message.xsd:stringlogMessage

Log type:IPSJobLog.gcUploadWarning orIPSJobLog.gcUploadError.

xsd:stringlogType

Auxiliary job log creation date.xsd:dateTimedateCreated

243Data types

JobLogDetailAuxArray

Array of auxiliary job log detail types.

Parameters

DescriptionTypeName

An array of auxiliary job log detail types.types:JobLogDetailAuxitems

Keywords

Parameters

DescriptionTypeName

Keyword.xsd:stringkeyword

Keyword validity.xsd:booleanstatus

Keyword position on the x axis (in pixels).xsd:intx

Keyword position on the y axis (in pixels).xsd:inty

Keyword width in pixels.xsd:intwidth

Keyword height in pixels.xsd:intheight

KeywordsArray

An array of keywords.

Parameters

DescriptionTypeName

An array of keywords.types:Keywordsitems

KnockoutBackgroundOptions

Mask (knock-out) the background for selected images. This lets you overlay them in other layers with a transparency outsideof subject image. An optional parameter that is off by default.

KnockoutBackgroundOptions=[corner, tolerance, fill]

244Data types

Parameters

DescriptionTypeName

Selects the corner you want to work with. corner acceptsthese values:

xsd:stringcorner

• UpperLeft• BottomLeft• UpperRight• BottomRight

An optional setting that removes white space from imageedges based on transparency. Accepts a range of valuesfrom 0.0 to 1.0. Specify:

xsd:doubletolerance


Control pixel transparency in the location specified bythe corner variable. The fillMethod accepts thesevalues:

xsd:stringfillMethod

• FloodFill: Turns all pixels in the specified cornertransparent.

• MatchPixel: Turns all matching pixels transparentregardless of location.

Example

<complexType name="KnockoutBackgroundOptions"> <sequence>  <element name="corner" type="xsd:string" minOccurs="1"/>  <element name="tolerance" type="xsd:double" minOccurs="0"/>  <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.

245Data types

Parameters

DescriptionTypeName

Image server URL that represents thetemplate. Combines urlModifier andurlPostAp- plyModifier fields.

xsd:stringurl

Image serving protocol commands toapply prior to request orurlPostApplyModifier commands.


Image serving protocol commands toapply after urlModifier and requestcommands.


ManualCropOptions

Manual crop options for images.

Parameters

DescriptionTypeName

The left position of the manual crop inpixels.

xsd:intleft

The right position of the manual crop inpixels.

xsd:intright

The top position of the manual crop inpixels.

xsd:inttop

The bottom position of the manual cropin pixels.

xsd:intbottom

Mask

Masks part of an image. The mask is always associated with the image. Get a mask from ImageInfo.

Parameters

DescriptionTypeName

Mask handle.xsd:stringmaskHandle

Mask name.xsd:stringname

Relative path to the mask.xsd:stringmaskPath

Mask file.xsd:stringmaskFile

The date, time, and time zone the maskwas last modified.

types:dateTimelastModified

246Data types

MaskArray

An array of masks.

Parameters

DescriptionTypeName

Array of masks.types:Maskitems

MaskInfo

Mask file properties.

Parameters

DescriptionTypeName

Mask file path.xsd:stringmaskPath

Mask file name.xsd:stringmaskFile

MasterVideoInfo

File information for master video assets.

Parameters

DescriptionTypeName




MediaOptions

Generates thumbnail image for your video.

Parameters

DescriptionTypeName

An array of PropertySet handlesreferencing video encoding presets fortranscoding videos.

types:HandleArrayvideoEncodingPresetsArray

247Data types

DescriptionTypeName

When true, the first frame of the video isextracted and used as the thumbnailimage.

xsd:booleangenerateThumbnail

Optional. Lets you choose a particularvideo frame to use as the thumbnailimage.

To specify a thumbnail image, pass in thetime (in milliseconds from video start)

types:ThumbnailOptionsthumbnailOptions

for the frame you want to use. Valuesrange from 0 to the end of the video.

Note: If you specify the timeincorrectly, generateThumbnaildefaults 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

DescriptionTypeName

Metadata name.xsd:stringname

Metadata value.xsd:stringvalue

Boolean metadata value (forBoolean-typed fields only).

xsd:booleanboolVal

248Data types

DescriptionTypeName

Long metadata value (for int-typed fieldsonly).

xsd:longlongVal

Double metadata value (for float-typedfields only).

xsd:doubledoubleVal

Date metadata value (for date-typed fieldsonly).

xsd:dateTimedateVal

MetadataArray

An array of metadata.

Parameters

DescriptionTypeName

An array of metadata.type:Metadataitems

MetadataCondition

Adds a search term for use with searchAssets.

Parameters

DescriptionTypeName

Field handle.xsd:stringfieldHandle

Choice of string comparison operators.xsd:stringop

Value to test.xsd:stringvalue

Boolean comparison value (forBoolean-typed fields only).

xsd:booleanboolVal

Long comparison value (for int-typedfields only).

xsd:longlongVal

Minimum long value in rangecomparison (for int-typed fields only).

xsd:longminLong

Maximum long value in rangecomparison (for int-typed fields only).

xsd:longmaxLong

Double comparison value (for float-typedfields only).

xsd:doubledoubleVal

Minimum double value in rangecomparison (for float-typed fields only).

xsd:doubleminDouble

Maximum double value in rangecomparison (for float-typed fields only).

xsd:doublemaxDouble

249Data types

DescriptionTypeName

Date comparison value (for date-typedfields only).

xsd:dateTimedateVale

Minimum date value in range comparison(for date-typed fields only).

xsd:dateTimeminDate

Maximum date value in rangecomparison (for date-typed fields only).

xsd:dateTimemaxDate

Establishes case-sensitivity for theMetadata Server. Used in thesearchAssetsByMetadata call.

caseSensitive

See searchAssetsByMetadata.

MetadataConditionArray

An array of metadata conditons.

Parameters

DescriptionTypeName

The array of metadata conditons.types:MetadataConditionitems

MetadataDelete

Metadata to delete from the asset.

Parameters

DescriptionTypeName

Metadata parameters to delete.xsd:string

fieldHandle

MetadataDeleteArray

An array of metadata to delete from the asset.

Parameters

DescriptionTypeName

An array of metadata parameters todelete.

type:Metadataitems

250Data types

MetadataField

User-defined field definitions for specific assets.

Retrieve tag field definitions with the getMetadataFields or getAssetMetadataField operations.

Parameters

DescriptionTypeName

Metadata field handle.xsd:stringfieldHandle

Metadata field name.xsd:stringname

Metadata field type.xsd:stringtype

Default value for the metadata field.xsd:stringdefaultValue

Sets required status.xsd:booleanisRequired

Determines if the metadata field is defined bythe user or not.

xsd:booleanisUserDefined

Hide or expose IPS system-specific metadata.Returned from getMetadataFields andgetAssetMetadataFields.

xsd:booleanisHidden

A boolean flag that indicates whether themetadata field type is enforced (validated) whenthe value is set.

xsd:booleanisEnforced

If set to true, then a fault is thrown if an illegalvalue is set in setAssetMetadata/batchSetAssetMetadata.

Allows you create a set of shared enumeratedvalues that selected tags can point to.

xsd:stringinitialTagValue

MetadataFieldArray

An array of metadata fields

Parameters

DescriptionTypeName

Metadata field array.types:MetadataFielditems

MetadataPublishJobType

Publishes metadata to the metadata server.

251Data types

Parameters

DescriptionTypeName

Set to True to publish all data to themetadata server again.

xsd:booleanforcePublish

Note: Depending on the amount ofdata, this can take several minutesto a few hours.

Do not set this parameter if you want topublish 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

DescriptionTypeName

Metadata field handle.xsd:stringfieldHandle

Metadata update value.xsd:stringvalue

Boolean metadata value (forBoolean-typed fields only).

xsd:booleanboolVal

Long metadata value (for int-typed fieldsonly).

xsd:longlongVal

Double metadata value (for float-typedfields only).

xsd:doubledoubleVal

Date metadata value (for date-typed fieldsonly).

xsd:dateTimedateVal

Adds to the existing tag value list for theasset.

types:StringArrayaddTagValueArray

• Single-value tag fields store the last valueonly.

• A fixed dictionary tag field returns afault if the value is not in the dictionary.

Replaces the existing tag value list for theasset.

types:StringArraysetTagValueArray

• Single-value tag fields store the last valueonly.

252Data types

DescriptionTypeName

• A fixed dictionary tag field returns afault if the value is not in the dictionary.

Deletes the specified values from theasset’s tag value list, if present.

types:StringArraydeleteTagValueArray

MetadataUpdateArray

An array of metadata updates.

Parameters

DescriptionTypeName

Array of metadata updates.types:MetadataUpdateitems

MPEvent

A MediaPortal event.

Parameters

DescriptionTypeName

Media Portal event type.xsd:stringeventType

Event creation date.xsd:dateTimecreateDate

System or user triggering the event.xsd:stringipsUser

Company ID.xsd:intcompanyId

Comany name.xsd:stringcompanyName

A unique job name.xsd:stringjobName

A useful description for the job.xsd:stringjobDescription

Holder for string information (optional).xsd:stringstring1





Holder for integer information (optional).xsd:intint1





253Data types

DescriptionTypeName

Holder for float information (optional).xsd:doublefloat1



Holder for date/timestamp information(optional).

xsd:dateTimetime1

MPEventArray

An array of MediaPortal events.

Parameters

DescriptionTypeName

MediaPortal event array.types:MPEventitems

OperationFault

Detail message responding to one the URLs provided in the CDN invalidation request.

Supported Since

4.5.0, patch 2011-02

Parameters

DescriptionTypeName

Error code provided from the CDNxsd:intcode

Error message provided from the CDNxsd:stringreason

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

DescriptionTypeName

The list of messages resulting from theCDN invalidate request.

types:OperationFaultitems

254Data types

OptimizeImagesJob

Details for an optimize images job.

Parameters

DescriptionTypeName

An email settings field.xsd:stringemailSetting

PdfInfo

PDF file properties.

Parameters

DescriptionTypeName


File name.xsd:intoriginalFile


PDFOptions

PDF file options.

Parameters

DescriptionTypeName

Choice of "PDF processes."xsd:stringprocess

File resolution.xsd:doubleresolution

Post-script Colorspace Mode choice.xsd:stringcolorspace

Whether to combine a multiple page PDFinto an eCatalog after rendering (defaultis true).

xsd:booleanpdfCatalog

Whether to extract search words from thePDF file.

xsd:booleanextractSearchWords

Whether to extract PDF links into imagemaps assigned to the rasterized pageswithin IPS.

xsd:booleanextractLinks

PdfSettingsInfo

The properties of a PDF settings file asset.

255Data types

Parameters

DescriptionTypeName




Permission

Manages rights to access, modify, create, or delete assets by group.

Parameters

DescriptionTypeName


Group name.xsd:stringgroupName

Choice of permission type.xsd:stringpermissionType

Determines if the permission is allowed.xsd:booleanisAllowed

Determines if the permission overridesanother.

xsd:booleanisOverride

PermissionArray

An array of permissions.

Parameters

DescriptionTypeName

The permissions array.types:Permissionitems

PermissonSet

Parameters

DescriptionTypeName

Handle to a permissions set.xsd:stringPermissionSetHandle

An array of permissions.types:PermissionArraypermissionArray

256Data types

PermissionSetArray

Parameters

DescriptionTypeName

Array of permission sets.types:PermissionSetitems

PermissionUpdate

Describes permission changes.

Parameters

DescriptionTypeName


Permission type.xsd:stringpermissionType

Determines if the permission update isallowed.

xsd:booleanisAllowed

Determines if the permission overridesanother.

xsd:booleanisOverride

PermissionUpdateArray

An array of permission updates.

Parameters

DescriptionTypeName

The permissions update array.types:PermissionUpdateArrayitems

PerspectiveQuad

Image location coordinates returned by the getPhotoshopPath operation.

Parameters

DescriptionTypeName

Upper left x-axis coordinate.xsd:doublex0

Upper left y-axis coordinate.xsd:doubley0

Upper right x-axis coordinate.xsd:doublex1

257Data types

DescriptionTypeName

Upper right y-axis coordinate.xsd:doubley1

Lower right x-axis coordinate.xsd:doublex2

Lower right y-axis coordinate.xsd:doubley2

Lower left x-axis cooridnate.xsd:doublex3

Lower left y-axis coordinate.xsd:doubley3

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

DescriptionTypeName

Array of Photoshop layer options.types:PhotoshopLayerOptionslayerOptions

Photoshop process options:xsd:stringprocess

• None• MaintainLayers

PhotoshopLayerOptions

Photoshop image layer options.

Parameters

DescriptionTypeName

Choice of Photoshop Layer NamingModes.

xsd:stringlayerNaming

Choice of Photoshop Anchor Modes.xsd:stringanchor

Whether to create a template fromPhotoshop layers.

xsd:booleancreateTemplate

258Data types

DescriptionTypeName

Whether to extract text as text layers.xsd:booleanextractText

Whether to extend layers to full size ofbackground.

xsd:booleanextendLayers

PostScriptInfo

Parameters

DescriptionTypeName




PostScriptOptions

PostScript file options.

Parameters

DescriptionTypeName

PostScript process choice.xsd:stringprocess

File resolution.xsd:doubleresolution

PostScript colorspace mode.xsd:stringcolorspace

Whether to rasterize the file into animage. If so, it will create a transparent

xsd:booleanalpha

background if the original file if is definedin this way. Generally used to createoverlaying logos.

Whether to extract search words from thePostScript file.

xsd:booleanextractSearchWords

PowerPointInfo

PowerPoint file options.

Parameters

DescriptionTypeName



259Data types

DescriptionTypeName


PremierExpressRemixInfo

Properties of a PremierExpressRemix file asset.

Parameters

DescriptionTypeName




Project

Set of named assets.

Parameters

DescriptionTypeName

Project handle.xsd:stringproject Handle

Project name.xsd:stringname

ProjectArray

An array of projects.

Parameters

DescriptionTypeName

The project array.types:Projectitems

Property

A name and value pair.

Parameters

DescriptionTypeName

Property name.xsd:stringname

260Data types

DescriptionTypeName

Property value.xsd:stringvalue

PropertyArray

An array of properties.

Parameters

DescriptionTypeName

The property array.types:Propertyitems

PropertySet

Type and value for a property set.

Parameters

DescriptionTypeName

Property set handle.xsd:stringsetHandle

Handle to the property set type.xsd:stringtypeHandle

Name-value pair. Can contain zero items.types:PropertyArraypropertyArray

PropertySetArray

An array of property sets.

Parameters

DescriptionTypeName

Property set array.types:PropertySetitems

PropertySetType

Valid values for the PropertySetType and createPropertySetTypeParam fields.

Values include:

• UserProperty• CompanyProperty• UserCompanyProperty

261Data types

Parameters

DescriptionTypeName

Type handle.xsd:stringtypeHandle


Note: The type is global if thecompany handle is not present.

Type name.xsd:stringname

One of Property Set Types. See Input(createPropertySetTypeParam).

xsd:stringpropertyType

Whether to allow multiple property setinstances to be attached to an object forthis type.

xsd:booleanallowMultiple

PropertySetTypeArray

Property set type array.

Parameters

DescriptionTypeName

The property set type array.types:PropertySetTypeitems

PsdInfo

Photoshop file properties.

Parameters

DescriptionTypeName



File path.xsd:stringoptimizedPath

File name.xsd:stringoptimizedFile


PublishContext

Defines a publish target for a company.

262Data types

Parameters

Assets maintain a separate marker for each publish state and context. Set the publish state with setAssetsContextState.

DescriptionTypeName


Name of the publish context.xsd:stringcontextName

Type of publish context. Includes:xsd:stringcontextType


PublishContextArray

An array of publish contexts.

Parameters

DescriptionTypeName

An array of publish contexts.types:PublishContextPublishContextArray

PublishHistory

Publication history of an asset.

Parameters

DescriptionTypeName

Name of the server that owns the publishhistory.

xsd:stringserverName

Publish history context name.xsd:stringcontextName

Publish format.xsd:stringpublishFormat

Date and time the asset was lastpublished.

xsd:dateTimelastPublished

PublishHistoryArray

An array of publish histories.

263Data types

Parameters

DescriptionTypeName

The publish history array.types:PublishHistoryitems

PublishStateUpdate

Parameters used to update the publish state of an asset.

Parameters

DescriptionTypeName


New publish state.xsd:stringpublishState

PublishStateUpdateArray

An array of publish state updates.

Parameters

DescriptionTypeName

The array of publish state updates.types:PublishStateUpdateitems

RenderSceneInfo

Render scene asset properties.

Parameters

DescriptionTypeName

Image server URL that represents therender scene.

xsd:stringurl

ReprocessAssetsJob

Job type to allow reprocessing of previously uploaded master files, including reripping PDFs and reoptimizing images.

Parameters

DescriptionTypeName

Asset handle.types:HandleArrayassetHandleArray

264Data types

DescriptionTypeName

Whether the files are marked ready forpublishing.


Controls whether the publish state of anexisting asset is preserved when

xsd:booleanpreservePublishState

overwriting. If not set, the companydefault setting is used.

Whether to create a mask.xsd:booleancreateMask

Controls preservation of any existing cropdefinition. Defaults to true.xsd:booleanpreserveCrop

Manual crop options.types:ManualCropOptionsmanualCropOptions

Options for automatic crops of imagesbased on color.

types:AutoColorCropOptionsautoColorCropOptions

Removes white space from the edges ofimages, based on transparency.

types:AutoTransparentCropOptionsautoTransparentCropOptions

Options for uploading Photoshop files tothe Image Server.

types:PhotoshopOptionsphotoshopOptions

Options for uploading PostScript files tothe Image Server.

types:PostScriptOptionspostScriptOptions

Options for uploading PDF files to theImage Server.

types:PDFOptionspdfOptions

A/V media file options.types:MediaOptionsmediaOptions

Options for uploading Illustrator files tothe Image Server.

types:IllustratorOptionsillustratorOptions

Options that you can specify during anupload. The set affects how the color ismanaged for the upload.

types:ColorManagementOptionscolorManagementOptions

Array of automatic set generation scriptsto apply to uploaded files.


An array of project handles.types:HandleArrayprojectHandleArray

265Data types

DescriptionTypeName

Options for email settings.xsd:stringemailSetting

Whether to upload only files.xsd:booleanpostJobOnlyIfFiles

URL to file upload location.xsd:stringpostHttpUrl

Job details for an image serving publishjob to be run after the upload is complete.

types:ImageServingPublishJobpostImageServingPublishJob

Job details for an image rendering publishjob to be run after the upload is complete.

types:ImageRenderingPublishJobpostImageRenderingPublishJob

Job details for a video publish job to berun after the upload is complete.

types:VideoPublishJobpostVideoPublishJob

Options for uploading InDesign files tothe image server.

types:InDesignOptionsinDesignOptions

Mask the background for selected images.This lets you overlay them in other layers

types:KnockoutBackgroundOptionsknockoutBackground

with a transparency outside of subjectimage.

Optional.

SeeKnockoutBackgroundOptions

Options that let you control unsharpmask settings when creating an optimized

types:UnsharpMaskOptionsunsharpMaskOptions

pyramid TIF file. Use these settings tohelp improve image sharpness.

See UnsharpMaskOptions.

Notes

Choices for *CropOptions include:

• manualCropOptions• autoColorCropOptions• autoTransparentCropOptions

Choices for *PublishJob include:

• postImageServingPublishJob• postImageRenderingPublishJob• postVideoPublishJob

266Data types

RipPdfsJob

A process that re-rips an existing PDF asset.

Note: This job type is deprecated. Transition to ReprocessAssetsJob for all future integrations.

Parameters

DescriptionTypeName

Handle to the array of PDF files to beripped.

types:HandleArraypdfHandleArray

Determines if you want to create a maskor not.

xsd:booleancreateMask

Manual cropping options.types:ManualCropOptionsmanualCropOptions

Automatic cropping options.types:AutoColorCropOptionsautoColorCropOptions

types:PostTransparentCropOptionsautoTransparentCropOptions





An array of project handles.types:HandleArrayprojectHandleArray

Email settings.xsd:stringemailSetting

The URL where the files are beinguploaded to.

xsd:stringpostHttpUrl

Job details for an image serving publishjob to be run after the upload is complete.


Job details for an image rendering publishjob to be run after the upload is complete.

types:ImageRenderingPublishJobpostImageRenderingPublishJob

267Data types

DescriptionTypeName

Job details for a video publish job to berun after the upload is complete.


Options for uploading Adobe InDesignfiles to the image server.





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

DescriptionTypeName




ScheduledJob

A job that is scheduled to run.

268Data types

Parameters

DescriptionTypeName


Scheduled job handle.xsd:stringjobHandle

Job name.xsd:stringname

Original name of the scheduled job.xsd:stringoriginalName

Job type.xsd:stringtype

The email address of the user whoscheduled the job.


The locale to be used for job log detailsand email localization. Locales are

xsd:stringlocale

specified as <language_code>[-<country_code>], where the languagecode is a lower-case, two-letter code asspecified by ISO-639, and the optionalcountry code is an upper-case, two-lettercode as specified by ISO-3166. Forexample, the locale string for English(United States) would be: en-US.

A description of the job as originallyspecified in submitJob.


When the job is scheduled to run.xsd:stringexecSchedule

The date, time, and time zone when thejob will be fired.

xsd:dateTimenextFireTime

The time zone of the scheduled job.xsd:dateTimetimeZone

Choice of job trigger state.xsd:inttriggerState

Job details for an image serving publishjob.

types:ImageServingPublishJobimageServingPublishJob

Job details for an image rendering job.types:ImageServingRenderJobimageServingRenderJob

Job details for a video publish job. SeeVideoPublishJob.

types:VideoPublishJobvideoPublishJob

Job details for a server directory publishjob.

types:ServerDirectoryPublishJobserverDirectoryPublishJob

Job details for an upload directory job.types:UploadDirectoryJobuploadDirectoryJob

Job details for an upload URLs job.types:UploadUrlsJobuploadUrlsJob

types:OptimizeImagesJoboptimizeImagesJob

types:RipPdfsJobripPdfsJob

types:ReprocessAssetsJobreprocessAssetsJob

Allow authorized export of previouslyuploaded files. See Export Job.

types:ExportJobexportJob

269Data types

http://microsite.omniture.com/t2/help/en_US/s7/ips_api/#VideoPublishJob

http://microsite.omniture.com/t2/help/en_US/s7/ips_api/#ScheduledJob

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

DescriptionTypeName

A scheduled jobs array.types:ScheduledJobsitems

SearchFilter

Filters that help you define search criteria to make searches more efficient.

Parameters

DescriptionTypeName

Specify the folder you want to search.Leave blank to search across and entirecompany.

xsd:stringfolder

Set to:xsd:booleanincludeSubfolders

• True: To search the named folder andall subfolders.

• False: To search the named folder only.

A list of asset types that you want toreturn in a search. For example, image.

type:StringArrayassetTypeArray

Specify an asset type to exclude from asearch. For example, image.

type:StringArrayexcludeAssetTypeArray

A list of asset sub-types you want toreturn in a search. For example, for an

type:StringArrayassetSubTypeArray

AssetSet, you can search for theMediaType sub-type.

270Data types

DescriptionTypeName

An optional boolean flag that specifieswhether to return assets with no subtypewhen assetSubTypeArray is passed.

xsd:booleanstrictSubTypeCheck

If true, then only assets with one of thespecified subtypes is returned.

If false, then assets with no subtype arealso returned.

Defaults is false.

Set to:xsd:booleanexcludeByproducts

• True: To return original assets only.• False: To return generated content.

For example, images from an uploadedPDF.

Handle to the project you want to search.xsd:stringprojectHandle

Specify:xsd:stringpublishState

• MarkedForPublish to returnpublished assets only.

• NotMarkedForPublish to returnunpublished assets only.

Note: Leave blank to search for allpublished state types.

Specify:xsd:stringtrashState

• Any to return assets regardless of theirtrash state.

• NotInTrash to return 'normal' assets.• InTrash to return assets from the trash.

SearchStrings

Search string record extracted from a PDF file.

Parameters

DescriptionTypeName

Search string text.xsd:stringsearchString

Array of keywords in the search string.types:KeywordsArraykeywordsArray

271Data types

DescriptionTypeName

True if the search string is valid andenabled.

xsd:booleanstatus

X axis position of the search string.xsd:intx

Y axis position of the search string.xsd:inty

Search string width.xsd:intwidth

Search string height.xsd:intheight

Name of the font used in the searchstring.

xsd:stringfontName

Font size.xsd:stringpointSize

SearchStringsArray

An array of search strings.

Parameters

DescriptionTypeName

An array of search strings.types:SearchStringsitems

ServerDirectoryPublishJob

Publishes all the images, templates, and spin sets that are marked ready to publish to a server directory.

Parameters

DescriptionTypeName

Choice of email settings.xsd:stringemailSettings


SetMetadataFault

Warning or error details for a sing update in a batchSetAssetMetadata operation.

Parameters

DescriptionTypeName

The asset whose metadata wasunsuccessfully set.

xsd:stringassetHandle

The handle to the metadata field whosevalue was unsuccessfully set.

xsd:stringfieldHandle

272Data types

DescriptionTypeName

Fault code.xsd:intcode

Fault description (plain-text).xsd:stringreason

SetMetadataFaultArray

An array of metadata faults.

Parameters

DescriptionTypeName

An array of metadata faults.types:SetMetadataFaultitems

SetPropertySetPermissions

Parameters

DescriptionTypeName

Handle to the property set.xsd:stringsetHandle

An array of permissions.types:PermissionUpdateArraypermissionsArray

SvgInfo

Properties of an SVG file asset.

Parameters

DescriptionTypeName




StringArray

An array of strings.

Parameters

DescriptionTypeName

An array of strings.xsd:stringitems

273Data types

SwcInfo

Properties of an SWC file asset.

Parameters

DescriptionTypeName

Path to the SWC file.xsd:stringoriginalPath



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 fieldtype. For search ranges, pass min<Type> and max<Type> parameters and pass an op value of Between or NotBetween.

Parameters

DescriptionTypeName

Choice of Asset Search System Fields.xsd:stringfield

Choice of String Comparison Operators.xsd:stringop

Value to test against.xsd:stringvalue

Boolean comparison value.xsd:booleanboolVal

Long comparison value.xsd:longlongVal

Lower boundary of long range.xsd:longminLong

Upper boundary of long range.xsd:longmaxLong

Double comparison value.xsd:doubledoubleVal

Lower boundary of double range.xsd:doubleminDouble

Upper boundary of double range.xsd:doublemaxDouble

Date comparison value.xsd:dateTimedateVal

Date range minium.xsd:dateTimeminDate

Date range maximum.xsd:dateTimemaxDate

Example

<systemFieldConditionArray> <items> <field>LastModified</field> <op>Between</op> <minDate>2007-08-01T00:00:00</minDate> <maxDate>2007-12-01T00:00:00</maxDate>

274Data types

</items></systemFieldConditionArray>

SystemFieldConditionArray

An system field condition array.

Parameters

DescriptionTypeName

An array of system field conditions.types:SystemFieldConditionsitems

TagCondition

Defines search conditions for tag fields.

Parameters

DescriptionTypeName

Tag field handle.xsd:stringfieldHandle

Depends on the tag field type and whetherthe value or valueArray field is used.

xsd:stringop

• If value is passed, op must be the stringconstant Matches. The conditionmatches any asset that is associated withthe tag value.

• If valueArray is passed, the op fieldcan be the constant MatchesAny foreither single or multivalued tag fields.A MatchesAny condition matches anyasset that is associated with at least oneof the tag values in valueArray.

• For multi-valued tag fields, the op fieldcan be set to the constant MatchesAllwith the valueArray field. In this case,the condition only matches assets thatare associated with all of the tag valuesin valueArray (possibly in addition toother tag values).

A matching value.xsd:stringvalue

Multiple matching values.types:StringArrayvalueArray

TagConditionArray

An array of tag conditions.

275Data types

Parameters

DescriptionTypeName

An array of tag conditions.types:TagConditionitems

TagConditionArray

An array of tag conditions.

Parameters

DescriptionTypeName

An array of tag conditions.types:TagConditionitems

TagFieldValues

An array of values for a tag field.

Parameters

DescriptionTypeName

Tag field handle.xsd:stringfieldHandle

An array of values for a tag field.xsd:StringArrayvalueArray

TagFieldValuesArray

An array of tag field values.

Parameters

DescriptionTypeName

An array of tag field values.types:TagFieldValuesitems

TagValueUpdate

Defines old and new tag field values.

Parameters

DescriptionTypeName

Original tag field value.xsd:stringoldValue

New tag field value.xsd:stringnewValue

276Data types

TagValueUpdateArray

An array of tag value updates.

Parameters

DescriptionTypeName

An array of tag value updates.types:TagValueUpdateitems

TagValueUpdateFault

The error thrown when a tag value update fails.

Parameters

DescriptionTypeName

Tag value for which the update failed.xsd:stringvalue

Error code number.xsd:intcode

Error message (plain-text).xsd:stringreason

TagValueUpdateFaultArray

An array of tag value update faults.

Parameters

DescriptionTypeName

An array of tag value update faults (errormessages).

types:TagValueUpdateFaultitems

TaskItemProgress

Task item progress information.

Parameters

DescriptionTypeName

Name of the item being processed.xsd:stringitemName

Progress complete %.xsd:doubleprogress

Process message.xsd:stringprogressMessage

Time of last update.xsd:dateTimelastProgressUpdate

277Data types

TaskItemProgressArray

An array of information about a task item.

Parameters

DescriptionTypeName

Task item progress array. Minimumoccurrence is zero. Maximum isunbounded.

types:TaskItemProgressitems

TaskProgress

Task progress information.

Parameters

DescriptionTypeName

Task type description.xsd:stringtaskType

Number of task items already processed.xsd:intnumProcessed

Number of task items currently inprocess.

xsd:intnumProcessing

Number of pending task items (not yetprocessed).

xsd:intnumPending

% progress (range 0.0 - 1.0).xsd:doubleprogress

Progress message.xsd:stringprogressMessage

Time the last progress information waslast updated.

xsd:dateTimelastProgressUpdate

Array of task items.types:TaskItemProgressArraytaskItemProgressArray

Values include:xsd:stringtaskState

• Unknown: When the task monitortransitions between states.

• New: Task monitor has been created buthas not accepted tasks yet.

• Processing: Task monitor is activelyprocessing tasks.

• Stopping: Task monitor is stopping ajob because of a stop job request.

• Done: Jobs assigned to the task monitorjobs have been completed.

• Failed: Indicates a fatal error.

278Data types

TaskProgressArray

A task progress array. Contains information about video transcoding tasks.

Parameters

DescriptionTypeName

Task progress items. Minimumoccurrence is zero. Maximum occurrenceis unbounded.

types:TaskProgressitem

TemplateInfo

The properties of a template asset.

Templates are parameterized layer definitions that construct a layered image.

Parameters

DescriptionTypeName

Image server URL that represents thetemplate.

xsd:stringurl



ThumbAssetUpdate

Thumbnail image update.

Parameters

DescriptionTypeName


Thumb asset handle.xsd:stringthumbAssetHandle

ThumbAssetUpdateArray

An metadata updates for thumb assets.

Parameters

DescriptionTypeName

An array of thumb asset updates.types:ThumbAssetUpdatesitems

279Data types

ThumbnailOptions

An optional type that lets you choose a particular video frame to use as the thumbnail image.

Parameters

DescriptionTypeName

Sets in the time (in milliseconds fromvideo start) for the frame you want to use

xsd:longthumbnailTime

for the video thumbnail. Values rangefrom 0 to the end of the video.

Note: The system uses the firstframe of the video for the thumbnailif 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

DescriptionTypeName

Controls ZIP and TAR archive fileprocessing. Provides 2 options:

xsd:stringprocess

• None: Process as master assets.• UnCompress: Extract and process

contents.

Note: String constants are casesensitive. Use UnCompress, notuncompress or unCompress.

280Data types

Example

 <element name="unCompressOptions" type="types:UnCompressOptions" minOccurs="0"/> <complexType name="UnCompressOptions"> <sequence>  <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".

DescriptionTypeName

Controls contrast applied to edge pixels.xsd:doubleamount

• Range: 0.0 - 5.0• Default: 0

Controls sharpness by setting the number of pixelsaround the edge of an image. The correct valuedepends on the size of the image.

xsd:doubleradius

• Range: 0.0 - 250.0• Low values sharpen edge pixels only.• High values sharpen a wider band of pixels.

Determines how different pixels must be from thesurrounding area before they are considered edgepixels and can be sharpened.

xsd:intthreshold

• Range: 0 - 255 (integers only).• Default: 6

Values include 0 or 1 only.xsd:intmonochrome

281Data types

DescriptionTypeName

Set to 0 to apply to each color component separatelyor to 1 to apply to image brightness (intensity) only.The layer mask or composite mask is sharpened aswell .

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

DescriptionTypeName

Automatic image crop options (based oncolor).

types:AutoColorOptionsautoColorOptions


types:AutoSetCreateOptionsautoSetCreationOptions





282Data types

DescriptionTypeName

Whether to create a mask when uploading.xsd:booleancreateMask

IPS folder for the files.xsd:stringdestFolder


Options for uploading Illustrator files tothe image server.


Whether to include subfolders whenuploading.

xsd:stringincludeSubfolders

Options for uploading InDesign files tothe server.





Optional.

See KnockoutBackgroundOptions.

Manual image crop options.types:ManualCropOptionsmanualCropOptions

Options that let you set a thumbnail imagefrom the video.

types:MediaOptionsmediaOptions

See MediaOptions.

File upload overwrite options.xsd:stringoverwrite

Options for uploading PDF files to theimage server.


Options for uploading Photoshop files tothe image server.


The URL of the file upload destination.xsd:stringpostHttpUrl

Details for an image rendering publish jobthat runs after the upload is complete.

types:ImageRendingPublishJobpostImageRenderingPublish

Job

283Data types

DescriptionTypeName

Details for an image serving publish jobthat runs after the upload is complete.


Whether to upload only files.xsd:booleanpostJobOnlyIfFiles

Options for uploading Post Script files tothe image server.


Details for a video publish job that runsafter the upload is complete.


Controls preservation of any existing cropdefinition. Defaults to true.

xsd:booleanpreserveCrop



overwriting. If not set, the company defaultsetting is used.

Whether to process separate metadataXML files for this job.

xsd:stringprocessMetadataFiles

Array of project handles.types:HandleArrayprojectHandleArray

Determines if files are marked ready forpublishing.


Source upload directory.xsd:stringserverDir

Extract and process the contents ofuploaded TAR/ZIP files with theseoptional settings.

types:UnCompressOptionsunCompressOptions

See UnCompressOptions.

Options that let you control unsharp masksettings when creating an optimized


pyramid TIF file. Use these settings to helpimprove image sharpness.


An additional metadata option foreverything in the upload job

xsd:stringxmpKeywords

284Data types

Notes

For CropOptions, you can choose only one of the following:


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


Options for automatic cropsof images based on color.

Notypes:AutoColorCropOptionsautoColorCropOptions

Array of automatic setgeneration scripts to applyto uploaded files.

Notypes:AutoSetCreateOptionsautoSetCreationOptions

Removes white space fromthe edges of images, basedon transparency.

Notypes:AutoTransparentCropOptionsautoTransparentCropOptions

Options that you can specifyduring an upload. The set

Notypes:ColorManagementOptionscolorManagementOptions

affects how the color ismanaged for the upload.

Whether to create a mask.Yesxsd:booleancreateMask

Choice of email settings.Yesxsd:stringemailSetting

Options for uploadingInDesign files to the ImageServer.

Notypes:InDesignOptionsinDesignOptions

285Data types


Options for uploadingIllustrator files to the ImageServer.

Notypes:IllustratorOptionsIllustratorOptions

Mask the background forselected images. This lets you

Notypes:KnockoutBackgroundOptionsknockoutBackground

overlay them in other layerswith a transparency outsideof subject image. Optional.

SeeKnockoutBackgroundOptions.

Options for manual crops ofimages.

Notypes:ManualCropOptionsmanualCropOptions

Options that let you set athumbnail image from thevideo.

Notypes:MediaOptionsmediaOptions

See MediaOptions.

Whether to overwrite fileswhen uploading.

Yesxsd:booleanoverwrite

Options for uploading PDFfiles to the Image Server.

Notypes:PDFOptionspdfOptions

Options for uploadingPhotoshop files to the ImageServer.

Notypes:PhotoshopOptionsphotoshopOptions

The URL where the files arebeing uploaded.

Noxsd:stringpostHttpUrl

Options for uploading PostScript files to the ImageServer.

Notypes:PostScriptOptionspostScriptOptions

Controls preservation of anyexisting crop definition.Defaults is true.

Noxsd:booleanpreserveCrop

Controls whether thepublish state of an existing

Yesxsd:booleanpreservePublishState

286Data types


asset is preserved whenoverwriting. If not set, thecompany default setting isused.

Array of project handles.Notypes:HandleArrayprojectHandleArray

Whether the files are markedready for publishing.

Yesxsd:booleanreadyForPublish

Extract and process thecontents of uploaded

Notypes:UnCompressOptionsunCompressOptions

TAR/ZIP files with theseoptional settings.

See UnCompressOptions.

Options that let you controlunsharp mask settings when

Notypes:UnsharpMaskOptionsunsharpMaskOptions

creating an optimizedpyramid TIF file. Use thesesettings to help improveimage sharpness.


An additional metadataoption for everything in theupload job.

Noxsd:stringxmpKeywords

UploadUrl

For uploading assets via URL.

Parameters

DescriptionTypeName

The source URL the asset is uploadedfrom.

xsd:stringsourceUrl

The IPS file path and name of the file youwant to upload to.

xsd:stringdestPath

287Data types

UploadUrlArray

An array of URL for uploading assets.

Parameters

DescriptionTypeName

An array of URLs for uploading assets.types:UploadUrlitems

UploadUrlsJob

Uploads URLs from the location where you want to get files.

Parameters

DescriptionTypeName

Options for automatic crops of imagesbased on color.

types:AutoColorCropOptionsautoColorCropOptions





Whether to create a mask.xsd:booleancreateMask




Options for uploading Illustrator files tothe Image Server.

types:IllustratorOptionsIllustratorOptions

Options for uploading InDesign files tothe server.




with a transparency outside of subjectimage. Optional.SeeKnockoutBackgroundOptions.

Options for manual crops of images.types:ManualCropOptionsmanualCropOptions

Options that let you set a thumbnail imagefrom the video. See MediaOptions.

types:MediaOptionsmediaOptions

Returns the number of URLs submitted ina job. Used by getActiveJobs andgetScheduledJobs.

xsd:intnumUrls

288Data types

DescriptionTypeName

Whether to overwrite files whenuploading.

xsd:booleanoverwrite

Options for uploading PDF files to theImage Server.


Options for uploading Photoshop files tothe Image Server.


The URL where the files are beinguploaded.

xsd:stringpostHttpUrl

Details for an image rendering publish jobthat runs after the upload is complete.

types:ImageRendingPublishJobpostImageRenderingPublishJob

All media options.types:ImageServingPublishJobpostImageServingPublishJob

Options for uploading Post Script files tothe Image Server.


Details for a video publish job that runsafter the upload is complete.


Controls preservation of any existing cropdefinition. Defaults to true

xsd:booleanpreserveCrop



overwriting. If not set, the company defaultsetting is used.

Array of project handles.types:HandleArrayprojectHandleArray

Whether the files are marked ready forpublishing.


Extract and process the contents ofuploaded TAR/ZIP files with theseoptional settings. See UnCompressOptions.

types:UnCompressOptionsunCompressOptions

Options that let you control unsharp masksettings when creating an optimized


pyramid TIF file. Use these settings to helpimprove image sharpness. SeeUnsharpMaskOptions.

An array of URLs that you want to upload.xsd:UrlArrayurlArray

An additional metadata option foreverything in the upload job.

xsd:stringxmpKeywords

Notes

For CropOptions, you can choose only one of the following:


289Data types

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

DescriptionTypeName

The list of URLs to invalidate. Limited tomaximum of 1000 URLs by the WSDLdefinition.

xsd:stringitems

User

A user of resources and types in the system.

Parameters

DescriptionTypeName

User handle.xsd:stringuserHandle

User first name.xsd:stringfirstName

User last name.xsd:stringlastName

email address.xsd:stringemail

Sets the role for a user in each companythey belong to. However, the user roleIpsAmin overrides other user roles.

xsd:stringdefaultRole

Determines if the user is valid.xsd:booleanisValid

Sets password expiration date.xsd:dateTimepasswordExpires

UserArray

An array of users.

290Data types

Parameters

DescriptionTypeName

An array of users.types:Useritems

VideoCaptionInfo

Video caption properties

Parameters

DescriptionTypeName

Relative path to the uploaded video.xsd:stringoriginalPath

Name of the original video.xsd:stringoriginalFile


VideoInfo

Video asset properties.

Parameters

DescriptionTypeName

Relative path to the uploaded video.xsd:stringoriginalPath

Name of the original video file.xsd:stringoriginalFile


Relative path to the video file.xsd:stringimagePath

File name of the video file.xsd:stringimageFile

Path to the IPS optimized video file.xsd:stringoptimizedPath

File name of the IPS optimized video file.xsd:stringoptimizedFile

VideoPublishJob

Publishes files to the configured video publish servers.

Parameters

DescriptionTypeName


291Data types

DescriptionTypeName



ViewerPresetInfo

Properties of a viewer preset asset.

Parameters

DescriptionTypeName

Choice of viewer type.xsd:stringtype

Viewer configuration settings array.types:ConfigSettingArrayconfigSettingArray

ViewerSwfInfo

Properties of a viewer SWF file asset.

Parameters

DescriptionTypeName

Relative path to the originally uploadedviewer SWF file.

xsd:stringoriginalPath

File name of the original viewer SWF file.xsd:stringoriginalFile


VignetteInfo

Properties of a vignette asset.

Parameters

DescriptionTypeName

Path to the file.xsd:stringoriginalPath



Path to the image.xsd:stringimagePath

xsd:stringimageFile

Optimized path to the file.xsd:stringoptimizedPath

Optimized file name.xsd:stringoptimizedFile

292Data types

WatermarkInfo

Properties of a watermark asset.

Parameters

DescriptionTypeName

Image server URL that represents thetemplate.

xsd:stringurl



WindowCoveringInfo

Properties of a window covering file.

Parameters

DescriptionTypeName




Relative path to the image.xsd:stringimagePath

File name of the window covering image.xsd:stringimageFile

Optimized path to the file.xsd:stringoptimizedPath

Optimized file name.xsd:stringoptimizedFile

WordInfo

Properties of a Word file.

Parameters

DescriptionTypeName




293Data types

XmlInfo

Properties of an XML file asset.

Parameters

DescriptionTypeName




XmpKeywords

The extensible metadata platform keywords of an asset.

Parameters

DescriptionTypeName

A comma-separated list of keywords thatget merged into the dc:subject= XMP

xsd:stringitems

property node. If a comma appears in anyof the individual values, it needs to beescaped by a backslash (\) character. Aliteral backslash is the usualdouble-backslash (\\).

XslInfo

Properties of an XML transformation file asset.

Parameters

DescriptionTypeName




ZipEntry

An entry in a ZIP file.

294Data types

Parameters

DescriptionTypeName

Entry name.xsd:stringname

Determines if the entry is a directory.xsd:booleanisDirectory

Date and time of last modification.xsd:dateTimelastModified

Compressed size.xsd:longcompressedSize

Uncompressed size.xsd:longuncompressedSize

ZipEntryArray

An array of ZIP entries.

Parameters

DescriptionTypeName

An array of ZIP entries.types:ZipEntryitems

ZipInfo

Properties of a ZIP archive asset.

Parameters

DescriptionTypeName




ZoomTarget

Properties of a Zoom target.

Parameters

DescriptionTypeName

Zoom target handle.xsd:stringzoomTargetHandle

Zoom target name.xsd:stringname

The X position of the zoom target.xsd:intxPosition

The Y position of the zoom target.xsd:intyPosition

Zoom target width.xsd:intwidth

295Data types

DescriptionTypeName

Zoom target height.xsd:intheight

User data associated with the Zoomtarget.

xsd:stringuserData

Allows Zoom targets associated with anasset to be ordered based on position

xsd:intposition

Date of last modification.xsd:dateTimelastModified

ZoomTargetArray

An array of Zoom targets.

Parameters

DescriptionTypeName

Array of Zoom targets.types:ZoomTargetitems

ZoomTargetDefinition

Zoom target definition.

Parameters

DescriptionTypeName

Target name.xsd:stringname

The X position of the zoom target.xsd:intxPosition

The Y position of the zoom target.xsd:intyPosition

Zoom target width.xsd:intwidth

Zoom target height.xsd:intheight

Associated user data.xsd:stringuserData

ZoomTargetDefinitionArray

Parameters

DescriptionTypeName

An array of Zoom target definitions.types:ZoomTargetDefinitionitems

296Data types

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

297String constants

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

298String constants

• 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

299String constants

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

300String constants

• 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

301String constants

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

302String constants

• 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

303String constants

• 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

304String constants

• 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

305String constants

• 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

306String constants

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

307String constants

Profile Classes

Used by IccProfileFieldUpdate/class.

Values

• Input• Display• Output• DeviceLink• ColorSpaceConversion• Abstract• NamedColor

Publish State

Used by searchAssetsParam/publishState, setAssetPublishStateParam/publishState andContextStateUpdate/publishState.

Values

• MarkedForPublish• NotMarkedForPublish

Property Set Types

Used by PropertySetType

Values

• UserProperty• CompanyProperty• UserCompanyProperty

Publish Context

Used by getActivePublishContextsReturn/publishContext.

Values


Publish Types

Used by ImageServingPublishJob/publishType.

308String constants

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, andsearchAssetsParam/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

309String constants

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

310String constants

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

311String constants

Faults

authenticationFault

Thrown when a user cannot be authenticated.

Fault Types

FaultID

AUTHENTICATION_FAULT_CODE_NO_CREDENTIALS10000

AUTHENTICATION_FAULT_CODE_INVALID_CREDENTIALS10001

AUTHENTICATION_FAULT_CODE_INVALID_USER10002

Fault Fields

DescriptionTypeName

Fault IDxsd:intcode

An informative message describing thefault.

xsd:stringreason

authorizationFault

Thrown when an authenticated user has insufficient permissions to accomplish a task.

Fault Types

FaultID

AUTHORIZATION_FAULT_CODE_INVALID_COMPANY20000

AUTHORIZATION_FAULT_CODE_INVALID_REQUEST_USERNAME20001

AUTHORIZATION_FAULT_CODE_INVALID_REQUEST_USER20002

AUTHORIZATION_FAULT_CODE_NO_OPERATION_PERMISSION20003

AUTHORIZATION_FAULT_CODE_NO_IMPERSONATION_PERMISSION20004

AUTHORIZATION_FAULT_CODE_ILLEGAL_PARAMETER_VALUE20005

AUTHORIZATION_FAULT_CODE_ILLEGAL_COMPANY20006

AUTHORIZATION_FAULT_CODE_ILLEGAL_REQUEST_USER20007

AUTHORIZATION_FAULT_CODE_ILLEGAL_ACCESS_GROUP20008

AUTHORIZATION_FAULT_CODE_MISSING_PERMISSION20009

312Faults

Fault Fields

DescriptionTypeName

Fault IDxsd:intcode

An informative message describing thefault.

xsd:stringreason

ipsApiFault

Fault Types

FaultID

IPS_API_FAULT_CODE_EXCEPTION30000

IPS_API_FAULT_CODE_INVALID_PARAMETER30001

IPS_API_FAULT_CODE_MISSING_PARAMETER30002

IPS_API_FAULT_CODE_INVALID_REQUEST_XML30003

Fault Fields

DescriptionTypeName

Fault IDxsd:intcode

An informative message describing the fault.xsd:stringreason

313Faults

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

314Change log

• 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 tocompanyHandleArray.

• 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:

315Change log

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


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.


Describes new and changed data types for the IPS API version 4.5.

316Change log

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 developedapplications.

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

317Change log

• 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

318Change log

• 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



New Operations

• batchSetFontFields• batchSetIccProfileFields• createAssetSet• getAssetMetadataFields• getAssetSetDefinitions

Modified Operations

SearchAssets

Parameters added:

• assetSubtypeArray• excludeByproductArray• strictSubTypeCheck



New Types

• AssetMetadataFields• AssetMetadataFieldsArray• AssetSetInfo• AutoSetCreationOptions• ExcludeByproductCondition• ExcludeByproductArray• FontFieldUpdate• FontFieldUpdateArray• IccProfileFieldUpdate• IccProfileFieldUpdateArray

319Change log

Modified Types

Asset

Parameters added:

• subtype• assetSetInfo

JobLog

Parameters added:

• transferSuccessCount• transferErrorCount• transferWarningCount

PDFInfo

Parameters added:

• extractLinks

String Constants: New and Modified


New Constants

• AssetSet• MasterVideo• ColorSpaces• FontStyles• FontTypes• ProfileClasses

Version 4.2



New Types

• AudioInfo• CuePointInfo• PdfSettings• PremeierExpressRemixInfo

Modified Types

Asset

Parameters added:

320Change log

• 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 toipsApiService.log.

Added an optional serviceUrl param to the WSDL generation servlet. This is particularly useful for debug proxies. Forexample: http://<server>/scene7/webservice/IpsApi-2008-01-15.wsdl?serviceUrl=http://localhost:8081

Implemented getZipEntries operation.

321Change log

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 (InternalServer 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/updateVignettePublishFormatoperations.

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 beAdjustedView 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 PDFripped 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

322Change log

• 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 controlprocess 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 maintainbackward compatibility.

Implemented getAssociatedAssets operation.

Added ReprocessAssets job type to allow reprocessing of previously uploaded master files, including reripping PDFs andreoptimizing images.

Renamed PropertySetType field type to propertyType. This affects the createPropertySetType parameter andgetPropertySetType/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

323Change log

• 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 activepublish 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 formattedas <language_code>[-<country_code>]. The language code is a lowercase, two-letter code as specified by ISO-639, andthe 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 notpresent, the HTTP header Accept-Language will be used. If this header is also not present, the default locale for the IPS serverwill 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.

324Change log

• 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 rangeoperations (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 numericrange 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 rangeoperations (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 theupload path.

In addition, the following fields are not included with both getJobLogs and getJobLogDetails. In prior versions they wereonly 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 intoseparate 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:

DescriptionAsset type

Adobe Illustrator file.Illustrator

EPS and PostScript files.PostScript

Microsoft Word document for files ending with .doc.WordDoc

Microsoft Excel document for files ending with .xls.ExcelDoc

325Change log

DescriptionAsset type

Microsoft PowerPoint document for files ending with .ppt.PowerPointDoc

RTF file for files uploaded ending with .rtf.RTFDoc

Added additional options to UploadDirectoryJob and UploadUrlsJob to control processing of Postscript, Illustrator, andPDF files independently. All existing jobs will provide the necessary parameters to the each of the 3 processing pipelines so thatthey will function exactly as done today. The original PostScriptOptions block is used to set the processing for Illustratorand EPS/PS files. Optionally, specific file options blocks can be supplied to specify processing. The list of changes includes:

DescriptionValueParameterField

processPostScriptOptions • Only manage the asset anddo not create any derivativesupon upload.

• None

• Rasterize(default)

• Render the EPS andPostScript file into an imageat the prescribed resolutionand color space.

Takes effect when rasterizingthe file into an image. It will

<boolean>alpha

Optional.create a transparent back-ground if the original file isdefined in this way foroverlaying logos.

processIllustratorOptions • Only manage the asset anddo not create any derivativesupon upload.

• None• Rasterize (default)

• Render the file into an imageat the prescribed resolutionand color space.

Rasterizing resolution.<integer>resolution

Target color space forrendering.

colorspace

Takes affect when rasterizingthe file into an image. Creates

alpha

Optional.a transparent background if

326Change log

DescriptionValueParameterField

the original file is defined inthis way for creating overlayinglogos.

processPDFOptions • Only manage the asset anddo not create any derivativesupon upload.

• None

• Rasterize (default)

• Render the file into an imageat the prescribed resolutionand color space.

Rasterizing resolution.<integer>resolution

Target color space forrendering.

colorspace

Defines whether to combine amultiple page PDF into an

<boolean>pdfCatalog

eCatalog after rendering(default is true).

Defines whether words fromthe PDF are extracted into the

<boolean>extractSearchWords

DB for later supplying to asearch server (default is false).

You can also query from getScheduledJobs.

Modified the webservice.gzip.response configuration property to take one of the following values:

DescriptionValue

Do not gzip response.never

Gzip response only if authHeader/gzipResponse is true.soap

Gzip if authHeader/gzipResponse is true, or no gzipResponseheader is present and HTTP Accept-Encoding header includesgzip. (Default).

accept

Always gzip response, regardless of header values. Use thisvalue only for debugging purposes.

always

327Change log

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.



New Types

• ImageSetMember• ImageSetMemberArray• ImageSetMemberUpdate• ImageSetMemberUpdateArray

Modified Types

ZoomTarget

Fields added:

• name• userData


Describes new and changed string constants for the IPS API version 3.8.

328Change log

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



New Operations

• moveAsset

• renameAsset

• deleteAsset

• createFolder

• deleteFolder

• getActiveJobs

• getScheduledJobs

• getJobLogs

• getJbLogDetails

• submitJob

• stopJob

• pauseJob

• resumeJob

• executeJob

• deleteJob

Modified Operations

searchAsset

329Change log

• Removed name parameter.

• Added excludeFieldArray.

getFolders

• Added excludeFieldArray.

getFolderTree

• Added excludeFieldArray and getUniqueMetadataValues.

• Made fieldHandle a required parameter.



New Types

• ZipInfo• MetadataUpdate• MetadataUpdateArray• ActiveJob• ActiveJobArray• ScheduledJob• ScheduledJobArray

Modified Types

Asset

• Added ZipInfo.


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

330Change log

Modified Constants

Asset Types

• Added Zip.

331Change log

Uploading assets by way of HTTP POSTs to the UploadFileServletUploading assets into Scene7 Production System involves one or more HTTP POST requests that set up a job to coordinate allthe log activity associated with the uploaded files.

Use the following URL to access the UploadFile Servlet:

https://<server>/scene7/UploadFile


Access URLs for Scene7 regions

Staging URL (use for pre-productiondevelopment and testing)

Production URLGeographic location

https://s7sps1ssl-staging.scene7.com/scene7/UploadFilehttps://s7sps1ssl.scene7.com/scene7/UploadFileNorth America

https://s7sps3ssl-staging.scene7.com/scene7/UploadFilehttps://s7sps3ssl.scene7.com/scene7/UploadFileEurope, Middle East, Asia

https://s7sps5ssl-staging.scene7.com/scene7/UploadFilehttps://s7sps5ssl.scene7.com/scene7/UploadFileJapan/Asia Pacific

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:


DescriptionHTTP POST formparts

Required.auth

An XML authHeader document specifying authentication and client information.

See Request authentication under SOAP.

Required.uploadParams

An XML uploadPostParams document specifying the upload parameters.

DescriptionTypeuploadPostParams elementname

Required.xsd:stringcompanyHandle

332Uploading assets by way of HTTP POSTs to theUploadFile Servlet



Handle to the company to which the fileis being uploaded.

Either jobName or jobHandle isrequired.

xsd:stringjobName

Name of the upload job.

Either jobName or jobHandle isrequired.

xsd:stringjobHandle

Handle to an upload job started in aprevious request.

Optional.xsd:stringlocale

Language and country code forlocalization.

Optional.xsd:stringdescription

Description of job.

Optional.xsd:stringdestFolder

Target folder path to prefix to filenameproperty, particularly for browsers andother clients that may not support fullpaths in filename.

Optional.xsd:stringfileName

Name of the target file. Overrides thefilename property.

Optional.xsd:booleanendJob

Default is false.

True if this is the last request for the job.

Optional if this is a subsequent requestfor an existing active job. If there is an

types:UploadPostJobuploadParams




existing job, uploadParams is ignoredand the existing job upload parametersare used.

See UploadPostJob.

Optional.file params

You can include one or more files to upload with each POST request. Each file part can include afilename parameter in the Content-Disposition header that is used as the target filename in IPS if nouploadPostParams/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 notthe 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 tosimplify subsequent job status polling and job log queries. Additional POST requests for the same upload job should specify thejobHandle 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 forthis job. In turn, this allows the job to complete immediately after all POSTed files are ingested. Otherwise, the job times out ifno 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 thefollowing:

<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 forthe same job. You can also use it to poll job status with the getActiveJobs operation or to query the job logs with thegetJobLogDetails 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.


Example POST request

POST /scene7/UploadFile HTTP/1.1User-Agent: Jakarta Commons-HttpClient/3.1Host: localhostContent-Length: 362630Content-Type: multipart/form-data; boundary=O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ

--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJContent-Disposition: form-data; name="auth"Content-Type: text/plain; charset=US-ASCIIContent-Transfer-Encoding: 8bit

<authHeader xmlns="http://www.scene7.com/IpsApi/xsd/2014-04-03"> <user>[email protected]</user> <password>*</password> <locale>en-US</locale> <appName>MyUploadServletTest</appName> <appVersion>1.0</appVersion> <faultHttpStatusCode>200</faultHttpStatusCode> </authHeader>

--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJContent-Disposition: form-data; name="uploadParams"Content-Type: text/plain; charset=US-ASCIIContent-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-1Content-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-1Content-Transfer-Encoding: binary<file bytes ... >--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ--


Example POST response – success

HTTP/1.1 200 OKContent-Type: text/xml;charset=utf-8Content-Length: 204Date: Mon, 25 Jul 2016 19:43:38 GMTServer: 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 OKContent-Type: text/xml;charset=utf-8Content-Length: 210Date: Mon, 25 Jul 2016 19:43:38 GMTServer: 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>


adobe experience cloud ips api · the ips web service is supported by a set of wsdl (web services...

Documents