3.3.4.33 GetBuiltInCustomField

This operation is used to get the CustomField data corresponding to the specified enum value of the BuiltInCustomField from the IPAM data store.

 <wsdl:operation name="GetBuiltInCustomField">
   <wsdl:input wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/GetBuiltInCustomField" message="ipam:IIpamServer_GetBuiltInCustomField_InputMessage" />
   <wsdl:output wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/GetBuiltInCustomFieldResponse" message="ipam:IIpamServer_GetBuiltInCustomField_OutputMessage" />
 </wsdl:operation>

Upon receiving the IIpamServer_GetBuiltInCustomField_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_GetBuiltInCustomField_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. Validate that the value of GetBuiltInCustomField.builtInCustomField is within the valid values for this enumeration BuiltInCustomField, else an appropriate SOAP fault MUST be returned.

  2. Enumerate the row in the ADM_CustomFieldsTable to whose CustomFieldDetails.BuiltinCustomFieldNumber is same as the value of GetBuiltInCustomField.builtInCustomField enum specified in the input parameter.

  3. Call the GetCustomField procedure of ADM_CustomFieldsTable by passing the RecordId of the row as parameter Param_Id. Assign Result_customField to GetBuiltInCustomFieldResponse.GetBuiltInCustomFieldResult.