Documentation

Extensions Reference: NetworkHTTPRequest
- NetworkHTTPRequest

Extensions Reference: NetworkHTTPRequest¶

API Reference
NetworkHTTPRequest

Request

NetworkHTTPRequest

NetworkHTTPRequest¶

It is possible to make HTTP calls from your JavaScript Extension. The NetworkHTTPRequest class serves as a proxy between your Extension and the network.

You can initialize a new NetworkHTTPRequest object:

const http_request = new NetworkHTTPRequest();
http_request.requestUrl = "https://api.apiblueprint.org/parser"
http_request.requestMethod = "POST"
http_request.requestTimeout = 3600000
http_request.requestBody = "myString"
http_request.setRequestHeader "Content-Type", "text/vnd.apiblueprint+markdown; version=1A; charset=utf-8"
http_request.send()
console.log(http_request.responseStatusCode)
console.log(http_request.responseBody)

and then set the attributes of your request via the following properties and methods.

Warning Do not confuse this class NetworkHTTPRequest with the Request class that represents a user created Request in a Paw Collection.

requestUrl

requestUrl¶

The request URL, this property must be set before the request is sent.

requestMethod

requestMethod¶

The request method, default is GET.

requestTimeout

requestTimeout¶

Timeout (in milliseconds), default is 5 minutes (300,000 milliseconds).

requestBody

requestBody¶

Body encoded in UTF-8.

responseStatusCode

responseStatusCode¶

The response status code as a number (e.g. 200 or 404), this can be called only after the send() method returned.

responseHeaders

responseHeaders¶

The response headers as a dictionary, this can be called only after the send() method returned.

responseBody

responseBody¶

The response body as a string (decoded according to the Content-Type), this can be called only after the send() method returned.

setRequestHeader

setRequestHeader¶

Argument: headerName: string: None
Header name

Argument: headerValue: string: None
Header value

Sets a request header.

getRequestHeader

getRequestHeader¶

Argument: headerName: string: None
Header name

Returns: None: string
Gets a request header.

getResponseHeader

getResponseHeader¶

Argument: headerName: string: None
Header name

Returns: None: string
Gets a response header. This can be called only after the send() method returned.

send

send¶

Returns: None: boolean

true: on success
false: otherwise

Send synchronously the request.