Versions Compared

Old Version 9

changes.mady.by.user Igor Shakhbazyan

Saved on

compared with

New Version 10

changes.mady.by.user Dina Baksheeva

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Merged branch "DOC0000565" into parent

This server class allows operating you to operate with REST responses.

SimpleRestResponse(response)

Objects of this class are created within invoking during the execution of the execute() method of the SimpleRestRequest server-side class.
NameTypeMandatoryDefault Value
responseResponseYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleSimpleRestResponse
linenumberstrue
<![CDATA[const request = sws.restRequestV1();
request.setRequestUrl('https://jsonplaceholder.typicode.com/todos/1');
request.setRequestMethod('GET');
const response = request.execute();


getBody()

This method returns the response body.


Return:

TypeDescription
StringThe response body.


Example:

Code Block
languagejs
themeEclipse
titlegetBody
linenumberstrue
<![CDATA[const request = sws.restRequestV1();
request.setRequestUrl('https://jsonplaceholder.typicode.com/todos/1');
request.setRequestMethod('GET');
const response = request.execute();
ss.info(response.getBody());
//  Info: {
//  "userId": 1,
//  "id": 1,
//  "title": "delectus aut autem",
//  "completed": false
//  }

getAllHeaders()

This method returns the array containing response headers.


Return:

TypeDescription
ObjectResponse headers.


Example:

Code Block
languagejs
themeEclipse
titlegetAllHeaders
linenumberstrue
<![CDATA[const request = sws.restRequestV1();
request.setRequestUrl('https://jsonplaceholder.typicode.com/todos/1');
request.setRequestMethod('GET');
const response = request.execute();
ss.info(response.getAllHeaders());
// Info: {"http-code":["200"],"date":["Mon, 31...

getContentBase64()

This method returns base64 encoded content. It is useful for getting a file in binary format.


Return:

TypeDescription
StringThe base64 encoded content.


Example:

Code Block
languagejs
themeEclipse
titlegetContentBase64
linenumberstrue
<![CDATA[const simpleInstanceUri = ss.getProperty('simple.instance.uri');
const URL_BASE = (simpleInstanceUri.startsWith('https://')) ? simpleInstanceUri : `https://${simpleInstanceUri}`;

const request = sws.restRequestV1();
request.setRequestUrl('https://s3-home.simpleone.ru/public-attachment/4/9f/istzt33ycijsiym7rv7ax92yd76l2arr?response-content-disposition=inline%3B%20filename%3D%22spacer24.gif%22&response-content-type=image%2Fgif%3B'); //the URL from which the file is downloaded
const downloadResponse = request.execute();

request.setRequestUrl(`${URL_BASE}/v1/attachments/upload/user/${ss.getUserId()}`); // the URL on which the file is uploaded
request.setRequestHeader('Authorization', `Bearer ${new SimpleUser().getAccessToken()}`);
request.addFileContent(downloadResponse.getContentBase64(), 'files', 'spacer24.gif');
const uploadResponse = request.execute();

getStatusCode()

This method returns the HTTP status code of the performed request performed.


Return:

TypeDescription
StringHTTP status code.


Example:

Code Block
languagejs
themeEclipse
titlegetStatusCode
linenumberstrue
<![CDATA[const request = sws.restRequestV1();
request.setRequestUrl('https://jsonplaceholder.typicode.com/todos/1');
request.setRequestMethod('GET');
const response = request.execute();
ss.info(response.getStatusCode());
// Info: 200


haveError()

This method displays an error notification if there was an error was reported during the REST transaction.


Return:

TypeDescription
BooleanThe error notification.


Example:

Code Block
languagejs
themeEclipse
titlehaveError
linenumberstrue
<![CDATA[const request = sws.restRequestV1();
request.setRequestUrl('https://jsonplaceholder.typicode.com/todos/1');
request.setRequestMethod('GET');
const response = request.execute();
ss.info(response.haveError());
// Info: false


Table of Contents
absoluteUrltrue
classfixedPosition