getAssociatedAssets getassociatedassets

指定したアセットに関連付けられているアセットとその関係に関する詳細を取得します。

構文

承認済みユーザータイプ 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 アセットを参照します。
が配列 を生成しました
タイプ:GenerationInfoArray
いいえ
generatedArrayは、このアセットの作成方法を反転します。 例えば、 generatedArrayには、PdfFile アセットの場合は、この assetHandlerから生成された画像のリストを含めることができます。
thumbAsset
種類:アセット
いいえ
リクエストアセットに関連付けられたサムアセット情報。 サムアセットが割り当てられていない場合、応答でこのフィールドは省略されます。

パラメーターresponseFieldArrayまたはexcludeFieldArrayを使用して、応答サイズを制限できます。 特に、generatorArrayまたはgeneratedArrayで返されるGenerationInfo項目は、デフォルトで、作成者と生成されたアセットレコードの両方を含みます。 PDF アセットタイプの場合、このビヘイビアーは、レスポンス内の「作成者」PDF アセットレコードの不要な複数コピーになります。 generatedArray/items/originatorexcludeFieldArrayに追加することで、この問題を解決できます。 または、responseFieldArrayに含める応答フィールドの明示的なリストを指定できます。

section-8946ea4b9cb94912a8408249c897f192

次の基本的な例は、PDFから抽出された画像のジェネレーターのハンドルに対するリクエストです。 長さcontainerArrayの項目1と、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の会社に追加されています。 この例では、1つのグループのみを使用します。

リクエスト

<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
dynamic-media-developer-resources-help-aem-ips-api