新增和变更 new-additions-and-changes

介绍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操作添加VideoRootUrlSwfRootUrl属性。

已将可选appNameappVersion参数添加到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以进行批量发布状态更新。

已添加ImageServingPublishSettingsgetImageServingPublishSettingssetImageServingPublishSettings

已弃用saveMetadataField操作以支持新的createMetadataFieldupdateMetadataField操作。

已实施deleteAssetsParam批次删除操作。

已实施moveAssetsParam批次移动操作。

已实施deleteMetadataField操作。

已实施get/setImageRenderingPublishSettingsget/set/create/updateVignettePublishFormat操作。

已实现getAssetCounts

添加了对setImageSetMembers的支持,以便在ImageSet资源中包含RenderSet个成员。

添加了replaceImage操作。

添加了copyImage操作。

已为LayerViewInfoTemplateInfoWatermarkInfo添加setUrlModifier操作和urlModifier/urlPostApplyModifier字段。

添加了createDerivedAsset操作。 当前,ownerHandle必须引用图像资源,并且类型可以是AdjustedViewLayerView

添加了createTemplate操作。 调用以创建模板或水印资产。

IPS公司设置CompanySettings已移植到Web服务API。

已将excludeByproducts筛选器标志添加到searchAssets操作。 将此标记设置为true将运行PSDlayer个图像并PDF翻录的图像。

添加了getGenerationInfo操作。

已将SystemMessage属性名称添加到getProperty操作。

修改了一些资源类型字符串常量,以匹配相应的资源信息字段。

  • WordDoc: Word
  • ExcelDoc: Excel
  • PowerPointDoc: PowerPoint
  • RTFDoc: Rtf

修改了批处理操作的结果格式,以汇总成功、警告和错误。

已实施batchSetAssetMetadata批处理元数据操作。

为应用程序特定的数据实施了支持。

为上载作业实施了对createTemplateextendLayersextractText的布尔标志的支持,以控制Photoshop处理的过程(与添加文件上载的更改类似)。

已实施setImageMapssetZoomTargets操作。

已实施ViewerPreset操作。 可识别的类型包括:

  • VideoPlayer (视频仅发布这些查看器。)
  • Brochure
  • BasicZoom
  • AdvancedZoom
  • Spin
  • Custom types

查看器外观支持两个参数: skinFgskinBg。 后端代码执行保持向后兼容性所需的所有处理。

已实施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。

已将描述jobSubTypeoriginalJobName字段添加到JobLog类型。

  • originalJobName是提交给submitJob的作业名称(没有任何唯一性后缀或后续作业名称)。
  • jobSubType仅由ImageServingPublishJob个作业使用(其中是fullincrement, fullwithsearch,fulloverride之一)。
  • description是所有作业类型的空字符串,但最终包含摘要作业信息,如上载路径。

此外,以下字段未同时包含在getJobLogsgetJobLogDetails中。 在以前的版本中,它们仅在getJobLogDetails中可用。

  • endDate (如果作业已完成)。
  • fileDuplicateCount (以前它始终为0,带有getJobLogs
  • fileUpdateCount (以前始终为0,带有getJobLogs,并包含在fileSuccessCount中;现在它被拆分为单独的字段)。

已将assetHandle字段添加到JobLogDetail类型。

submitJob添加了可选描述参数。 传递此参数以在getScheduledJobsgetActiveJobsgetJobLogs中进行检索。

已弃用SKU系统字段。 如果字段作为SystemFieldCondition传递到searchAssets,则忽略该字段。

已将excludeAssetTypeArray筛选器添加到searchAssets

已将MaskInfo类型添加到Asset

添加了可由IPS管理的新资产类型:

资源类型
说明
Illustrator
Adobe Illustrator文件。
PostScript
EPS和PostScript文件。
WordDoc
Microsoft® Word文档,用于以.doc结尾的文件。
ExcelDoc
以.xls结尾的文件对应的Microsoft® Excel文档。
PowerPointDoc
以.ppt结尾的文件的Microsoft® PowerPoint文档。
RTFDoc
以.rtf结尾的上传文件的RTF文件。

UploadDirectoryJobUploadUrlsJob添加了其他选项,以独立控制Postscript、Illustrator和PDF文件的处理。 所有现有作业都为三条处理管道中的每条管道提供必要参数,以便它们与今天完全相同。 原始PostScriptOptions块用于设置Illustrator和EPS/PS文件的处理。 或者,可以提供特定的文件选项块来指定处理。 更改列表包括:

字段
参数
说明
PostScriptOptions
process
  • 栅格化(默认)

  • 仅管理资产,上传时不会创建任何衍生工具。

  • 按照规定的分辨率和色彩空间将EPS和PostScript文件渲染到图像。

alpha

可选.

<布尔值>
在将文件栅格化为图像时生效。 如果以这种方式定义原始文件以覆盖徽标,则它会创建透明背景。
IllustratorOptions
进程
  • 栅格化(默认)
  • 仅管理资产,上传时不会创建任何衍生工具。

  • 按照规定的分辨率和色彩空间将文件渲染为图像。

resolution
<整数>
栅格化分辨率。
colorspace
用于渲染的目标颜色空间。

alpha

可选.

在将文件栅格化为图像时生效。 如果以这种方式定义原始文件以创建覆盖徽标,则创建透明背景。
PDFOptions
进程
  • 栅格化(默认)

  • 仅管理资产,上传时不会创建任何衍生工具。

  • 按照规定的分辨率和色彩空间将文件渲染为图像。

resolution
<整数>
栅格化分辨率。
colorspace
用于渲染的目标颜色空间。
pdfCatalog
<布尔值>
定义是否在呈现后将多页PDF合并到eCatalog中(默认值为true)。
extractSearchWords
<布尔值>
定义是否将来自PDF的单词提取到数据库中以供以后提供给搜索服务器(默认值为false)。

您还可以从getScheduledJobs中查询。

已修改webservice.gzip.response配置属性以采用以下值之一:

说明
never
不使用gzip响应。
soap
仅当authHeader/gzipResponse为true时,才出现Gzip响应。
accept
如果authHeader/gzipResponse为true,或者不存在gzipResponse标头并且HTTP Accept-Encoding标头包含gzip,则为gzip。 (默认)。
always
始终gzip响应,不考虑标头值。 此值仅用于调试目的。
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681