Workday Extend · Schema

CustomObjectField

AutomationCustom ApplicationsEnterpriseExtensionsHCMHuman Capital ManagementIntegrationOrchestrationPaaS

Properties

Name Type Description
id string Unique identifier for the field
name string The API name of the field
displayName string The display label for the field
dataType string The data type of the field
isRequired boolean Whether the field is required
isReadOnly boolean Whether the field is read-only
maxLength integer Maximum length for text fields
precision integer Decimal precision for numeric fields
referenceObjectType string The Workday object type for reference fields
defaultValue string Default value for the field
View JSON Schema on GitHub

JSON Schema

workday-extend-customobjectfield-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomObjectField",
  "title": "CustomObjectField",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the field"
    },
    "name": {
      "type": "string",
      "description": "The API name of the field"
    },
    "displayName": {
      "type": "string",
      "description": "The display label for the field"
    },
    "dataType": {
      "type": "string",
      "enum": [
        "text",
        "number",
        "decimal",
        "boolean",
        "date",
        "dateTime",
        "currency",
        "reference",
        "richText"
      ],
      "description": "The data type of the field"
    },
    "isRequired": {
      "type": "boolean",
      "description": "Whether the field is required"
    },
    "isReadOnly": {
      "type": "boolean",
      "description": "Whether the field is read-only"
    },
    "maxLength": {
      "type": "integer",
      "description": "Maximum length for text fields"
    },
    "precision": {
      "type": "integer",
      "description": "Decimal precision for numeric fields"
    },
    "referenceObjectType": {
      "type": "string",
      "description": "The Workday object type for reference fields"
    },
    "defaultValue": {
      "type": "string",
      "description": "Default value for the field"
    }
  }
}