3.3.4.23 DeleteCustomField

The DeleteCustomField operation is used to delete a CustomField object from the IPAM data store.

 <wsdl:operation name="DeleteCustomField">
   <wsdl:input wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/DeleteCustomField" message="ipam:IIpamServer_DeleteCustomField_InputMessage" />
   <wsdl:output wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/DeleteCustomFieldResponse" message="ipam:IIpamServer_DeleteCustomField_OutputMessage" />
 </wsdl:operation>

Upon receiving the IIpamServer_DeleteCustomField_InputMessage request message, the server performs the following processing steps. Upon successful completion of the steps specified below, the server MUST respond with the IIpamServer_DeleteCustomField_OutputMessage message. In the event of a failure, an appropriate SOAP fault MUST be sent to the client as specified in section 2.2.2.1:

  1. Set the deleteCustomField to DeleteCustomField.customField.

  2. If deleteCustomField is NULL, an appropriate SOAP fault MUST be returned.

  3. Validate the deleteCustomField by performing the processing rules as specified in the procedure ValidateCustomField.

  4. If deleteCustomField.customFieldorigin is equal to the enumeration value CustomFieldOrigin.BuiltIn, an appropriate SOAP fault MUST be returned as it is not allowed to delete a built-in custom field.

  5. Delete the row from ADM_CustomFieldsTable whose RecordId is same as deleteCustomField.customFieldId.