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

    Variable sys_ui_actionConst

    sys_ui_action: {
        extends: "sys_metadata";
        name: "sys_ui_action";
        schema: {
            action_name: Typed<
                string,
                {
                    active: true;
                    dropdown: "none";
                    label: "Action name";
                    mandatory: false;
                    maxLength: 40;
                    read_only: false;
                },
            >;
            active: Typed<
                boolean,
                {
                    active: true;
                    default: true;
                    label: "Active";
                    mandatory: false;
                    read_only: false;
                },
            >;
            client: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "Client";
                    mandatory: false;
                    read_only: false;
                },
            >;
            client_script_v2: Typed<
                string
                | ScriptModule<Function>,
                {
                    active: true;
                    label: "Workspace Client Script";
                    mandatory: false;
                    read_only: false;
                },
            >;
            comments: Typed<
                string,
                {
                    active: true;
                    label: "Comments";
                    mandatory: false;
                    maxLength: 4000;
                    read_only: false;
                },
            >;
            condition: Typed<
                string
                | number,
                {
                    active: true;
                    column_type: "condition_string";
                    label: "Condition";
                    mandatory: false;
                    read_only: false;
                },
            >;
            form_action: Typed<
                boolean,
                {
                    active: true;
                    label: "Form action";
                    mandatory: false;
                    read_only: false;
                },
            >;
            form_button: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "Form button";
                    mandatory: false;
                    read_only: false;
                },
            >;
            form_button_v2: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "Workspace Form Button";
                    mandatory: false;
                    read_only: false;
                },
            >;
            form_context_menu: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "Form context menu";
                    mandatory: false;
                    read_only: false;
                },
            >;
            form_link: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "Form link";
                    mandatory: false;
                    read_only: false;
                },
            >;
            form_menu_button_v2: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "Workspace Form Menu";
                    mandatory: false;
                    read_only: false;
                },
            >;
            form_style: Typed<
                "primary"
                | "destructive"
                | "unstyled",
                {
                    active: true;
                    choices: {
                        destructive: {
                            inactive: false;
                            label: "Destructive";
                            language: "en";
                            sequence: 2;
                        };
                        primary: {
                            inactive: false;
                            label: "Primary";
                            language: "en";
                            sequence: 1;
                        };
                        unstyled: {
                            inactive: false;
                            label: "Unstyled";
                            language: "en";
                            sequence: 3;
                        };
                    };
                    dropdown: "dropdown_with_none";
                    label: "Form style";
                    mandatory: false;
                    maxLength: 40;
                    read_only: false;
                },
            >;
            format_for_configurable_workspace: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "Format for Configurable Workspace";
                    mandatory: false;
                    read_only: false;
                },
            >;
            hint: Typed<
                string,
                { active: true; label: "Hint"; mandatory: false; read_only: false },
            >;
            isolate_script: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "Isolate script";
                    mandatory: false;
                    read_only: false;
                },
            >;
            keyboard_shortcut: Typed<string, {}>;
            list_action: Typed<
                boolean,
                {
                    active: true;
                    label: "List action";
                    mandatory: false;
                    read_only: false;
                },
            >;
            list_banner_button: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "List banner button";
                    mandatory: false;
                    read_only: false;
                },
            >;
            list_button: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "List bottom button";
                    mandatory: false;
                    read_only: false;
                },
            >;
            list_choice: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "List choice";
                    mandatory: false;
                    read_only: false;
                },
            >;
            list_context_menu: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "List context menu";
                    mandatory: false;
                    read_only: false;
                },
            >;
            list_link: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "List link";
                    mandatory: false;
                    read_only: false;
                },
            >;
            list_save_with_form_button: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "Save with form button";
                    mandatory: false;
                    read_only: false;
                },
            >;
            list_style: Typed<
                "primary"
                | "destructive"
                | "unstyled",
                {
                    active: true;
                    choices: {
                        destructive: {
                            inactive: false;
                            label: "Destructive";
                            language: "en";
                            sequence: 2;
                        };
                        primary: {
                            inactive: false;
                            label: "Primary";
                            language: "en";
                            sequence: 1;
                        };
                        unstyled: {
                            inactive: false;
                            label: "Unstyled";
                            language: "en";
                            sequence: 3;
                        };
                    };
                    dropdown: "dropdown_with_none";
                    label: "List style";
                    mandatory: false;
                    maxLength: 40;
                    read_only: false;
                },
            >;
            messages: Typed<
                string,
                {
                    active: true;
                    dropdown: "none";
                    label: "Messages";
                    mandatory: false;
                    maxLength: 4000;
                    read_only: false;
                },
            >;
            name: Typed<
                string,
                { active: true; label: "Name"; mandatory: false; read_only: false },
            >;
            onclick: Typed<
                string,
                {
                    active: true;
                    dropdown: "none";
                    label: "Onclick";
                    mandatory: false;
                    maxLength: 254;
                    read_only: false;
                },
            >;
            order: Typed<
                number,
                {
                    active: true;
                    default: 100;
                    label: "Order";
                    mandatory: false;
                    read_only: false;
                },
            >;
            script: Typed<
                string
                | ScriptModule<Function>,
                { active: true; label: "Script"; mandatory: false; read_only: false },
            >;
            show_insert: Typed<
                boolean,
                {
                    active: true;
                    default: true;
                    label: "Show insert";
                    mandatory: false;
                    read_only: false;
                },
            >;
            show_multiple_update: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "Show multiple update";
                    mandatory: false;
                    read_only: false;
                },
            >;
            show_query: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "Show query";
                    mandatory: false;
                    read_only: false;
                },
            >;
            show_update: Typed<
                boolean,
                {
                    active: true;
                    default: true;
                    label: "Show update";
                    mandatory: false;
                    read_only: false;
                },
            >;
            sys_domain: Typed<
                Record<"domain">
                | "global",
                {
                    active: true;
                    default: "global";
                    label: "Domain";
                    mandatory: false;
                    read_only: false;
                },
            >;
            sys_domain_path: Typed<
                string,
                {
                    active: true;
                    default: "/";
                    label: "Domain Path";
                    mandatory: false;
                    read_only: false;
                },
            >;
            sys_id: Typed<
                string
                | number,
                {
                    active: true;
                    column_type: "GUID";
                    label: "Sys ID";
                    mandatory: false;
                    read_only: false;
                },
            >;
            sys_overrides: Typed<
                | string
                | Record<"sys_ui_action">
                | ExplicitKey<"sys_ui_action">
                | TableBrand<"sys_ui_action">,
                {
                    active: true;
                    label: "Overrides";
                    mandatory: false;
                    read_only: false;
                    referenceTable: "sys_ui_action";
                },
            >;
            table: Typed<
                keyof Tables,
                { active: true; label: "Table"; mandatory: false; read_only: false },
            >;
            ui11_compatible: Typed<
                boolean,
                {
                    active: true;
                    default: true;
                    label: "List v2 Compatible";
                    mandatory: false;
                    read_only: false;
                },
            >;
            ui16_compatible: Typed<
                boolean,
                {
                    active: true;
                    default: false;
                    label: "List v3 Compatible";
                    mandatory: false;
                    read_only: false;
                },
            >;
        };
    } = ...

    Type Declaration

    • Readonlyextends: "sys_metadata"
    • Readonlyname: "sys_ui_action"
    • Readonlyschema: {
          action_name: Typed<
              string,
              {
                  active: true;
                  dropdown: "none";
                  label: "Action name";
                  mandatory: false;
                  maxLength: 40;
                  read_only: false;
              },
          >;
          active: Typed<
              boolean,
              {
                  active: true;
                  default: true;
                  label: "Active";
                  mandatory: false;
                  read_only: false;
              },
          >;
          client: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "Client";
                  mandatory: false;
                  read_only: false;
              },
          >;
          client_script_v2: Typed<
              string
              | ScriptModule<Function>,
              {
                  active: true;
                  label: "Workspace Client Script";
                  mandatory: false;
                  read_only: false;
              },
          >;
          comments: Typed<
              string,
              {
                  active: true;
                  label: "Comments";
                  mandatory: false;
                  maxLength: 4000;
                  read_only: false;
              },
          >;
          condition: Typed<
              string
              | number,
              {
                  active: true;
                  column_type: "condition_string";
                  label: "Condition";
                  mandatory: false;
                  read_only: false;
              },
          >;
          form_action: Typed<
              boolean,
              { active: true; label: "Form action"; mandatory: false; read_only: false },
          >;
          form_button: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "Form button";
                  mandatory: false;
                  read_only: false;
              },
          >;
          form_button_v2: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "Workspace Form Button";
                  mandatory: false;
                  read_only: false;
              },
          >;
          form_context_menu: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "Form context menu";
                  mandatory: false;
                  read_only: false;
              },
          >;
          form_link: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "Form link";
                  mandatory: false;
                  read_only: false;
              },
          >;
          form_menu_button_v2: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "Workspace Form Menu";
                  mandatory: false;
                  read_only: false;
              },
          >;
          form_style: Typed<
              "primary"
              | "destructive"
              | "unstyled",
              {
                  active: true;
                  choices: {
                      destructive: {
                          inactive: false;
                          label: "Destructive";
                          language: "en";
                          sequence: 2;
                      };
                      primary: {
                          inactive: false;
                          label: "Primary";
                          language: "en";
                          sequence: 1;
                      };
                      unstyled: {
                          inactive: false;
                          label: "Unstyled";
                          language: "en";
                          sequence: 3;
                      };
                  };
                  dropdown: "dropdown_with_none";
                  label: "Form style";
                  mandatory: false;
                  maxLength: 40;
                  read_only: false;
              },
          >;
          format_for_configurable_workspace: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "Format for Configurable Workspace";
                  mandatory: false;
                  read_only: false;
              },
          >;
          hint: Typed<
              string,
              { active: true; label: "Hint"; mandatory: false; read_only: false },
          >;
          isolate_script: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "Isolate script";
                  mandatory: false;
                  read_only: false;
              },
          >;
          keyboard_shortcut: Typed<string, {}>;
          list_action: Typed<
              boolean,
              { active: true; label: "List action"; mandatory: false; read_only: false },
          >;
          list_banner_button: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "List banner button";
                  mandatory: false;
                  read_only: false;
              },
          >;
          list_button: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "List bottom button";
                  mandatory: false;
                  read_only: false;
              },
          >;
          list_choice: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "List choice";
                  mandatory: false;
                  read_only: false;
              },
          >;
          list_context_menu: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "List context menu";
                  mandatory: false;
                  read_only: false;
              },
          >;
          list_link: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "List link";
                  mandatory: false;
                  read_only: false;
              },
          >;
          list_save_with_form_button: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "Save with form button";
                  mandatory: false;
                  read_only: false;
              },
          >;
          list_style: Typed<
              "primary"
              | "destructive"
              | "unstyled",
              {
                  active: true;
                  choices: {
                      destructive: {
                          inactive: false;
                          label: "Destructive";
                          language: "en";
                          sequence: 2;
                      };
                      primary: {
                          inactive: false;
                          label: "Primary";
                          language: "en";
                          sequence: 1;
                      };
                      unstyled: {
                          inactive: false;
                          label: "Unstyled";
                          language: "en";
                          sequence: 3;
                      };
                  };
                  dropdown: "dropdown_with_none";
                  label: "List style";
                  mandatory: false;
                  maxLength: 40;
                  read_only: false;
              },
          >;
          messages: Typed<
              string,
              {
                  active: true;
                  dropdown: "none";
                  label: "Messages";
                  mandatory: false;
                  maxLength: 4000;
                  read_only: false;
              },
          >;
          name: Typed<
              string,
              { active: true; label: "Name"; mandatory: false; read_only: false },
          >;
          onclick: Typed<
              string,
              {
                  active: true;
                  dropdown: "none";
                  label: "Onclick";
                  mandatory: false;
                  maxLength: 254;
                  read_only: false;
              },
          >;
          order: Typed<
              number,
              {
                  active: true;
                  default: 100;
                  label: "Order";
                  mandatory: false;
                  read_only: false;
              },
          >;
          script: Typed<
              string
              | ScriptModule<Function>,
              { active: true; label: "Script"; mandatory: false; read_only: false },
          >;
          show_insert: Typed<
              boolean,
              {
                  active: true;
                  default: true;
                  label: "Show insert";
                  mandatory: false;
                  read_only: false;
              },
          >;
          show_multiple_update: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "Show multiple update";
                  mandatory: false;
                  read_only: false;
              },
          >;
          show_query: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "Show query";
                  mandatory: false;
                  read_only: false;
              },
          >;
          show_update: Typed<
              boolean,
              {
                  active: true;
                  default: true;
                  label: "Show update";
                  mandatory: false;
                  read_only: false;
              },
          >;
          sys_domain: Typed<
              Record<"domain">
              | "global",
              {
                  active: true;
                  default: "global";
                  label: "Domain";
                  mandatory: false;
                  read_only: false;
              },
          >;
          sys_domain_path: Typed<
              string,
              {
                  active: true;
                  default: "/";
                  label: "Domain Path";
                  mandatory: false;
                  read_only: false;
              },
          >;
          sys_id: Typed<
              string
              | number,
              {
                  active: true;
                  column_type: "GUID";
                  label: "Sys ID";
                  mandatory: false;
                  read_only: false;
              },
          >;
          sys_overrides: Typed<
              | string
              | Record<"sys_ui_action">
              | ExplicitKey<"sys_ui_action">
              | TableBrand<"sys_ui_action">,
              {
                  active: true;
                  label: "Overrides";
                  mandatory: false;
                  read_only: false;
                  referenceTable: "sys_ui_action";
              },
          >;
          table: Typed<
              keyof Tables,
              { active: true; label: "Table"; mandatory: false; read_only: false },
          >;
          ui11_compatible: Typed<
              boolean,
              {
                  active: true;
                  default: true;
                  label: "List v2 Compatible";
                  mandatory: false;
                  read_only: false;
              },
          >;
          ui16_compatible: Typed<
              boolean,
              {
                  active: true;
                  default: false;
                  label: "List v3 Compatible";
                  mandatory: false;
                  read_only: false;
              },
          >;
      }