getAssociatedAssets

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

構文

許可されたユーザーの種類

  • 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[がた：AssetArray]

いいえ

指定したアセットを含むセットおよびテンプレートアセットの配列。

memberArray 型：AssetArray[がた：AssetArray]

いいえ

指定したセットまたはテンプレートアセットに含まれるアセットの配列。

layerReferenceArray 型：AssetArray[がた：AssetArray]

いいえ

レイヤーまたはテンプレートURLで参照されているアセットの配列。

ownerArray 型：AssetArray[がた：AssetArray]

いいえ

指定したアセットを所有するアセットの配列。

derivedArray 型：AssetArray[がた：AssetArray]

いいえ

指定したアセットの生成に使用されたアセットの配列。

generatorArray 型：GenerationInfoArray[がた：GenerationInfoArray]

いいえ

generatorArrayに、このアセットの作成方法が示されます。 例えば、 assetHandlerがPDFの画像ページだった場合は、PDF処理ツールが含まれ、PdfFileアセットが参照されます。

generatedArray 型：GenerationInfoArray[がた：GenerationInfoArray]

いいえ

generatedArrayは、このアセットの作成方法を反転します。 例えば、このアセットがPdfFileアセットの場合、 generatedArrayには、この assetHandlerから生成された画像のリストを含めることができます。

thumbAsset タイプ：アセット

いいえ

リクエストアセットに関連付けられているサムアセット情報。 サムのアセットが割り当てられていない場合、フィールドは応答で省略されます。

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

例

次の基本的な例は、PDFから抽出された画像のジェネレーターのハンドルに対する要求です。 長さ1の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を持つ会社にグループが追加されます。 この例では、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>

応答

なし

このページ