getAssetsByName

Returns assets based on an array of asset names.

Syntax

Authorized User Types

IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser

NOTE

Only returns assets to which the user has read access.

Parameters

Input (getAssetsByNameParam)

Name	Type	Required	Description
companyHandle	xsd:string	Yes	The handle to the company.
accessUserHandle	xsd:string	No	Provides access as another user. Available to administrators only.
accessGroupHandle	xsd:string	No	Used to filter by a specific group.
nameArray	types:StringArray	Yes	Array of asset names to retrieve.
assetTypeArray	types:StringArray	No	Array of asset types allowed for retrieved assets.
excludeAssetTypeArray	types:StringArray	No	Array of Asset Types excluded for retrieved assets.
assetSubTypeArray	types:StringArray	No	Array of asset subtypes allowed for retrieved assets.
strictSubTypeCheck	xsd:boolean	No	If true and assetSubTypeArray is not empty, only assets whose subtypes are in assetSubTypeArray are returned. If false, then assets with no defined subtype are included. The default value is false.
responseFieldArray	types:StringArray	No	Contains a list of fields and subfields included in the response.
excludeFieldArray	types:StringArray	No	Contains a list of fields and subfields excluded from the response.

Output (getAssetsByNameReturn)

Name	Type	Required	Description
``assetArray``	`types:AssetArray`	No	Array of assets that match the filter criteria.

Examples

This code sample returns two image type assets.

Request

<getAssetsByNameParam xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
   <companyHandle>c|3</companyHandle>
   <nameArray>
      <items>B010</items>
      <items>IMG_0103</items>
   </nameArray>
   <assetTypeArray>
      <items>Image</items>
   </assetTypeArray>
</getAssetsByNameParam>

Response

<getAssetsByNameReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
   <assetArray>
      <items>
         <assetHandle>a|210</assetHandle>
         <type>Image</type>
         <name>B010</name>
         ...</items>
      <items>
         <assetHandle>a|189</assetHandle>
         <type>Image</type>
         <name>IMG_0103</name>
         ...
      </items>
   </assetArray>
</getAssetsByNameReturn>

Resources on adobe.com

Ecommerce Integrations Cms Cloud Version History Dynamic Media Customer Experience Management Content Management System

View next:

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free