CustomObjectFieldCreate

AutomationCustom ApplicationsEnterpriseExtensionsHCMHuman Capital ManagementIntegrationOrchestrationPaaS

Properties

Name	Type	Description
name	string	The API name of the field
displayName	string	The display label for the field
dataType	string
isRequired	boolean
maxLength	integer	Maximum length for text fields
referenceObjectType	string	Required for reference type fields
defaultValue	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomObjectFieldCreate",
  "title": "CustomObjectFieldCreate",
  "type": "object",
  "required": [
    "name",
    "dataType"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The API name of the field",
      "maxLength": 128,
      "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
    },
    "displayName": {
      "type": "string",
      "description": "The display label for the field"
    },
    "dataType": {
      "type": "string",
      "enum": [
        "text",
        "number",
        "decimal",
        "boolean",
        "date",
        "dateTime",
        "currency",
        "reference",
        "richText"
      ]
    },
    "isRequired": {
      "type": "boolean",
      "default": false
    },
    "maxLength": {
      "type": "integer",
      "description": "Maximum length for text fields"
    },
    "referenceObjectType": {
      "type": "string",
      "description": "Required for reference type fields"
    },
    "defaultValue": {
      "type": "string"
    }
  }
}