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

    Variable sys_dictionaryConst

    sys_dictionary: {
        extends: "sys_metadata";
        name: "sys_dictionary";
        schema: {
            active: Typed<
                boolean,
                {
                    active: true;
                    default: true;
                    label: "Active";
                    mandatory: false;
                    read_only: false;
                },
            >;
            array: Typed<
                boolean,
                { active: true; label: "Array"; mandatory: false; read_only: false },
            >;
            array_denormalized: Typed<
                boolean,
                {
                    active: true;
                    label: "Array denormalized";
                    mandatory: false;
                    read_only: false;
                },
            >;
            attributes: Typed<
                string,
                {
                    active: true;
                    dropdown: "none";
                    label: "Attributes";
                    mandatory: false;
                    maxLength: 1000;
                    read_only: false;
                },
            >;
            audit: Typed<
                boolean,
                { active: true; label: "Audit"; mandatory: false; read_only: false },
            >;
            calculation: Typed<
                string
                | ScriptModule<Function>,
                {
                    active: true;
                    default: "(function calculatedFieldValue(current) {\n\n\t// Add your code here\n\treturn ''; // return the calculated value\n\n})(current);";
                    label: "Calculation";
                    mandatory: false;
                    read_only: false;
                },
            >;
            choice: Typed<
                number,
                { active: true; label: "Choice"; mandatory: false; read_only: false },
            >;
            choice_field: Typed<
                string,
                {
                    active: true;
                    label: "Choice field";
                    mandatory: false;
                    read_only: false;
                },
            >;
            choice_table: Typed<
                keyof Tables,
                {
                    active: true;
                    label: "Choice table";
                    mandatory: false;
                    read_only: false;
                },
            >;
            column_label: Typed<
                string
                | number,
                {
                    active: true;
                    column_type: "documentation_field";
                    label: "Column label";
                    mandatory: false;
                    read_only: false;
                },
            >;
            comments: Typed<
                string,
                {
                    active: true;
                    dropdown: "none";
                    label: "Comments";
                    mandatory: false;
                    maxLength: 4000;
                    read_only: false;
                },
            >;
            create_roles: Typed<
                (string | Role)[],
                {
                    active: true;
                    label: "Create roles";
                    mandatory: false;
                    read_only: false;
                },
            >;
            default_value: Typed<
                string,
                {
                    active: true;
                    dropdown: "none";
                    label: "Default value";
                    mandatory: false;
                    maxLength: 512;
                    read_only: false;
                },
            >;
            defaultsort: Typed<
                number,
                {
                    active: true;
                    label: "Defaultsort";
                    mandatory: false;
                    read_only: false;
                },
            >;
            delete_roles: Typed<
                (string | Role)[],
                {
                    active: true;
                    label: "Delete roles";
                    mandatory: false;
                    read_only: false;
                },
            >;
            dependent: Typed<
                string,
                {
                    active: true;
                    dropdown: "none";
                    label: "Dependent";
                    mandatory: false;
                    maxLength: 80;
                    read_only: false;
                },
            >;
            dependent_on_field: Typed<
                string,
                {
                    active: true;
                    label: "Dependent on field";
                    mandatory: false;
                    read_only: false;
                },
            >;
            display: Typed<
                boolean,
                { active: true; label: "Display"; mandatory: false; read_only: false },
            >;
            dynamic_creation: Typed<
                boolean,
                {
                    active: true;
                    label: "Dynamic creation";
                    mandatory: false;
                    read_only: false;
                },
            >;
            dynamic_creation_script: Typed<
                string,
                {
                    active: true;
                    dropdown: "none";
                    label: "Dynamic creation script";
                    mandatory: false;
                    maxLength: 4000;
                    read_only: false;
                },
            >;
            dynamic_default_value: Typed<
                | string
                | Record<"sys_filter_option_dynamic">
                | ExplicitKey<"sys_filter_option_dynamic">
                | TableBrand<"sys_filter_option_dynamic">,
                {
                    active: true;
                    label: "Dynamic default value";
                    mandatory: false;
                    read_only: false;
                    referenceTable: "sys_filter_option_dynamic";
                },
            >;
            dynamic_ref_qual: Typed<
                | string
                | Record<"sys_filter_option_dynamic">
                | ExplicitKey<"sys_filter_option_dynamic">
                | TableBrand<"sys_filter_option_dynamic">,
                {
                    active: true;
                    label: "Dynamic ref qual";
                    mandatory: false;
                    read_only: false;
                    referenceTable: "sys_filter_option_dynamic";
                },
            >;
            element: Typed<
                string,
                {
                    active: true;
                    dropdown: "none";
                    label: "Column name";
                    mandatory: false;
                    maxLength: 80;
                    read_only: false;
                },
            >;
            element_reference: Typed<
                boolean,
                {
                    active: true;
                    label: "Element reference";
                    mandatory: false;
                    read_only: false;
                },
            >;
            foreign_database: Typed<
                string,
                {
                    active: true;
                    dropdown: "none";
                    label: "Foreign database";
                    mandatory: false;
                    maxLength: 40;
                    read_only: false;
                },
            >;
            formula: Typed<
                string
                | number,
                {
                    active: true;
                    column_type: "expression";
                    label: "Formula";
                    mandatory: false;
                    read_only: false;
                },
            >;
            function_definition: Typed<
                string,
                {
                    active: true;
                    dropdown: "none";
                    label: "Function definition";
                    mandatory: false;
                    maxLength: 4000;
                    read_only: false;
                },
            >;
            function_field: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "Function field";
                    mandatory: false;
                    read_only: false;
                },
            >;
            internal_type: Typed<
                | string
                | Record<"sys_glide_object">
                | ExplicitKey<"sys_glide_object">
                | TableBrand<"sys_glide_object">,
                {
                    active: true;
                    label: "Type";
                    mandatory: false;
                    read_only: false;
                    referenceTable: "sys_glide_object";
                },
            >;
            mandatory: Typed<
                boolean,
                { active: true; label: "Mandatory"; mandatory: false; read_only: false },
            >;
            max_length: Typed<
                number,
                { active: true; label: "Max length"; mandatory: false; read_only: false },
            >;
            name: Typed<
                keyof Tables,
                { active: true; label: "Table"; mandatory: true; read_only: false },
            >;
            next_element: Typed<
                string,
                {
                    active: true;
                    dropdown: "none";
                    label: "Next element";
                    mandatory: false;
                    maxLength: 80;
                    read_only: true;
                },
            >;
            primary: Typed<
                boolean,
                { active: true; label: "Primary"; mandatory: false; read_only: false },
            >;
            read_only: Typed<
                boolean,
                { active: true; label: "Read only"; mandatory: false; read_only: false },
            >;
            read_roles: Typed<
                (string | Role)[],
                { active: true; label: "Read roles"; mandatory: false; read_only: false },
            >;
            reference: Typed<
                | string
                | Record<"sys_db_object">
                | ExplicitKey<"sys_db_object">
                | TableBrand<"sys_db_object">,
                {
                    active: true;
                    label: "Reference";
                    mandatory: false;
                    read_only: false;
                    referenceTable: "sys_db_object";
                },
            >;
            reference_cascade_rule: Typed<
                | "none"
                | "delete"
                | "delete_no_workflow"
                | "cascade"
                | "restrict"
                | "clear",
                {
                    active: true;
                    choices: {
                        cascade: { inactive: false; label: "Cascade"; language: "en" };
                        clear: { inactive: false; label: "Clear"; language: "en" };
                        delete: { inactive: false; label: "Delete"; language: "en" };
                        delete_no_workflow: {
                            inactive: false;
                            label: "Delete no workflow";
                            language: "en";
                        };
                        none: { inactive: false; label: "None"; language: "en" };
                        restrict: { inactive: false; label: "Restrict"; language: "en" };
                    };
                    dropdown: "dropdown_with_none";
                    label: "Reference cascade rule";
                    mandatory: false;
                    maxLength: 20;
                    read_only: false;
                },
            >;
            reference_floats: Typed<
                boolean,
                {
                    active: true;
                    label: "Reference floats";
                    mandatory: false;
                    read_only: false;
                },
            >;
            reference_key: Typed<
                string,
                {
                    active: true;
                    dropdown: "none";
                    label: "Reference key";
                    mandatory: false;
                    maxLength: 40;
                    read_only: false;
                },
            >;
            reference_qual: Typed<
                string,
                {
                    active: true;
                    dropdown: "none";
                    label: "Reference qual";
                    mandatory: false;
                    maxLength: 1000;
                    read_only: false;
                },
            >;
            reference_qual_condition: Typed<
                string,
                {
                    active: true;
                    label: "Reference qual condition";
                    mandatory: false;
                    read_only: false;
                },
            >;
            reference_type: Typed<
                string,
                {
                    active: true;
                    dropdown: "none";
                    label: "Reference type";
                    mandatory: false;
                    maxLength: 10;
                    read_only: false;
                },
            >;
            sizeclass: Typed<
                number,
                { active: true; label: "Sizeclass"; mandatory: false; read_only: false },
            >;
            spell_check: Typed<
                boolean,
                {
                    active: true;
                    label: "Spell check";
                    mandatory: false;
                    read_only: false;
                },
            >;
            staged: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "Staged";
                    mandatory: false;
                    read_only: false;
                },
            >;
            table_reference: Typed<
                boolean,
                {
                    active: true;
                    label: "Table reference";
                    mandatory: false;
                    read_only: false;
                },
            >;
            text_index: Typed<
                boolean,
                { active: true; label: "Text index"; mandatory: false; read_only: false },
            >;
            unique: Typed<
                boolean,
                { active: true; label: "Unique"; mandatory: false; read_only: false },
            >;
            use_dependent_field: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "Use dependent field";
                    mandatory: false;
                    read_only: false;
                },
            >;
            use_dynamic_default: Typed<
                boolean,
                {
                    active: true;
                    label: "Use dynamic default";
                    mandatory: false;
                    read_only: false;
                },
            >;
            use_reference_qualifier: Typed<
                "advanced"
                | "simple"
                | "dynamic",
                {
                    active: true;
                    choices: {
                        advanced: {
                            inactive: false;
                            label: "Advanced";
                            language: "en";
                            sequence: 3;
                        };
                        dynamic: {
                            inactive: false;
                            label: "Dynamic";
                            language: "en";
                            sequence: 2;
                        };
                        simple: {
                            inactive: false;
                            label: "Simple";
                            language: "en";
                            sequence: 1;
                        };
                    };
                    default: "simple";
                    dropdown: "dropdown_without_none";
                    label: "Use reference qualifier";
                    mandatory: false;
                    maxLength: 40;
                    read_only: false;
                },
            >;
            virtual: Typed<
                boolean,
                { active: true; label: "Calculated"; mandatory: false; read_only: false },
            >;
            virtual_type: Typed<
                "formula"
                | "script",
                {
                    active: true;
                    choices: {
                        formula: {
                            inactive: false;
                            label: "Formula";
                            language: "en";
                            sequence: 2;
                        };
                        script: {
                            inactive: false;
                            label: "Script";
                            language: "en";
                            sequence: 1;
                        };
                    };
                    default: "script";
                    dropdown: "dropdown_without_none";
                    label: "Calculation Type";
                    mandatory: false;
                    maxLength: 40;
                    read_only: false;
                },
            >;
            widget: Typed<
                string,
                {
                    active: true;
                    dropdown: "none";
                    label: "Widget";
                    mandatory: false;
                    maxLength: 40;
                    read_only: false;
                },
            >;
            write_roles: Typed<
                (string | Role)[],
                {
                    active: true;
                    label: "Write roles";
                    mandatory: false;
                    read_only: false;
                },
            >;
            xml_view: Typed<
                boolean,
                { active: true; label: "XML view"; mandatory: false; read_only: false },
            >;
        };
    } = ...

    Type Declaration

    • Readonlyextends: "sys_metadata"
    • Readonlyname: "sys_dictionary"
    • Readonlyschema: {
          active: Typed<
              boolean,
              {
                  active: true;
                  default: true;
                  label: "Active";
                  mandatory: false;
                  read_only: false;
              },
          >;
          array: Typed<
              boolean,
              { active: true; label: "Array"; mandatory: false; read_only: false },
          >;
          array_denormalized: Typed<
              boolean,
              {
                  active: true;
                  label: "Array denormalized";
                  mandatory: false;
                  read_only: false;
              },
          >;
          attributes: Typed<
              string,
              {
                  active: true;
                  dropdown: "none";
                  label: "Attributes";
                  mandatory: false;
                  maxLength: 1000;
                  read_only: false;
              },
          >;
          audit: Typed<
              boolean,
              { active: true; label: "Audit"; mandatory: false; read_only: false },
          >;
          calculation: Typed<
              string
              | ScriptModule<Function>,
              {
                  active: true;
                  default: "(function calculatedFieldValue(current) {\n\n\t// Add your code here\n\treturn ''; // return the calculated value\n\n})(current);";
                  label: "Calculation";
                  mandatory: false;
                  read_only: false;
              },
          >;
          choice: Typed<
              number,
              { active: true; label: "Choice"; mandatory: false; read_only: false },
          >;
          choice_field: Typed<
              string,
              {
                  active: true;
                  label: "Choice field";
                  mandatory: false;
                  read_only: false;
              },
          >;
          choice_table: Typed<
              keyof Tables,
              {
                  active: true;
                  label: "Choice table";
                  mandatory: false;
                  read_only: false;
              },
          >;
          column_label: Typed<
              string
              | number,
              {
                  active: true;
                  column_type: "documentation_field";
                  label: "Column label";
                  mandatory: false;
                  read_only: false;
              },
          >;
          comments: Typed<
              string,
              {
                  active: true;
                  dropdown: "none";
                  label: "Comments";
                  mandatory: false;
                  maxLength: 4000;
                  read_only: false;
              },
          >;
          create_roles: Typed<
              (string | Role)[],
              {
                  active: true;
                  label: "Create roles";
                  mandatory: false;
                  read_only: false;
              },
          >;
          default_value: Typed<
              string,
              {
                  active: true;
                  dropdown: "none";
                  label: "Default value";
                  mandatory: false;
                  maxLength: 512;
                  read_only: false;
              },
          >;
          defaultsort: Typed<
              number,
              { active: true; label: "Defaultsort"; mandatory: false; read_only: false },
          >;
          delete_roles: Typed<
              (string | Role)[],
              {
                  active: true;
                  label: "Delete roles";
                  mandatory: false;
                  read_only: false;
              },
          >;
          dependent: Typed<
              string,
              {
                  active: true;
                  dropdown: "none";
                  label: "Dependent";
                  mandatory: false;
                  maxLength: 80;
                  read_only: false;
              },
          >;
          dependent_on_field: Typed<
              string,
              {
                  active: true;
                  label: "Dependent on field";
                  mandatory: false;
                  read_only: false;
              },
          >;
          display: Typed<
              boolean,
              { active: true; label: "Display"; mandatory: false; read_only: false },
          >;
          dynamic_creation: Typed<
              boolean,
              {
                  active: true;
                  label: "Dynamic creation";
                  mandatory: false;
                  read_only: false;
              },
          >;
          dynamic_creation_script: Typed<
              string,
              {
                  active: true;
                  dropdown: "none";
                  label: "Dynamic creation script";
                  mandatory: false;
                  maxLength: 4000;
                  read_only: false;
              },
          >;
          dynamic_default_value: Typed<
              | string
              | Record<"sys_filter_option_dynamic">
              | ExplicitKey<"sys_filter_option_dynamic">
              | TableBrand<"sys_filter_option_dynamic">,
              {
                  active: true;
                  label: "Dynamic default value";
                  mandatory: false;
                  read_only: false;
                  referenceTable: "sys_filter_option_dynamic";
              },
          >;
          dynamic_ref_qual: Typed<
              | string
              | Record<"sys_filter_option_dynamic">
              | ExplicitKey<"sys_filter_option_dynamic">
              | TableBrand<"sys_filter_option_dynamic">,
              {
                  active: true;
                  label: "Dynamic ref qual";
                  mandatory: false;
                  read_only: false;
                  referenceTable: "sys_filter_option_dynamic";
              },
          >;
          element: Typed<
              string,
              {
                  active: true;
                  dropdown: "none";
                  label: "Column name";
                  mandatory: false;
                  maxLength: 80;
                  read_only: false;
              },
          >;
          element_reference: Typed<
              boolean,
              {
                  active: true;
                  label: "Element reference";
                  mandatory: false;
                  read_only: false;
              },
          >;
          foreign_database: Typed<
              string,
              {
                  active: true;
                  dropdown: "none";
                  label: "Foreign database";
                  mandatory: false;
                  maxLength: 40;
                  read_only: false;
              },
          >;
          formula: Typed<
              string
              | number,
              {
                  active: true;
                  column_type: "expression";
                  label: "Formula";
                  mandatory: false;
                  read_only: false;
              },
          >;
          function_definition: Typed<
              string,
              {
                  active: true;
                  dropdown: "none";
                  label: "Function definition";
                  mandatory: false;
                  maxLength: 4000;
                  read_only: false;
              },
          >;
          function_field: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "Function field";
                  mandatory: false;
                  read_only: false;
              },
          >;
          internal_type: Typed<
              | string
              | Record<"sys_glide_object">
              | ExplicitKey<"sys_glide_object">
              | TableBrand<"sys_glide_object">,
              {
                  active: true;
                  label: "Type";
                  mandatory: false;
                  read_only: false;
                  referenceTable: "sys_glide_object";
              },
          >;
          mandatory: Typed<
              boolean,
              { active: true; label: "Mandatory"; mandatory: false; read_only: false },
          >;
          max_length: Typed<
              number,
              { active: true; label: "Max length"; mandatory: false; read_only: false },
          >;
          name: Typed<
              keyof Tables,
              { active: true; label: "Table"; mandatory: true; read_only: false },
          >;
          next_element: Typed<
              string,
              {
                  active: true;
                  dropdown: "none";
                  label: "Next element";
                  mandatory: false;
                  maxLength: 80;
                  read_only: true;
              },
          >;
          primary: Typed<
              boolean,
              { active: true; label: "Primary"; mandatory: false; read_only: false },
          >;
          read_only: Typed<
              boolean,
              { active: true; label: "Read only"; mandatory: false; read_only: false },
          >;
          read_roles: Typed<
              (string | Role)[],
              { active: true; label: "Read roles"; mandatory: false; read_only: false },
          >;
          reference: Typed<
              | string
              | Record<"sys_db_object">
              | ExplicitKey<"sys_db_object">
              | TableBrand<"sys_db_object">,
              {
                  active: true;
                  label: "Reference";
                  mandatory: false;
                  read_only: false;
                  referenceTable: "sys_db_object";
              },
          >;
          reference_cascade_rule: Typed<
              | "none"
              | "delete"
              | "delete_no_workflow"
              | "cascade"
              | "restrict"
              | "clear",
              {
                  active: true;
                  choices: {
                      cascade: { inactive: false; label: "Cascade"; language: "en" };
                      clear: { inactive: false; label: "Clear"; language: "en" };
                      delete: { inactive: false; label: "Delete"; language: "en" };
                      delete_no_workflow: {
                          inactive: false;
                          label: "Delete no workflow";
                          language: "en";
                      };
                      none: { inactive: false; label: "None"; language: "en" };
                      restrict: { inactive: false; label: "Restrict"; language: "en" };
                  };
                  dropdown: "dropdown_with_none";
                  label: "Reference cascade rule";
                  mandatory: false;
                  maxLength: 20;
                  read_only: false;
              },
          >;
          reference_floats: Typed<
              boolean,
              {
                  active: true;
                  label: "Reference floats";
                  mandatory: false;
                  read_only: false;
              },
          >;
          reference_key: Typed<
              string,
              {
                  active: true;
                  dropdown: "none";
                  label: "Reference key";
                  mandatory: false;
                  maxLength: 40;
                  read_only: false;
              },
          >;
          reference_qual: Typed<
              string,
              {
                  active: true;
                  dropdown: "none";
                  label: "Reference qual";
                  mandatory: false;
                  maxLength: 1000;
                  read_only: false;
              },
          >;
          reference_qual_condition: Typed<
              string,
              {
                  active: true;
                  label: "Reference qual condition";
                  mandatory: false;
                  read_only: false;
              },
          >;
          reference_type: Typed<
              string,
              {
                  active: true;
                  dropdown: "none";
                  label: "Reference type";
                  mandatory: false;
                  maxLength: 10;
                  read_only: false;
              },
          >;
          sizeclass: Typed<
              number,
              { active: true; label: "Sizeclass"; mandatory: false; read_only: false },
          >;
          spell_check: Typed<
              boolean,
              { active: true; label: "Spell check"; mandatory: false; read_only: false },
          >;
          staged: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "Staged";
                  mandatory: false;
                  read_only: false;
              },
          >;
          table_reference: Typed<
              boolean,
              {
                  active: true;
                  label: "Table reference";
                  mandatory: false;
                  read_only: false;
              },
          >;
          text_index: Typed<
              boolean,
              { active: true; label: "Text index"; mandatory: false; read_only: false },
          >;
          unique: Typed<
              boolean,
              { active: true; label: "Unique"; mandatory: false; read_only: false },
          >;
          use_dependent_field: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "Use dependent field";
                  mandatory: false;
                  read_only: false;
              },
          >;
          use_dynamic_default: Typed<
              boolean,
              {
                  active: true;
                  label: "Use dynamic default";
                  mandatory: false;
                  read_only: false;
              },
          >;
          use_reference_qualifier: Typed<
              "advanced"
              | "simple"
              | "dynamic",
              {
                  active: true;
                  choices: {
                      advanced: {
                          inactive: false;
                          label: "Advanced";
                          language: "en";
                          sequence: 3;
                      };
                      dynamic: {
                          inactive: false;
                          label: "Dynamic";
                          language: "en";
                          sequence: 2;
                      };
                      simple: {
                          inactive: false;
                          label: "Simple";
                          language: "en";
                          sequence: 1;
                      };
                  };
                  default: "simple";
                  dropdown: "dropdown_without_none";
                  label: "Use reference qualifier";
                  mandatory: false;
                  maxLength: 40;
                  read_only: false;
              },
          >;
          virtual: Typed<
              boolean,
              { active: true; label: "Calculated"; mandatory: false; read_only: false },
          >;
          virtual_type: Typed<
              "formula"
              | "script",
              {
                  active: true;
                  choices: {
                      formula: {
                          inactive: false;
                          label: "Formula";
                          language: "en";
                          sequence: 2;
                      };
                      script: {
                          inactive: false;
                          label: "Script";
                          language: "en";
                          sequence: 1;
                      };
                  };
                  default: "script";
                  dropdown: "dropdown_without_none";
                  label: "Calculation Type";
                  mandatory: false;
                  maxLength: 40;
                  read_only: false;
              },
          >;
          widget: Typed<
              string,
              {
                  active: true;
                  dropdown: "none";
                  label: "Widget";
                  mandatory: false;
                  maxLength: 40;
                  read_only: false;
              },
          >;
          write_roles: Typed<
              (string | Role)[],
              { active: true; label: "Write roles"; mandatory: false; read_only: false },
          >;
          xml_view: Typed<
              boolean,
              { active: true; label: "XML view"; mandatory: false; read_only: false },
          >;
      }