The API supports ONLY REST services that return type application/json .
The default ContentType used when sending requests to the service is application/json. The following is also supported multipart/form-data, if the header includes the parameter {'Content-Type': 'multipart/form-data'}. For example:
All elements in the response are processed as native variables in JavaScript. They can be accessed, for example, in this way:
response.status.code // <--- get the value from the `code` field, containing the response code, e.g. 200
response.status.message // <--- get the value from the `message` field, containing the response message, e.g. "Accepted"
response.headers.language // <--- get the value of the return header named `language`
response.body.user.type // <--- get the value of a specific field from the response, where the response looks like: {"user": {"type": "userType"}}
Exception definition
In the case of a return code other than 2XX, we will get an exception that can be handled.
E.g. in the case of code 404 (service unavailable or incorrect address), code 405 (invalid method), or code 500 (internal service error).
The exception looks as follows:
To verify whether this is an exception to be handled by us, we can check whether the caught element has the fields we are interested in.
Request definition
A request can be parameterized.
Requests can contain a payload:
And they can be without payload:
Below is the definition of the parameters:
The PATH definition looks as follows:
The TIMEOUTS definition looks as follows:
No TIMEOUTS
When the object TIMEOUTS is not defined for the executed REST request, the values from the configuration will be used. They are located in the parameters:
default specifies the value to be used when the object TIMEOUTS is not defined
maximum specifies the maximum value that the LOW-CODE Developer can set while preparing the request (if they set a higher one than specified, the value maximum)
Example executions of requests are shown in the sections below.
Requests
For each of the requests below, we assume a consistent configuration:
GET
Request without payload.
Examples:
And an example ScriptService:
DELETE
Request without payload.
Examples:
And an example ScriptService:
POST
Request with payload.
Examples:
And an example ScriptService:
PUT
Request with payload.
Examples:
And an example ScriptService:
PATCH
Request with payload.
Examples:
And an example ScriptService:
Eximee Designer
API hints have been provided in Eximee Designer.
Figure 1. Hints for GET / POST / PUT / DELETE requests.
Figure 2. Description of the hint for a specific request (GET).
Figure 3. View after inserting code automatically from the hint.
And hints for possible serviceIds to use at the current moment.
If there is a problem retrieving the current list of serviceIds, the editor continues to work, but does not provide information about any serviceId.
Figure 4. serviceId hint outside the character: ' and "
Figure 5. serviceId hint limited by the character: "
Examples
"demo_api_RestTest" - executing requests with different parameters
"demo_api_exchangeRate_404" - exception handling
"demo_api_exchangeRate_validator" - example of a validator calling an external service
API Testing (Postman)
Postman is a tool for testing and working with APIs that makes it easy to send HTTP requests (e.g. GET, POST) and analyze server responses. (https://www.postman.com/)
try {
// call the external service
} catch (exception) {
if (exception.status !== undefined && exception.status.code !== undefined) {
// handle our exception, e.g. return a default value
} else {
// this is not our exception, we can handle it or pass it on
throw exception;
}
}
SERVICE_ID: String; // <--- e.g. 'myServiceId'
HEADER: Map<String, String>; // <--- e.g. {'myHeader': 'value'}
PAYLOAD: Map<String, Object>; // <--- any valid object, e.g. {'user': 123, 'name': 'Lisa'}
TIMEOUTS: Map<String, Integer>; // <--- an object defining timeouts for the called service, e.g. {connectionTimeout: 2000, readTimeout: 2000}
{
pathParams: List<String>, // <--- successive parts of the service path, e.g. ['api', 'v1', 'path', 'to', 'endpoint'] for /api/v1/path/to/endpoint
queryParams: Map<String, String> // <--- remember that query params are always strings
}
{
connectionTimeout: Integer, // <--- connection establishment timeout in milliseconds
readTimeout: Integer // <--- response read timeout in milliseconds
}
function callService(context) {
const response = api.rest.v1.delete('httpbin', {pathParams: ['delete']}, {});
if (response.status.code === 200) {
return {'result': 'Item deleted successfully'};
} else {
return {'result': 'The item has already been deleted, or another problem occurred'};
}
}
function callService(context) {
const response = api.rest.v1.put('httpbin', {pathParams: ['put']}, {}, {'name': 'Lisa', 'country': 'PL', 'birthday': '29-02-1999'});
const userName = response.body.json.name;
return {'result': 'The user has been added to the database. User name: ' + userName};
}
