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

    Type Alias ReferenceColumnType<RefTable, Type, Default>

    ReferenceColumnType: Column<Type, Default> & {
        cascadeRule?:
            | "none"
            | "delete_no_workflow"
            | "cascade"
            | "delete"
            | "restrict"
            | "clear";
        dynamicRefQual?: Record<"sys_filter_option_dynamic">
        | string;
        referenceTable: RefTable;
        useReferenceQualifier?: "simple" | "dynamic" | "advanced";
    } & (
        | {
            dyamic_creation?: never;
            dynamic_creation_script?: never;
            dynamicCreation?: boolean;
            dynamicCreationScript?: string;
            mtom?: string;
            reference_floats?: never;
            reference_key?: never;
            reference_qual?: never;
            referenceFloats?: boolean;
            referenceKey?: string;
            referenceQual?: string;
        }
        | {
            dyamic_creation?: boolean;
            dynamic_creation_script?: string;
            dynamicCreation?: never;
            dynamicCreationScript?: never;
            reference_floats?: boolean;
            reference_key?: string;
            reference_qual?: string;
            referenceFloats?: never;
            referenceKey?: never;
            referenceQual?: never;
        }
    )

    Type Parameters

    Type Declaration

    • OptionalcascadeRule?: "none" | "delete_no_workflow" | "cascade" | "delete" | "restrict" | "clear"

      Configure what happens to records that reference a record when that record is deleted.

    • OptionaldynamicRefQual?: Record<"sys_filter_option_dynamic"> | string

      Dynamic reference qualifier (use with useReferenceQualifier='dynamic'). Mutually exclusive with referenceQual.

    • referenceTable: RefTable

      Reference a different table as string, escape with `` if definition not present locally (import from @servicenow/sdk-core/global)

    • OptionaluseReferenceQualifier?: "simple" | "dynamic" | "advanced"

      Specifies the type of reference qualifier applied to the field

    • {
          dyamic_creation?: never;
          dynamic_creation_script?: never;
          dynamicCreation?: boolean;
          dynamicCreationScript?: string;
          mtom?: string;
          reference_floats?: never;
          reference_key?: never;
          reference_qual?: never;
          referenceFloats?: boolean;
          referenceKey?: string;
          referenceQual?: string;
      }
      • Optionaldyamic_creation?: never

        Use dynamicCreation instead

      • Optionaldynamic_creation_script?: never

        Use dynamicCreationScript instead

      • OptionaldynamicCreation?: boolean

        If a reference is not found for a reference field then it allows the creation of that target

      • OptionaldynamicCreationScript?: string

        Populate a new record from a reference field based on the field value

      • Optionalmtom?: string

        Creates a many-to-many relationship. The value is the relationship label displayed as a related list on the referenced table (e.g., 'Members'). Generates a sys_collection entry when the bootstrap XML is processed by the platform. Applicable only for ServiceNow scoped applications. For all other scoped applications, define many-to-many relationships using the sys_m2m table instead.

      • Optionalreference_floats?: never

        Use referenceFloats instead

      • Optionalreference_key?: never

        Use referenceKey instead

      • Optionalreference_qual?: never

        Use referenceQual instead

      • OptionalreferenceFloats?: boolean

        Referenced table's form has an "edit" button in the related list for the current table

      • OptionalreferenceKey?: string

        Specifies a field on the referenced table to store in the database instead of sys_id. The field must be unique and required on the referenced table (e.g., 'email' for sys_user).

      • OptionalreferenceQual?: string

        Filter reference based on a filter condition or referenced value

    • {
          dyamic_creation?: boolean;
          dynamic_creation_script?: string;
          dynamicCreation?: never;
          dynamicCreationScript?: never;
          reference_floats?: boolean;
          reference_key?: string;
          reference_qual?: string;
          referenceFloats?: never;
          referenceKey?: never;
          referenceQual?: never;
      }
      • Optionaldyamic_creation?: boolean

        Use dynamicCreation instead

      • Optionaldynamic_creation_script?: string

        Use dynamicCreationScript instead

      • OptionaldynamicCreation?: never
      • OptionaldynamicCreationScript?: never
      • Optionalreference_floats?: boolean

        Use referenceFloats instead

      • Optionalreference_key?: string

        Use referenceKey instead

      • Optionalreference_qual?: string

        Use referenceQual instead

      • OptionalreferenceFloats?: never
      • OptionalreferenceKey?: never
      • OptionalreferenceQual?: never

    Settings

    Member Visibility