@servicenow/sdk - v4.13.3
    Preparing search index...
    interface sys_ws_query_parameter {
        example_value: Typed<
            string,
            {
                attributes: { edge_encryption_enabled: true };
                label: [
                    {
                        hint: "An example of a valid value for this query parameter. Appears in API documentation.";
                        label: "Example value";
                        plural: "Example values";
                    },
                ];
                maxLength: 255;
            },
        >;
        name: Typed<
            string,
            {
                attributes: { edge_encryption_enabled: true };
                label: [
                    {
                        hint: "The name of the query parameter. Appears in API documentation.";
                        label: "Query parameter name";
                        plural: "Query parameter names";
                    },
                ];
                mandatory: true;
            },
        >;
        required: Typed<
            boolean,
            {
                label: [
                    {
                        hint: "Require this query parameter in all requests to the resource";
                        label: "Is required";
                        plural: "Is required";
                    },
                ];
                maxLength: 30;
            },
        >;
        short_description: Typed<
            string,
            {
                attributes: { edge_encryption_enabled: true };
                label: [
                    {
                        hint: "The description of the query parameter. Appears in API documentation.";
                        label: "Short description";
                        plural: "Short descriptions";
                    },
                ];
                maxLength: 80;
            },
        >;
        web_service_definition: Typed<
            | string
            | ExplicitKey<"sys_ws_definition">
            | TableBrand<"sys_ws_definition">
            | Record<"sys_ws_definition">,
            {
                attributes: { encode_utf8: false };
                cascadeRule: "delete";
                label: [
                    {
                        hint: "The API this query parameter belongs to";
                        label: "API definition";
                        plural: "API definitions";
                    },
                ];
                mandatory: true;
                referenceTable: "sys_ws_definition";
            },
        >;
    }

    Hierarchy (View Summary)

    Index

    Properties

    example_value: Typed<
        string,
        {
            attributes: { edge_encryption_enabled: true };
            label: [
                {
                    hint: "An example of a valid value for this query parameter. Appears in API documentation.";
                    label: "Example value";
                    plural: "Example values";
                },
            ];
            maxLength: 255;
        },
    >
    name: Typed<
        string,
        {
            attributes: { edge_encryption_enabled: true };
            label: [
                {
                    hint: "The name of the query parameter. Appears in API documentation.";
                    label: "Query parameter name";
                    plural: "Query parameter names";
                },
            ];
            mandatory: true;
        },
    >
    required: Typed<
        boolean,
        {
            label: [
                {
                    hint: "Require this query parameter in all requests to the resource";
                    label: "Is required";
                    plural: "Is required";
                },
            ];
            maxLength: 30;
        },
    >
    short_description: Typed<
        string,
        {
            attributes: { edge_encryption_enabled: true };
            label: [
                {
                    hint: "The description of the query parameter. Appears in API documentation.";
                    label: "Short description";
                    plural: "Short descriptions";
                },
            ];
            maxLength: 80;
        },
    >
    web_service_definition: Typed<
        | string
        | ExplicitKey<"sys_ws_definition">
        | TableBrand<"sys_ws_definition">
        | Record<"sys_ws_definition">,
        {
            attributes: { encode_utf8: false };
            cascadeRule: "delete";
            label: [
                {
                    hint: "The API this query parameter belongs to";
                    label: "API definition";
                    plural: "API definitions";
                },
            ];
            mandatory: true;
            referenceTable: "sys_ws_definition";
        },
    >