getAssetations

获取与指定资产关联的资产以及有关其关系的详细信息。

语法

授权用户类型

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

参数

输入(getAssociatedAssetsParam)

名称

类型

必需

说明

companyHandle

xsd:string

对资产所有者的公司进行处理。

assetHandle

xsd:string

资产句柄。

responseFieldArray

types:StringArray

所需的响应字段数组。 请参阅“简介”中的response- FieldArray/excludeFieldArray 。

excludeFieldArray

types:StringArray

排除的响应字段的数组。 请参阅“简介”中的response- FieldArray/excludeFieldArray 。

输出(getAssociatedAssetsReturn)

名称

类型

必需

说明

containerArray 类型:AssetArray

包含指定资产的集和模板资产数组。

memberArray 类型:AssetArray

指定集或模板资产包含的资产数组。

layerReferenceArray 类型:AssetArray

层或模板URL中引用的资产数组。

ownerArray 类型:AssetArray

拥有指定资产的资产数组。

derivedArray 类型:AssetArray

用于生成指定资产的资产数组。

generatorArray types:GenerationInfoArray

generatorArray列出了创建此资产的方式。 例如,如果 assetHandler是PDF的图像页面,则它将包含PDF处理器工具并引用PdfFile资产。

generatedArray types: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>

响应

无。

在此页面上