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

    Interface FlowDefinition<V, S>

    interface FlowDefinition<
        V extends Record<string, FlowValueType>,
        S extends { [key: string]: FlowStageConfig } = {},
    > {
        $id: string | number | ExplicitKey<string>;
        $override?: Record<string, string | number | boolean>;
        allowHighSecurityRoles?: boolean;
        description?: string;
        flowPriority?: "LOW" | "MEDIUM" | "HIGH";
        flowVariables?: V;
        internalName?: string;
        masterSnapshot?: string;
        name: string;
        protectionPolicy?: "" | "read";
        runAs?: "system" | "user";
        runWithRoles?: (string | Role)[];
        stages?: S;
    }

    Type Parameters

    Index

    Properties

    $id $override? allowHighSecurityRoles? description? flowPriority? flowVariables? internalName? masterSnapshot? name protectionPolicy? runAs? runWithRoles? stages?

    Properties

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

    Set properties not directly supported by this API.

    allowHighSecurityRoles?: boolean

    Only valid when runAs is 'user'.

    description?: string
    flowPriority?: "LOW" | "MEDIUM" | "HIGH"
    flowVariables?: V
    internalName?: string

    snake_case identifier for the flow, used by the platform for programmatic references. Derived from name if omitted.

    masterSnapshot?: string
    name: string
    protectionPolicy?: "" | "read"
    runAs?: "system" | "user"
    runWithRoles?: (string | Role)[]
    stages?: S

    Settings

    Member Visibility

    On This Page

    Properties