@servicenow/sdk - v4.4.1
    Preparing search index...
    interface sys_rest_message_fn {
        authentication_type: Typed<
            | "basic"
            | "no_authentication"
            | "basic_simple"
            | "oauth2"
            | "inherit_from_parent",
            {
                active: true;
                choices: {
                    basic: {
                        inactive: false;
                        label: "Basic";
                        language: "en";
                        sequence: 20;
                    };
                    basic_simple: {
                        inactive: false;
                        label: "Basic (simple)";
                        language: "en";
                        sequence: 30;
                    };
                    inherit_from_parent: {
                        inactive: false;
                        label: "Inherit from parent";
                        language: "en";
                        sequence: 5;
                    };
                    no_authentication: {
                        inactive: false;
                        label: "No authentication";
                        language: "en";
                        sequence: 10;
                    };
                    oauth2: {
                        inactive: false;
                        label: "OAuth 2.0";
                        language: "en";
                        sequence: 40;
                    };
                };
                default: "inherit_from_parent";
                dropdown: "dropdown_without_none";
                label: "Authentication type";
                mandatory: false;
                maxLength: 40;
                read_only: false;
            },
        >;
        basic_auth_password: Typed<
            string
            | number,
            {
                active: true;
                column_type: "password2";
                label: "Basic authentication password (simple)";
                mandatory: false;
                maxLength: 255;
                read_only: false;
            },
        >;
        basic_auth_profile: Typed<
            | string
            | Record<"sys_auth_profile_basic">
            | ExplicitKey<"sys_auth_profile_basic">
            | TableBrand<"sys_auth_profile_basic">,
            {
                active: true;
                label: "Basic auth profile";
                mandatory: false;
                maxLength: 32;
                read_only: false;
                referenceTable: "sys_auth_profile_basic";
            },
        >;
        basic_auth_user: Typed<
            string,
            {
                active: true;
                dropdown: "none";
                label: "Basic authentication user ID (simple)";
                mandatory: false;
                maxLength: 40;
                read_only: false;
            },
        >;
        content: Typed<
            string,
            {
                active: true;
                dropdown: "none";
                label: "Content";
                mandatory: false;
                maxLength: 4000;
                read_only: false;
            },
        >;
        function_name: Typed<
            string,
            {
                active: true;
                label: "Name";
                mandatory: true;
                maxLength: 100;
                read_only: false;
            },
        >;
        http_method: Typed<
            "delete"
            | "get"
            | "post"
            | "put"
            | "patch"
            | "head",
            {
                active: true;
                choices: {
                    delete: {
                        inactive: false;
                        label: "DELETE";
                        language: "en";
                        sequence: 40;
                    };
                    get: { inactive: false; label: "GET"; language: "en"; sequence: 10 };
                    head: { inactive: false; label: "HEAD"; language: "en"; sequence: 45 };
                    patch: { inactive: false; label: "PATCH"; language: "en"; sequence: 35 };
                    post: { inactive: false; label: "POST"; language: "en"; sequence: 20 };
                    put: { inactive: false; label: "PUT"; language: "en"; sequence: 30 };
                };
                dropdown: "dropdown_with_none";
                label: "HTTP method";
                mandatory: true;
                maxLength: 10;
                read_only: false;
            },
        >;
        lock: Typed<
            boolean,
            {
                active: true;
                label: "Lock";
                mandatory: false;
                maxLength: 40;
                read_only: false;
            },
        >;
        oauth2_profile: Typed<
            | string
            | ExplicitKey<"oauth_entity_profile">
            | TableBrand<"oauth_entity_profile">
            | Record<"oauth_entity_profile">,
            {
                active: true;
                label: "OAuth profile";
                mandatory: false;
                maxLength: 32;
                read_only: false;
                referenceTable: "oauth_entity_profile";
            },
        >;
        protocol_name: Typed<
            | string
            | ExplicitKey<"sys_protocol_profile">
            | TableBrand<"sys_protocol_profile">
            | Record<"sys_protocol_profile">,
            {
                active: true;
                label: "Mutual authentication profile";
                mandatory: false;
                maxLength: 32;
                read_only: false;
                referenceTable: "sys_protocol_profile";
            },
        >;
        qualified_name: Typed<
            string,
            {
                active: true;
                label: "REST Message [ HTTP Method ]";
                mandatory: false;
                maxLength: 150;
                read_only: false;
            },
        >;
        rest_endpoint: Typed<
            string,
            {
                active: true;
                label: "Endpoint";
                mandatory: false;
                maxLength: 200;
                read_only: false;
            },
        >;
        rest_message: Typed<
            | string
            | ExplicitKey<"sys_rest_message">
            | TableBrand<"sys_rest_message">
            | Record<"sys_rest_message">,
            {
                active: true;
                label: "REST Message";
                mandatory: false;
                maxLength: 32;
                read_only: false;
                referenceTable: "sys_rest_message";
            },
        >;
        use_basic_auth: Typed<
            boolean,
            {
                active: true;
                label: "Use basic authentication";
                mandatory: false;
                maxLength: 40;
                read_only: false;
            },
        >;
        use_mid_server: Typed<
            | string
            | ExplicitKey<"ecc_agent">
            | TableBrand<"ecc_agent">
            | Record<"ecc_agent">,
            {
                active: true;
                label: "Use MID Server";
                mandatory: false;
                maxLength: 32;
                read_only: false;
                referenceTable: "ecc_agent";
            },
        >;
        use_mutual_auth: Typed<
            boolean,
            {
                active: true;
                label: "Use mutual authentication";
                mandatory: false;
                maxLength: 40;
                read_only: false;
            },
        >;
    }

    Hierarchy (View Summary)

    Index

    Properties

    authentication_type: Typed<
        | "basic"
        | "no_authentication"
        | "basic_simple"
        | "oauth2"
        | "inherit_from_parent",
        {
            active: true;
            choices: {
                basic: {
                    inactive: false;
                    label: "Basic";
                    language: "en";
                    sequence: 20;
                };
                basic_simple: {
                    inactive: false;
                    label: "Basic (simple)";
                    language: "en";
                    sequence: 30;
                };
                inherit_from_parent: {
                    inactive: false;
                    label: "Inherit from parent";
                    language: "en";
                    sequence: 5;
                };
                no_authentication: {
                    inactive: false;
                    label: "No authentication";
                    language: "en";
                    sequence: 10;
                };
                oauth2: {
                    inactive: false;
                    label: "OAuth 2.0";
                    language: "en";
                    sequence: 40;
                };
            };
            default: "inherit_from_parent";
            dropdown: "dropdown_without_none";
            label: "Authentication type";
            mandatory: false;
            maxLength: 40;
            read_only: false;
        },
    >
    basic_auth_password: Typed<
        string
        | number,
        {
            active: true;
            column_type: "password2";
            label: "Basic authentication password (simple)";
            mandatory: false;
            maxLength: 255;
            read_only: false;
        },
    >
    basic_auth_profile: Typed<
        | string
        | Record<"sys_auth_profile_basic">
        | ExplicitKey<"sys_auth_profile_basic">
        | TableBrand<"sys_auth_profile_basic">,
        {
            active: true;
            label: "Basic auth profile";
            mandatory: false;
            maxLength: 32;
            read_only: false;
            referenceTable: "sys_auth_profile_basic";
        },
    >
    basic_auth_user: Typed<
        string,
        {
            active: true;
            dropdown: "none";
            label: "Basic authentication user ID (simple)";
            mandatory: false;
            maxLength: 40;
            read_only: false;
        },
    >
    content: Typed<
        string,
        {
            active: true;
            dropdown: "none";
            label: "Content";
            mandatory: false;
            maxLength: 4000;
            read_only: false;
        },
    >
    function_name: Typed<
        string,
        {
            active: true;
            label: "Name";
            mandatory: true;
            maxLength: 100;
            read_only: false;
        },
    >
    http_method: Typed<
        "delete"
        | "get"
        | "post"
        | "put"
        | "patch"
        | "head",
        {
            active: true;
            choices: {
                delete: {
                    inactive: false;
                    label: "DELETE";
                    language: "en";
                    sequence: 40;
                };
                get: { inactive: false; label: "GET"; language: "en"; sequence: 10 };
                head: { inactive: false; label: "HEAD"; language: "en"; sequence: 45 };
                patch: { inactive: false; label: "PATCH"; language: "en"; sequence: 35 };
                post: { inactive: false; label: "POST"; language: "en"; sequence: 20 };
                put: { inactive: false; label: "PUT"; language: "en"; sequence: 30 };
            };
            dropdown: "dropdown_with_none";
            label: "HTTP method";
            mandatory: true;
            maxLength: 10;
            read_only: false;
        },
    >
    lock: Typed<
        boolean,
        {
            active: true;
            label: "Lock";
            mandatory: false;
            maxLength: 40;
            read_only: false;
        },
    >
    oauth2_profile: Typed<
        | string
        | ExplicitKey<"oauth_entity_profile">
        | TableBrand<"oauth_entity_profile">
        | Record<"oauth_entity_profile">,
        {
            active: true;
            label: "OAuth profile";
            mandatory: false;
            maxLength: 32;
            read_only: false;
            referenceTable: "oauth_entity_profile";
        },
    >
    protocol_name: Typed<
        | string
        | ExplicitKey<"sys_protocol_profile">
        | TableBrand<"sys_protocol_profile">
        | Record<"sys_protocol_profile">,
        {
            active: true;
            label: "Mutual authentication profile";
            mandatory: false;
            maxLength: 32;
            read_only: false;
            referenceTable: "sys_protocol_profile";
        },
    >
    qualified_name: Typed<
        string,
        {
            active: true;
            label: "REST Message [ HTTP Method ]";
            mandatory: false;
            maxLength: 150;
            read_only: false;
        },
    >
    rest_endpoint: Typed<
        string,
        {
            active: true;
            label: "Endpoint";
            mandatory: false;
            maxLength: 200;
            read_only: false;
        },
    >
    rest_message: Typed<
        | string
        | ExplicitKey<"sys_rest_message">
        | TableBrand<"sys_rest_message">
        | Record<"sys_rest_message">,
        {
            active: true;
            label: "REST Message";
            mandatory: false;
            maxLength: 32;
            read_only: false;
            referenceTable: "sys_rest_message";
        },
    >
    use_basic_auth: Typed<
        boolean,
        {
            active: true;
            label: "Use basic authentication";
            mandatory: false;
            maxLength: 40;
            read_only: false;
        },
    >
    use_mid_server: Typed<
        | string
        | ExplicitKey<"ecc_agent">
        | TableBrand<"ecc_agent">
        | Record<"ecc_agent">,
        {
            active: true;
            label: "Use MID Server";
            mandatory: false;
            maxLength: 32;
            read_only: false;
            referenceTable: "ecc_agent";
        },
    >
    use_mutual_auth: Typed<
        boolean,
        {
            active: true;
            label: "Use mutual authentication";
            mandatory: false;
            maxLength: 40;
            read_only: false;
        },
    >