新增與變更 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

新增選用的serviceUrl引數至WSDL產生servlet。 此引數對於除錯代理程式非常有用。 例如: http://<server>/scene7/webservice/IpsApi-2008-01-15.wsdl?serviceUrl=http://localhost:8081

已實作getZipEntries作業。

針對系統欄位條件實作搜尋範圍並輸入比較值。

新增'Asset'個資產型別字串常數,主要用於允許跨資產中繼資料欄位。

已實作searchAssetstrashState引數。

已實作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作業。

已新增LayerViewInfoTemplateInfoWatermarkInfosetUrlModifier作業和urlModifier/urlPostApplyModifier欄位。

已新增createDerivedAsset作業。 目前ownerHandle必須參考影像資產,而且型別可以是AdjustedViewLayerView

已新增createTemplate作業。 呼叫以建立範本或浮水印資產。

IPS公司設定CompanySettings已移植到網站服務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 (先前一律為0getJobLogs
  • fileUpdateCount (先前一律為0getJobLogs並包含在fileSuccessCount中;現在會分割為個別欄位)。

已將assetHandle欄位新增至JobLogDetail型別。

已將選擇性描述引數新增至submitJob。 傳遞此引數以在getScheduledJobsgetActiveJobsgetJobLogs中擷取。

已棄用SKU系統欄位。 如果欄位作為SystemFieldCondition傳入searchAssets,則會忽略該欄位。

已新增excludeAssetTypeArray篩選器至searchAssets

已新增MaskInfo型別至Asset

新增IPS管理的資產型別:

資產類型
說明
Illustrator
Adobe Illustrator檔案。
PostScript
EPS和PostScript檔案。
WordDoc
以.doc結尾的檔案使用Microsoft® Word檔案。
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
<integer>
點陣化解析度。
colorspace
呈現的目標色域。

alpha

選擇性.

將檔案點陣化成影像時生效。 如果以這種方式定義原始檔案來建立重疊圖志,則建立透明背景。
PDFOptions
處理序
  • 點陣化 (預設)

  • 僅管理資產,上傳時不會建立任何衍生工具。

  • 以指定的解析度和色域將檔案演算為影像。

resolution
<integer>
點陣化解析度。
colorspace
呈現的目標色域。
pdfCatalog
<布林值>
定義是否要在呈現後將多頁PDF合併到eCatalog中(預設為true)。
extractSearchWords
<布林值>
定義是否將PDF中的字詞擷取到DB以供稍後提供給搜尋伺服器(預設為false)。

您也可以從getScheduledJobs查詢。

已修改webservice.gzip.response設定屬性以取得下列其中一個值:

說明
never
不使用gzip回應。
soap
只有在authHeader/gzipResponse為true時,才有Gzip回應。
accept
Gzip (如果authHeader/gzipResponse為true,或不存在gzipResponse標頭且HTTP Accept-Encoding標頭包含gzip)。 (預設)。
always
一律使用gzip回應,無論標頭值為何。 此值僅用於偵錯。
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681