Show Menu
TOPICS×

deleteMetadataField

Deletes a company's metadata field.
Syntax

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin

Parameters

Input (deleteMetadataFieldParam)
Name
Type
Required
Description
* companyHandle *
xsd:string
Yes
The handle to the company that contains the metadata field to be deleted.
* fieldHandle *
xsd:string
Yes
The handle to the metadata field to be deleted.
Output (deleteMetadataFieldParam)
The IPS API does not return a response for this operation.

Examples

This code sample deletes a company's metadata field. It uses the company handle and metadata handle as fields in the deleteMetadataFieldParam passed in to the IPS Web services server to perform this action.
Request
<deleteMetadataFieldParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|6</companyHandle>
   <fieldHandle>m|6|IMAGE|saveMetadataField</fieldHandle>
</deleteMetadataFieldParam>

Response
None.0