HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

Fields schema

Field definition

{
  "name": "field_name",
  "type": "number",
  "auto": true,
  "display_name": "Display Name",
  "public_read": false,
  "description": "Description of field",
  "created_by": "zaius",
  "primary_key": true
}
propertydescription
namename of the field
typefield data type. options are number, timestamp, text, boolean
auto(read-only) marks the field as one that is auto-populated by ODP
display_namethe user-friendly name used within ODP
public_readoptional property for enabling access with the API public key. The default value is false.
descriptiondescription of the field
created_by(read-only) specifies what/who created the field. current values as zaius and account
primary_keymarks the field as identifying for the containing object. only allowed during object creation.