文档Dynamic Media Image Production System API

getAssociatedAssets getassociatedassets

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 开发人员
  • 管理员

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

语法

授权用户类型 section-453cc706400345778713cda249bfac16

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

参数 section-d11d0dab59e94e89b466123a0ebfa82e

输入(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将反转此资源的创建方式。 例如，如果这是Pdf文件资源，则 generatedArray可能包含从此 assetHandler生成的图像列表。
thumbAsset
类型：资产
否
与请求资源关联的缩略图资源信息。 如果未分配缩略图资源，则响应中会忽略该字段。

您可以使用参数responseFieldArray或excludeFieldArray来限制响应大小。 特别是，generatorArray或generatedArray中返回的GenerationInfo项默认包含发起者和生成的资源记录。 对于PDF资源类型，此行为会导致响应中出现“创作者”PDF资源记录的多份不需要的副本。 您可以通过将generatedArray/items/originator添加到excludeFieldArray来消除此问题。 或者，您可以指定要包含在responseFieldArray中的响应字段的显式列表。

示例 section-8946ea4b9cb94912a8408249c897f192

以下基本示例是对从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>

响应

无。

recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681