@servicenow/sdk - v4.13.3
    Preparing search index...
    interface sys_ws_version {
        active: Typed<
            boolean,
            {
                default: true;
                label: [
                    {
                        hint: "Activates this version. Resources belonging to inactive versions cannot serve requests.";
                        label: "Active";
                        plural: "Active";
                    },
                ];
                maxLength: 30;
            },
        >;
        deprecated: Typed<
            boolean,
            {
                label: [
                    {
                        hint: "Deprecates this version. Resources belonging to deprecated versions can serve requests but are identified as 'Deprecated' in API documentation.";
                        label: "Deprecated";
                        plural: "Deprecated";
                    },
                ];
                maxLength: 30;
            },
        >;
        is_default: Typed<
            boolean,
            {
                label: [
                    {
                        hint: "Whether this version is the default. Resources belonging to the default version can be accessed from either versioned or non-versioned URIs.";
                        label: "Is default";
                        plural: "Is defaults";
                    },
                ];
                maxLength: 30;
            },
        >;
        short_description: Typed<
            string,
            {
                attributes: { edge_encryption_enabled: true };
                label: [
                    {
                        hint: "The description of the version. Appears in API documentation.";
                        label: "Short description";
                        plural: "Short descriptions";
                    },
                ];
                maxLength: 80;
            },
        >;
        version: Typed<
            number,
            {
                label: [
                    {
                        hint: "The number of this version";
                        label: "Version";
                        plural: "Versions";
                    },
                ];
                mandatory: true;
                maxLength: 10;
                readOnly: true;
                readOnlyOption: "instance_configured";
            },
        >;
        version_id: Typed<
            string,
            {
                attributes: { edge_encryption_enabled: true };
                dynamicValueDefinitions: {
                    calculatedValue: "if (current.version)\n\tcurrent.version_id = 'v' + current.version;";
                    type: "calculated_value";
                };
                label: [
                    {
                        hint: "The version identifier used to indicate this version in URIs";
                        label: "Version ID";
                        plural: "Version IDs";
                    },
                ];
                mandatory: true;
                readOnly: true;
                readOnlyOption: "instance_configured";
            },
        >;
        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 version belongs to";
                        label: "API definition";
                        plural: "API definitions";
                    },
                ];
                mandatory: true;
                readOnly: true;
                readOnlyOption: "instance_configured";
                referenceTable: "sys_ws_definition";
            },
        >;
    }

    Hierarchy (View Summary)

    Index

    Properties

    active: Typed<
        boolean,
        {
            default: true;
            label: [
                {
                    hint: "Activates this version. Resources belonging to inactive versions cannot serve requests.";
                    label: "Active";
                    plural: "Active";
                },
            ];
            maxLength: 30;
        },
    >
    deprecated: Typed<
        boolean,
        {
            label: [
                {
                    hint: "Deprecates this version. Resources belonging to deprecated versions can serve requests but are identified as 'Deprecated' in API documentation.";
                    label: "Deprecated";
                    plural: "Deprecated";
                },
            ];
            maxLength: 30;
        },
    >
    is_default: Typed<
        boolean,
        {
            label: [
                {
                    hint: "Whether this version is the default. Resources belonging to the default version can be accessed from either versioned or non-versioned URIs.";
                    label: "Is default";
                    plural: "Is defaults";
                },
            ];
            maxLength: 30;
        },
    >
    short_description: Typed<
        string,
        {
            attributes: { edge_encryption_enabled: true };
            label: [
                {
                    hint: "The description of the version. Appears in API documentation.";
                    label: "Short description";
                    plural: "Short descriptions";
                },
            ];
            maxLength: 80;
        },
    >
    version: Typed<
        number,
        {
            label: [
                {
                    hint: "The number of this version";
                    label: "Version";
                    plural: "Versions";
                },
            ];
            mandatory: true;
            maxLength: 10;
            readOnly: true;
            readOnlyOption: "instance_configured";
        },
    >
    version_id: Typed<
        string,
        {
            attributes: { edge_encryption_enabled: true };
            dynamicValueDefinitions: {
                calculatedValue: "if (current.version)\n\tcurrent.version_id = 'v' + current.version;";
                type: "calculated_value";
            };
            label: [
                {
                    hint: "The version identifier used to indicate this version in URIs";
                    label: "Version ID";
                    plural: "Version IDs";
                },
            ];
            mandatory: true;
            readOnly: true;
            readOnlyOption: "instance_configured";
        },
    >
    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 version belongs to";
                    label: "API definition";
                    plural: "API definitions";
                },
            ];
            mandatory: true;
            readOnly: true;
            readOnlyOption: "instance_configured";
            referenceTable: "sys_ws_definition";
        },
    >