Field Definition Model

Represents a definition of a custom field. Depending on the custom field definition this definition can be for parties, opportunities or cases.

Name Type Description
id Long Read only

The id of this custom field definition. Note that field definitions assignable to different entities (parties or opportunities) can have the same id.

name String Required

The name of this custom field.

description String

A longer description about the purpose of this custom field.

type String Required

The type of this custom field.

Accepted values are: text, date, list, boolean, number

tag Tag

Represents which datatag (if any) this custom field is part of.

captureRule String

Represents if this custom field can be added to parties, organisations or both. Is present only on party custom fields

Accepted values are: person, organisation

options Array of List

Represents the possible options of this custom field values. Is present and required only if type is list