getMetadataFields
Gets the user-defined metadata fields associated with an asset.
Syntax
Authorized User Types
IpsUser
IpsAdmin
IpsCompanyAdmin
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser
Parameters
Input (getMetadataFieldsParam)
Name
Type
Required
Description
companyHandle
xsd:string
Yes
The company handle.
assetType
xsd:string
Yes
Asset types from which to obtain metadata.
Output (getMetadataFieldsParam)
Name
Type
Required
Description
Code Phrase
Code Phrase
Examples
This code sample returns metadata assets for the specified type and company. The response contains an array of metadata fields in a field array. Not all assets have the same metadata. The IPS user defines the asset’s metadata field.
Request
<ns1:getMetadataFieldsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:assetType>Pdf</ns1:assetType>
</ns1:getMetadataFieldsParam>
Response
<getMetadataFieldsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<fieldArray>
<items>
<fieldHandle>47|ALL|Resolution</fieldHandle>
<name>Resolution</name>
<type>String</type>
<defaultValue>120</defaultValue>
<isRequired>false</isRequired>
<isUserDefined>true</isUserDefined>
</items>
</fieldArray>
</getMetadataFieldsReturn>
4e9b9d8c-5839-4215-aa35-01b652869681