getAssociatedAssets

取得與指定資產相關聯的資產,以及其關係的詳細資訊。

語法

授權的使用者類型

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

參數

輸入(getAssociatedAssetsParam)

名稱

類型

必要

說明

companyHandle

xsd:string

處理擁有資產的公司。

assetHandle

xsd:string

資產控制代碼。

responseFieldArray

類型:StringArray

所需的回應欄位陣列。 請參閱簡介中的response- FieldArray/excludeFieldArray。

excludeFieldArray

類型:StringArray

排除的回應欄位陣列。 請參閱簡介中的response- FieldArray/excludeFieldArray。

輸出(getAssociatedAssetsReturn)

名稱

類型

必要

說明

containerArray 類型:AssetArray

包含指定資產的集合和範本資產陣列。

memberArray 類型:AssetArray

指定集或範本資產包含的資產陣列。

layerReferenceArray 類型:AssetArray

圖層或範本URL中參考的資產陣列。

ownerArray 類型:AssetArray

擁有指定資產的資產陣列。

derivedArray 類型:AssetArray

用於產生指定資產的資產陣列。

generatorArray 類型:GenerationInfoArray

generatorArray列出此資產的建立方式。 例如,如果 assetHandler是PDF的影像頁面,則此頁面會包含PDF處理器工具並參考PdfFile資產。

generatedArray 類型:GenerationInfoArray

generatedArray會反轉此資產的建立方式。 例如,如果 generatedArray是PdfFile資產,則可包含從此 assetHandler產生的影像清單。

thumbAsset 類型:資產

與請求資產相關聯的縮圖資產資訊。 如果未指派縮圖資產,回應中會忽略欄位。

您可以使用參數responseFieldArrayexcludeFieldArray來限制回應大小。 特別是,在generatorArraygeneratedArray中返回的GenerationInfo項預設包含發起者和生成的資產記錄。 對於PDF資產類型,此行為會在回應中產生多份「創作者」PDF資產記錄的不想要副本。 您可以將generatedArray/items/originator新增至excludeFieldArray以消除此問題。 或者,您可以指定要包含在responseFieldArray中的響應欄位的明確清單。

範例

以下基本示例是對從PDF中提取的影像的生成器的句柄的請求。 它包含長度為containerArray的項目,其中包含PDF的assetHandle

請求

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

回答

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

上述範例的相反之處如下:

請求

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

回答

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

在下一個範例中,群組會新增至具有groupHandleArray的公司。 此範例僅使用一個群組。

請求

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

回答

無。

本頁內容