CustomField

The API returns CustomField (XML API) or oaCustomField (SOAP API) objects when you use the Read (XML API) or read() (SOAP API) with the custom equal to method to read custom field values for an object.

You can use the Modify (XML API) or modify() (SOAP API) with the custom equal to method and CustomField (XML API) or oaCustomField (SOAP API) objects as arguments to set or update custom field values for an object.

The CustomField or oaCustomField object has the following properties:

XML / SOAP

Database

Description

id

Unique ID. Automatically assigned by OpenAir.

name

The name of the custom field.

type

Association of the custom field. See Record Types and Forms Supporting Custom Fields for a list of associations.

value

Value of the field for a specific record.