RestAPI

Description

REST API section is used to create API communication between baetho and different servers. Different API protocols like soap can be converted and used as REST.

Properties

Name: Name of the API

URL: This property specifies the URL path of the API

Type Of Call(GET): This is a mandatory field that specifies the type of REST API call.

Number of Automatic Retries: This field helps to set the number of retries if the API failed to execute. If this property set here, it applies to all the places where the API called in projects

Seconds to wait before timeout: This specifies the wait time to re-execute the failed API.

Success View: This property specifies the success view, When an API call executes successfully application will redirect to the mentioned view.

Loading View: This property specifies the loading view, When an API call is in the process of execution, the application will redirect to the mentioned view.

Error View: This property specifies the error view, When an API call is failed to execute, the application will redirect to the mentioned view.

Timeout View: This property specifies the timeout view, When an API call takes a longer time than the given timeout, the application will redirect to the given view.

Parameters

Add Parameter(+): This property adds the new parameter to the parameter list

Name: This specifies the name of the parameter.

Value: This specifies the value of the parameter.

Type: This specifies the type of the parameter. It can be a header, query, or a file.

Remove Parameter(-): This property removes the respective parameter from the parameter list

Body:

The body has two sections: One we can send data assets as a body, other we can type the content into the body section.

Data Asset Selector: This property lets the user to select the data asset from the list. To type the body content manually, the user needs to select option none.

Type Of Data: This property specifies the body data type. JSON and XML are allowed data types.

Set Up:

Result Type: This property specifies the API return type.

Select Where To Store Data: This property specifies the data asset to store the data returning from API calls.

Is This Data A Catalogue: If this is set to true, users can organize the returned data into a catalogue format. This kind of data used more in tile features.

Assign To Global Variable: This property helps to save specific data from the returned data into a global variable.

Events

Actions

Fetch: This action executes the API.

Cancel Fetch: This action cancels the execution of the API.