DocumentationDynamic Media Image Production System API

deleteAssetMetadata deleteassetmetadata

Last update: Tue Jul 20 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Deletes metadata values for an asset. Works with an array of metadata delete to set values in a batch.

Syntax

Authorized user types section-e913be43b684491daf02bc73211e4290

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

Parameters section-0eed164e278b456fbdfb7a50727a0416

Input (deleteAssetMetadataParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
The handle to the company to which the folder belongs.
assetHandle
xsd:string
Yes
The handle to the asset to delete.
metadataDelete
xsd:string
Yes
Metadata to delete from the asset.
deleteArray
types:MetadataDeleteArray
Yes
Array of metadata to delete from the asset.

Output (deleteAssetMetadataParam)

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

Examples section-d5657289f5234bb0a613dcf691507958

MetadataDelete

    <complexType name="MetadataDelete">
        <sequence>
            <element name="fieldHandle" type="xsd:string"/>
        </sequence>
    </complexType>

Example call

<ac:Request id="deleteAssetMetadata">
 <deleteAssetMetadataParam xmlns="http://www.scene7.com/IpsApi/xsd/2013-08-29-beta">
  <companyHandle>c|101</companyHandle>
  <assetHandle>a|202</assetHandle>
  <deleteArray>
   <items>
    <fieldHandle>m|2919|ASSET|UntypedUDFField1395788289789</fieldHandle>
   </items>
  </deleteArray>
 </deleteAssetMetadataParam>
</ac:Request>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681