http
Provides methods for working with HTTP(S)
Assert if HTTP cookie is presented in the response
Parameters:
Name | Type | Description |
|---|---|---|
cookieName | String | A HTTP cookie name. |
cookieValuePattern | String | optional An optional HTTP cookie value pattern. |
Assert if HTTP header is presented in the response
Parameters:
Name | Type | Description |
|---|---|---|
headerName | String | A HTTP header name. |
headerValuePattern | String | optional An optional HTTP header value pattern. |
Assert response time
Parameters:
Name | Type | Description |
|---|---|---|
maxTime | Number | Maximum response time in milliseconds. |
Assert the last HTTP response's status code
Parameters:
Name | Type | Description |
|---|---|---|
codeList | Number|Array | A single status code or a list of codes. |
Assert HTTP 200 OK status
Assert whether the specified pattern is present in the response body.
Parameters:
Name | Type | Description |
|---|---|---|
pattern | String | Pattern to assert. |
Performs HTTP DELETE
Parameters:
Name | Type | Description |
|---|---|---|
url | String | URL. |
headers | Object | optional HTTP headers. |
data | Object | Data. |
Returns:
Object - Response object.Performs HTTP GET
** Usage example:**
// Basic usage example:
var response = http.get(
'https://api.github.com/repos/oxygenhq/oxygen-ide/releases',
{
'Accept-Encoding': 'gzip, deflate',
'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:86.0) Gecko/20100101 Firefox/86.0'
});
log.info(response.body);
// If server returns Deflate-compressed stream without headers, `deflateRaw` can be used to decompress the content.
http.setOptions({
deflateRaw: true
});
var response = http.get('https://FOO.BAR');
log.info(response.body);
Parameters:
Name | Type | Description |
|---|---|---|
url | String | URL. |
headers | Object | optional HTTP headers. |
Returns:
Object - Response object.Returns last response object
Returns:
Object - Response object.Returns last response body
Returns:
String - Response body.Returns response headers
Returns:
Object - Response headers.Returns response URL
Returns:
String - Response URL.Performs HTTP PATCH
Parameters:
Name | Type | Description |
|---|---|---|
url | String | URL. |
data | Object | Data. |
headers | Object | optional HTTP headers. |
Returns:
Object - Response object.Performs HTTP POST
Parameters:
Name | Type | Description |
|---|---|---|
url | String | URL. |
data | Object | Data. |
headers | Object | optional HTTP headers. |
Returns:
Object - Response object.Performs HTTP PUT
Parameters:
Name | Type | Description |
|---|---|---|
url | String | URL. |
data | Object | Data. |
headers | Object | optional HTTP headers. |
Returns:
Object - Response object.Sets user defined HTTP options (such as proxy, decompress and etc.)
Parameters:
Name | Type | Description |
|---|---|---|
opts | Object | HTTP request options object, see Request Options. In addition to the options listed in the linked document, 'deflateRaw' option can be used when server returns Deflate-compressed stream without headers. |
Sets proxy url to be used for connections with the service.
Parameters:
Name | Type | Description |
|---|---|---|
url | String | Proxy server URL. Not passing this argument will reset the proxy settings. |
Opens new transaction.
The transaction will persist till a new one is opened. Transaction names must be unique.
Parameters:
Name | Type | Description |
|---|---|---|
name | String | The transaction name. |
Last modified 1yr ago