Field definitions

Use the define action to retrieve the field definitions.  Each action will have a list of acceptable fields.

Here are the properties that may be included with each field:

Data types

The HTTP API uses several different data types.  Be sure to use the define action to determine the data type for each object field.  If the value you provide does not match the expected data type and format, you will receive a validation error.

Important things to note:

Required fields and defaults

The add action may require that certain fields be provided with a value.  If the field also has a default value, you are not required to provide the value with your add() request, and the default value will be used.

If a field has the property "valueRequiredOnEdit," the field is not required to be included in your data, but if you do include the field, a value is required.