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

    Type Alias RestMessageFn

    RestMessageFn: {
        content?: string;
        endpoint?: string;
        headers?: RestMessageFnHeader[];
        httpMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD";
        lock?: boolean;
        midServer?: string;
        name: string;
        queryParams?: RestMessageQueryParam[];
        variables?: RestMessageParamSubstitution[];
    } & RestMessageFnAuth

    Type Declaration

    • Optionalcontent?: string

      Request body. Variable substitution supported via ${varName}

    • Optionalendpoint?: string

      Overrides parent message endpoint for this function. Variable substitution supported

    • Optionalheaders?: RestMessageFnHeader[]

      Headers specific to this function

    • httpMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD"

      HTTP method for this function

    • Optionallock?: boolean

      Lock function to prevent editing on instance

    • OptionalmidServer?: string

      sys_id of ecc_agent MID server to route this function through

    • name: string

      Function name, used in scripts to identify the HTTP method. Must be unique within the parent message.

    • OptionalqueryParams?: RestMessageQueryParam[]

      HTTP query parameters appended to the request URL

    • Optionalvariables?: RestMessageParamSubstitution[]

      Variable substitutions — the ${varName} placeholders used in this function's endpoint, content, and headers