HomeGuidesAPI ReferenceGraphQL
Submit Documentation FeedbackJoin Developer CommunityLog In

Field definition

{
  "name": "field_name",
  "type": "number",
  "auto": true,
  "display_name": "Display Name",
  "description": "Description of field",
  "created_by": "zaius",
  "primary_key": true
}

property

description

name

name of the field

type

field data type. options are number, timestamp, text, boolean

auto

(read-only) marks the field as one that is auto-populated by ODP

display_name

the user-friendly name used within ODP

description

description of the field

created_by

(read only) specifies what/who created the field. current values as zaius and account

primary_key

marks the field as identifying for the containing object. only allowed during object creation.