CustomFieldDefinition

  • createdAt
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • description
    Type: string
  • displayOrder
    Type: integer

    Integer numbers.

  • entityType
    Type: stringenum
    values
    • PEOPLE
    • COMPANIES
  • id
    Type: stringFormat: uuid
  • isFilterable
    Type: boolean
  • isRequired
    Type: boolean
  • isSortable
    Type: boolean
  • key
    Type: string

    Auto-generated machine key

  • name
    Type: string
  • settings
    Type: object

    Type-specific configuration (e.g. options for SELECT/MULTI_SELECT)

    • options
      Type: array object[]
  • type
    Type: stringenum
    values
    • TEXT
    • NUMERIC
    • BOOLEAN
    • SELECT
    • MULTI_SELECT
  • updatedAt
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z