2.2.4.38 CustomFieldValue

The CustomFieldValue complex type specifies a custom field value.

 <xs:complexType name="CustomFieldValue">
   <xs:complexContent mixed="false">
     <xs:extension base="ipam:BaseIpamObject">
       <xs:sequence>
         <xs:element minOccurs="0" name="BuiltInCustomFieldValueId" type="xsd:long" />
         <xs:element minOccurs="0" name="ParentCustomFieldName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="ParentCustomFieldNumber" type="xsd:int" />
         <xs:element minOccurs="0" name="ParentCustomFieldRecordId" nillable="true" type="xsd:long" />
         <xs:element minOccurs="0" name="RecordId" nillable="true" type="xsd:long" />
         <xs:element minOccurs="0" name="Value" nillable="true" type="xsd:string" />
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

BuiltInCustomFieldValueId: If the value of the custom field is a built-in value, this specifies the unique identifier for the custom field value. This MUST be ignored if the type of the custom field specified by ParentCustomFieldRecordId is Freeform.

ParentCustomFieldName: This specifies the name of the custom field for which the value is being specified.

ParentCustomFieldNumber: If the custom field associated with this value is a built-in custom field, this specifies the unique built-in custom field number of the custom field. If this value is specified for a user-specified custom field, the value of this field MUST be ignored.

ParentCustomFieldRecordId: This specifies the RecordId of the custom field for which the value is being specified.

RecordId: If the custom field denoted by ParentCustomFieldRecordId is a multivalued custom field, this specifies the RecordId of the value. If the custom field is a free-form custom field, this field is not applicable and MUST be ignored.

Value: This specifies the value of the custom field. It MUST NOT be null and the length of the value MUST NOT exceed 256 characters.