DocumentationDynamic Media Image Production System API

getAssociatedAssets

Last update: Tue Jul 20 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Gets assets associated with a specified asset and details about their relationship.

Syntax

Authorized User Types

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

Parameters

Input (getAssociatedAssetsParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
Handle to the company that owns the asset.
assetHandle
xsd:string
Yes
Asset handle.
responseFieldArray
types:StringArray
No
The array of response fields desired. See response- FieldArray/excludeFieldArray in the Introduction.
excludeFieldArray
types:StringArray
No
The array of excluded response fields. See response- FieldArray/excludeFieldArray in the Introduction.

Output (getAssociatedAssetsReturn)

Name
Type
Required
Description
containerArray
types:AssetArray
No
Array of set and template assets containing the speci- fied asset.
memberArray
types:AssetArray
No
Array of assets contained by the specified set or template asset.
layerReferenceArray
types:AssetArray
No
Array of assets referenced in a layer or template URL.
ownerArray
types:AssetArray
No
Array of assets that own the specified asset.
derivedArray
types:AssetArray
No
Array of assets that were used to generate the specified asset.
generatorArray
types:GenerationInfoArray
No
The generatorArray lists the way this asset was created. For example, if assetHandler was an image page of a PDF, then this would contain the PDF processor tool and reference the PdfFile asset.
generatedArray
types:GenerationInfoArray
No
The generatedArray inverts the way this asset was created. For example, the generatedArray could contain the list of images generated from this assetHandler if this was a PdfFile asset.
thumbAsset
types:Asset
No
The thumb asset information associated with the request asset. If no thumb asset is assigned, the field is omitted in the response.

You can use the parameters responseFieldArray or excludeFieldArray to limit the response size. In particular, the GenerationInfo items returned in generatorArray or generatedArray default to include both the originator and the generated asset records. For a PDF asset type, this behavior results in unwanted multiple copies of the “originator” PDF asset record in the response. You can eliminate this issue by adding generatedArray/items/originator to excludeFieldArray. Or, you can specify an explicit list of response fields that you want to include in responseFieldArray.

Examples

The following basic example is a request for the handle of the generator for an image that is extracted from a PDF. It includes a containerArray of length one with an item including the assetHandle of the PDF.

Request

<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>

Response

<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>

The inverse of the example above is the following:

Request

<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>

Response

<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>

In this next example, a group is added to a company with groupHandleArray. This example uses one group only.

Request

<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>

Response

None.

4e9b9d8c-5839-4215-aa35-01b652869681