@servicenow/sdk - v4.7.0
    Preparing search index...

    Interface VariableSet<V>

    Type alias for VariableSetConfig to allow using VariableSet as both a type and a function

    interface VariableSet<V extends VariableTypes = VariableTypes> {
        $id: string | number | ExplicitKey<string>;
        $override?: Record<string, string | number | boolean>;
        createRoles?: (string | Role)[];
        description?: string;
        displayTitle?: boolean;
        internalName?: string;
        layout?: "normal" | "2across" | "2down";
        name?: string;
        order?: number;
        protectionPolicy?: "read" | "protected";
        readRoles?: (string | Role)[];
        setAttributes?: string;
        title: string;
        type?: "singleRow" | "multiRow";
        variables?: V;
        version?: number;
        writeRoles?: (string | Role)[];
    }

    Type Parameters

    Index

    Properties

    $id $override? createRoles? description? displayTitle? internalName? layout? name? order? protectionPolicy? readRoles? setAttributes? title type? variables? version? writeRoles?

    Properties

    $id: string | number | ExplicitKey<string>
    $override?: Record<string, string | number | boolean>

    Set properties not directly supported by this API.

    createRoles?: (string | Role)[]

    Roles that can create instances of this variable set An array of role names or Role references

    description?: string

    Description of the variable set

    displayTitle?: boolean

    Whether to display the title

    false
    internalName?: string

    Optional : this is auto generated if not provided

    layout?: "normal" | "2across" | "2down"

    Layout style for the variable set Common values: 'normal', '2down', '2across'

    'normal'
    name?: string

    Optional name field

    order?: number

    Display order of the variable set

    100
    protectionPolicy?: "read" | "protected"

    Controls edit/view access for other developers after the application is installed.

    • read: Others can see the script logic but not change it.
    • protected: Others cannot change this record.
    • Omit to allow other developers to customize this record.
    readRoles?: (string | Role)[]

    Roles that can read this variable set An array of role names or Role references

    setAttributes?: string

    Set attributes (additional configuration)

    title: string

    Display title of the variable set (translated field)

    type?: "singleRow" | "multiRow"

    Type of variable set

    • 'singleRow': Single Row (default)
    • 'multiRow': Multi Row
    'singleRow'
    variables?: V

    The variables for the variable set

    version?: number

    Version number of the variable set

    writeRoles?: (string | Role)[]

    Roles that can write/modify this variable set An array of role names or Role references

    Settings

    Member Visibility

    On This Page

    Properties