Documentation Dynamic Media Image Production System API

getAssetMetadataFields

Last update: March 8, 2022

CREATED FOR:

Developer
Admin

Returns all metadata fields, grouped by asset type.

Syntax

Authorized User Types

IpsUser
IpsAdmin
IpsCompanyAdmin
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser

Parameters

Input (getAssetMetadataFieldsParam)

Name	Type	Required	Description
companyHandle	`xsd:string`	Yes	The handle to the company whose metadata you want to retrieve.

Output (getAssetMetadataFieldsReturn)

Name	Type	Required	Description
assetFieldArray	`types:AssetMetadataFieldsArray`	Yes	Array of metadata fields, by asset type.

Examples

Request

<getAssetMetadataFieldsParam xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
   <companyHandle>c|1</companyHandle>
</getAssetMetadataFieldsParam>

Response

NOTE

Truncated for brevity.

<getAssetMetadataFieldsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
   <assetFieldsArray>
      <items>
         <assetType>Asset</assetType>
     </items>
   </assetFieldsArray>
<getAssetMetadataFieldsReturn>

recommendation-more-help