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

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

section-8946ea4b9cb94912a8408249c897f192

次の基本的な例は、PDFから抽出された画像のジェネレーターのハンドルに対するリクエストです。 PDFの assetHandle を含む containerArray 目を持つ長さの 1 が含まれます。

リクエスト

<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
4e9b9d8c-5839-4215-aa35-01b652869681