DocumentationDynamic Media Image Production System API

setAssetMetadata

Last update: Tue Mar 08 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Sets metadata values for an asset. Works with an array of metadata updates to set values in a batch.

Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
The user must have read access to the asset.

Parameters

Input (setAssetMetadataParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
The handle to the company with the asset you want to update.
assetHandle
xsd:string
Yes
The handle to the asset.
updateArray
types:MetadataUpdateArray
Yes
Updates in a metadata update array.

Output (setAssetMetadataReturn)

The IPS API does not return a response for this operation.

Examples

This code sample uses an array of metadata updates to set the metadata of the specified asset.

Request

<ns1:setAssetMetadataParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:assetHandle>24265|1|17061</ns1:assetHandle>
   <ns1:updateArray>
      <ns1:items>
         <ns1:fieldHandle>47|ALL|Resolution</ns1:fieldHandle>
         <ns1:value>320</ns1:value>
      </ns1:items>
   </ns1:updateArray>
</ns1:setAssetMetadataParam>

Response

None.

4e9b9d8c-5839-4215-aa35-01b652869681