StackOne · Schema

EmployeeCustomFields

IntegrationsiPaaS

Properties

Name Type Description
options array An array of possible options for the custom field.
id string The unique identifier for the custom field, which defaults to the name property if the ID is not accessible.
name string The name of the custom field.
description string The description of the custom field.
type object The type of the custom field.
value object The value associated with the custom field.
value_id string The unique identifier for the value of the custom field.
View JSON Schema on GitHub

JSON Schema

stackone-employeecustomfields-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EmployeeCustomFields",
  "title": "EmployeeCustomFields",
  "type": "object",
  "properties": {
    "options": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of possible options for the custom field.",
      "example": [
        "Not Started",
        "In Progress",
        "Completed",
        "Overdue"
      ]
    },
    "id": {
      "type": "string",
      "description": "The unique identifier for the custom field, which defaults to the name property if the ID is not accessible.",
      "example": "custom_field_123"
    },
    "name": {
      "type": "string",
      "description": "The name of the custom field.",
      "example": "Training Completion Status"
    },
    "description": {
      "type": "string",
      "description": "The description of the custom field.",
      "example": "The completion status of the employee's training."
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EmployeeCustomFieldTypeEnum"
        }
      ],
      "description": "The type of the custom field.",
      "example": "Dropdown"
    },
    "value": {
      "type": "object",
      "description": "The value associated with the custom field.",
      "example": "Completed"
    },
    "value_id": {
      "type": "string",
      "description": "The unique identifier for the value of the custom field.",
      "example": "value_456"
    }
  }
}