ServiceNow · Schema

CatalogVariable

A variable on a catalog item form.

AutomationCloud ServicesDigital WorkflowsEnterprise PlatformIT Service ManagementITSMProcessesT1Workflow AutomationWorkflows

Properties

Name	Type	Description
name	string	The internal name of the variable.
label	string	The display label.
type	string	The variable type.
mandatory	boolean	Whether the variable is required.
default_value	string	The default value.
choices	array	Available choices for select-type variables.

View JSON Schema on GitHub

JSON Schema

{
  "type": "object",
  "description": "A variable on a catalog item form.",
  "properties": {
    "name": {
      "type": "string",
      "description": "The internal name of the variable.",
      "example": "Example Title"
    },
    "label": {
      "type": "string",
      "description": "The display label.",
      "example": "Example Title"
    },
    "type": {
      "type": "string",
      "description": "The variable type.",
      "example": "example_value"
    },
    "mandatory": {
      "type": "boolean",
      "description": "Whether the variable is required.",
      "example": true
    },
    "default_value": {
      "type": "string",
      "description": "The default value.",
      "example": "example_value"
    },
    "choices": {
      "type": "array",
      "description": "Available choices for select-type variables.",
      "example": [],
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CatalogVariable"
}