新增和变更
创建对象:
- 开发人员
- 管理员
介绍IPS API v4.0的新更改和已实施的更改。
使用单独的WSDL和架构命名空间并排实施的API版本。
- 早期API版本:
IpsApi.wsdl, http://www.scene7.com/IpsApi/xsd
。 - SPS 4.0版本:
IpsApi-2008-01-15.wsdl, http://www.scene7.com/IpsApi/xsd/2008-01-15
。
已添加PostScriptOptions/alpha
字段。
已为getProperty
操作添加VideoRootUrl
和SwfRootUrl
属性。
已将可选appName
和appVersion
参数添加到authHeader
以跟踪调用应用程序。 已将日志记录添加到ipsApiService.log
。
向WSDL生成Servlet添加了可选的serviceUrl
参数。 此参数对于调试代理很有用。 例如: http://<server>/scene7/webservice/IpsApi-2008-01-15.wsdl?serviceUrl=http://localhost:8081
已实施getZipEntries
操作。
已实施搜索范围并键入系统字段条件的比较值。
添加了'Asset'
资源类型字符串常量,主要是为了允许跨资源元数据字段。
已为searchAssets
实施trashState
参数。
已实施getAssetPublishHistory
操作。
添加了可选的faultHttpStatusCode
SOAP标头,以便在Flex中启用错误处理。 对于Flex,请使用<faultHttpStatusCode>200</faultHttpStatusCode>
。 错误响应的默认状态代码为500 (Internal Server Error)
。
添加了从垃圾桶中还原资源以及从垃圾桶中还原空资源的操作。
实施了CRUD操作。
已将启用的标志添加到ImageMap
类型和saveImageMap
操作。
添加了对优化剩余文件作业的支持。
添加了setAssetsPublishState
以进行批量发布状态更新。
已添加ImageServingPublishSettings
、getImageServingPublishSettings
、setImageServingPublishSettings
。
已弃用saveMetadataField
操作以支持新的createMetadataField
和updateMetadataField
操作。
已实施deleteAssetsParam
批次删除操作。
已实施moveAssetsParam
批次移动操作。
已实施deleteMetadataField
操作。
已实施get/setImageRenderingPublishSettings
、get/set/create/updateVignettePublishFormat
操作。
已实现getAssetCounts
。
添加了对setImageSetMembers
的支持,以便在ImageSet
资源中包含RenderSet
个成员。
添加了replaceImage
操作。
添加了copyImage
操作。
已为LayerViewInfo
、TemplateInfo
和WatermarkInfo
添加setUrlModifier
操作和urlModifier/urlPostApplyModifier
字段。
添加了createDerivedAsset
操作。 当前,ownerHandle
必须引用图像资源,并且类型可以是AdjustedView
或LayerView
。
添加了createTemplate
操作。 调用以创建模板或水印资产。
IPS公司设置CompanySettings
已移植到Web服务API。
已将excludeByproducts
筛选器标志添加到searchAssets
操作。 将此标记设置为true将运行PSDlayer
个图像并PDF翻录的图像。
添加了getGenerationInfo
操作。
已将SystemMessage
属性名称添加到getProperty
操作。
修改了一些资源类型字符串常量,以匹配相应的资源信息字段。
- WordDoc: Word
- ExcelDoc: Excel
- PowerPointDoc: PowerPoint
- RTFDoc: Rtf
修改了批处理操作的结果格式,以汇总成功、警告和错误。
已实施batchSetAssetMetadata
批处理元数据操作。
为应用程序特定的数据实施了支持。
为上载作业实施了对createTemplate
、extendLayers
和extractText
的布尔标志的支持,以控制Photoshop处理的过程(与添加文件上载的更改类似)。
已实施setImageMaps
和setZoomTargets
操作。
已实施ViewerPreset
操作。 可识别的类型包括:
VideoPlayer
(视频仅发布这些查看器。)Brochure
BasicZoom
AdvancedZoom
Spin
Custom types
查看器外观支持两个参数: skinFg
和skinBg
。 后端代码执行保持向后兼容性所需的所有处理。
已实施getAssociatedAssets
操作。
添加了ReprocessAssets
作业类型,以允许重新处理以前上载的主源文件,包括重新翻录PDF和重新优化图像。
已将PropertySetType
字段类型重命名为propertyType
。 此重命名会影响createPropertySetType
参数和getPropertySetType/getPropertySetTypes
响应。
已实施batchSetImageFields
操作以支持设置图像用户数据和其他可编辑的图像字段。
47已将fileSize字段添加到各种资源信息类型:
VignetteInfo
CabinetInfo
WindowCoveringInfo
IccProfileInfo
FontInfo
XslInfo
ViewerSwfInfo
XmlInfo
SvgInfo
ZipInfo
VideoInfo
AcoInfo
PdfInfo
PsdInfo
FlashInfo
InDesignInfo
PostScriptInfo
IllustratorInfo
WordInfo
ExcelInfo
PowerPointInfo
IllustratorInfo
WordInfo
ExcelInfo
PowerPointInfo
RTFInfo
已实施getActivePublishContexts
操作。 此操作返回具有指定公司的活动发布服务器的发布上下文名称数组。 当前发布上下文名称为:
ImageServing
ImageRendering
Video
已实施getSearchStrings
操作。 它会返回给定资源的搜索字符串数组。
为作业添加了区域设置参数,并增加了设置API操作区域设置的机制。 区域设置字符串的格式应为<language_code>[-<country_code>]
。 语言代码是由ISO-639指定的小写形式的双字母代码,而可选国家/地区代码是由ISO-3166指定的大写形式的双字母代码。
向authHeader
SOAP标头添加了可选的区域设置参数,以设置API操作的区域设置。 如果此参数不存在,则使用HTTP标头Accept-Language
。 如果此标头也不存在,则使用IPS服务器的默认区域设置。
为强类型元数据字段添加了get/set支持。
为gzip响应控制实施了SOAP和HTTP标头支持。
已将gzipResponse
标志添加到authHeader
。 如果不存在,则API会检查HTTP Accept-Encoding
标头。
添加了对强类型元数据字段条件的searchAssets的支持。
- 对于所有字段类型,可以使用字符串比较运算符(
Equals, NotEquals, Contains, NotContains, StartsWith, EndsWith
)传递值 - 对于布尔字段,可以使用
Equals
操作传递boolVal
。 - 对于Int字段,可以使用数字比较运算符(
Equals, NotEquals, LessThan, LessThanEquals, GreaterThan, GreaterThanEquals
)传递longVal
,或者可以使用数字范围运算(Between, NotBetween
)传递minLong/maxLong
。 - 对于Float字段,可以使用数字比较运算符(
Equals, NotEquals, LessThan, LessThanEquals, GreaterThan, GreaterThanEquals
)传递doubleVal
,或者可以使用数字范围运算(Between, NotBetween
)传递minDouble/maxDouble
。 - 对于日期字段,您可以通过数字比较运算符(
Equals, NotEquals, LessThan, LessThanEquals, GreaterThan, GreaterThanEquals
)传递dateVal
,或者您可以通过数字范围运算(Between, NotBetween
)传递minDate/maxDate。
已将描述jobSubType
和originalJobName
字段添加到JobLog
类型。
originalJobName
是提交给submitJob
的作业名称(没有任何唯一性后缀或后续作业名称)。jobSubType
仅由ImageServingPublishJob
个作业使用(其中是full
、increment, fullwithsearch,
或fulloverride
之一)。description
是所有作业类型的空字符串,但最终包含摘要作业信息,如上载路径。
此外,以下字段未同时包含在getJobLogs
和getJobLogDetails
中。 在以前的版本中,它们仅在getJobLogDetails
中可用。
endDate
(如果作业已完成)。fileDuplicateCount
(以前它始终为0
,带有getJobLogs
)fileUpdateCount
(以前始终为0
,带有getJobLogs
,并包含在fileSuccessCount
中;现在它被拆分为单独的字段)。
已将assetHandle字段添加到JobLogDetail
类型。
向submitJob
添加了可选描述参数。 传递此参数以在getScheduledJobs
、getActiveJobs
和getJobLogs
中进行检索。
已弃用SKU系统字段。 如果字段作为SystemFieldCondition
传递到searchAssets
,则忽略该字段。
已将excludeAssetTypeArray
筛选器添加到searchAssets
。
已将MaskInfo
类型添加到Asset
。
添加了可由IPS管理的新资产类型:
向UploadDirectoryJob
和UploadUrlsJob
添加了其他选项,以独立控制Postscript、Illustrator和PDF文件的处理。 所有现有作业都为三条处理管道中的每条管道提供必要参数,以便它们与今天完全相同。 原始PostScriptOptions
块用于设置Illustrator和EPS/PS文件的处理。 或者,可以提供特定的文件选项块来指定处理。 更改列表包括:
-
无
-
栅格化(默认)
-
仅管理资产,上传时不会创建任何衍生工具。
-
按照规定的分辨率和色彩空间将EPS和PostScript文件渲染到图像。
alpha
可选.
- 无
- 栅格化(默认)
-
仅管理资产,上传时不会创建任何衍生工具。
-
按照规定的分辨率和色彩空间将文件渲染为图像。
alpha
可选.
-
无
-
栅格化(默认)
-
仅管理资产,上传时不会创建任何衍生工具。
-
按照规定的分辨率和色彩空间将文件渲染为图像。
您还可以从getScheduledJobs
中查询。
已修改webservice.gzip.response
配置属性以采用以下值之一: