Response

Methods Summarized

Type	Name	Summary
String	getCharset()	Get the charset of the response body.
String	getException()	Getter for the exception message.
Array	getMediaData()	Get the content of response as binary data.
String	getResponseBody()	Get the content of the response as String.
Object	getResponseHeaders()	Gets the headers of the response as name/value arrays.
Object	getResponseHeaders(headerName)	Gets the headers of the response as name/value arrays.
Number	getStatusCode()	Gets the status code of the response, the list of the possible values is in HTTP_STATUS constants.
String	getStatusReasonPhrase()	Gets the status code's reason phrase.

Methods Detailed

getCharset()

Get the charset of the response body.

Returns: String

Sample

var charset = response.getCharset();

getException()

Getter for the exception message.

Returns: String the exception message

Sample

var exception = response.getException();

getMediaData()

Get the content of response as binary data. It also supports gzip-ed content.

Returns: Array

Sample

var mediaData = response.getMediaData();

getResponseBody()

Get the content of the response as String.

Returns: String

Sample

var pageData = response.getResponseBody();

getResponseHeaders()

Gets the headers of the response as name/value arrays.

Returns: Object

Sample

var allHeaders = response.getResponseHeaders();
var header;

for (header in allHeaders) application.output(header + ': ' + allHeaders[header]);

getResponseHeaders(headerName)

Gets the headers of the response as name/value arrays.

Parameters

• String headerName ;

Returns: Object

Sample

var contentLength = response.getResponseHeaders("Content-Length");

getStatusCode()

Gets the status code of the response, the list of the possible values is in HTTP_STATUS constants.

In case there was an exception executing the request, please ignore/do not use this value (it will be 0). You can check that situation using response.getException().

Returns: Number

Sample

var status = response.getStatusCode();// compare with HTTP_STATUS constants

getStatusReasonPhrase()

Gets the status code's reason phrase. For example if a response contains status code 403 (Forbidden) it might be useful to know why.

For example a Jenkins API req. could answer with "403 No valid crumb was included in the request" which will let you know that you simply have to reques a crumb and then put that in the request headers as "Jenkins-Crumb". But you could not know that from 403 status alone...

Returns: String

Sample

var statusReasonPhrase = response.getStatusReasonPhrase();

---