Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This server Use this class allows you to operate with the REST responses.
SimpleRestResponse(response)
Objects of this class are created during the execution
of theof the execute() method of the SimpleRestRequest server-side class.
Return:
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
const request = sws.restRequestV1();
request.setRequestUrl('https://jsonplaceholder.typicode.com/todos/1');
request.setRequestMethod('GET');
const response = request.execute(); |
getBody()
This Use this method returns to get the response body.
Return:
| Type | Description |
|---|---|
| String | The response body. |
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
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 Use this method to get an object that contains the response headers.
Return:
| Type | Description |
|---|---|
| Object | Response headers |
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
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 With this method you can receive the response content encoded to base64. Use it to get the file in binary format.
Return:
| Type | Description |
|---|---|
| String or null | The base64 encoded content. |
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
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 Use this method returns to return the HTTP status code of the performed request.
Return:
| Type | Description |
|---|---|
| String | The HTTP status code. |
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
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 an error was reported Use this method to verify whenther any errors occured during the REST transaction.
Return:
| Type | Description |
|---|---|
| Boolean |
| If some errors occured, the method returns true; otherwise, the method returns false. |
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
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 | ||||
|---|---|---|---|---|
|