Show Menu
TOPICS×

checkAssetNames

Checks for IPS ID conflicts by comparing asset names against all names a company's Image Serving/Image Rendering catalog namespace.
Syntax

Authorized User Types

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

Parmaeters

Input (checkAssetNamesParam)
Name
Type
Required
Description
* companyHandle *
xsd:string
No
The handle to the company that contains the user.
* assetNamesArray *
types:StringArray
Yes
An array of asset names to check.
Output (checkAssetNamesReturn)
Name
Type
Required
Description
* inUseNameArray *
types:StringArray
Yes
An array of asset names in use.

Examples

This sample code requests the asset names in use for a specified company. The response returns an array of asset names that are in use.
Request
<checkAssetNamesParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-09-10">
   <companyHandle>c|1</companyHandle>
   <assetNameArray>
      <items>ABC123</items>
      <items>DEF456</items>
   </assetNameArray>
</checkAssetNamesParam>

Response
<checkAssetNamesReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-09-10">
   <inUseNameArray>
      <items>DEF456</items>
   </inUseNameArray>
</checkAssetNamesReturn>