xatkit-bot-platform/xatkit-rest-platform

Xatkit Rest Platform

⚠ This platform is outdated and not actively supported anymore.

A set of actions to perform REST requests and handle responses.

Providers

The Rest platform does not define any provider.

Actions

Action	Parameters	Return	Return Type	Description
GetJsonRequest	- endpoint (String): the REST endpoint to send the request to - queryParameters (Map<String, Object>, Optional): the request parameters - pathParameters (Map<String, String>, Optional): the request path parameters - headers (Map<String, String>, Optional): the request headers	The response from the REST endpoint.	ApiResponse<JsonElement>	Performs a GET request on the provided endpoint with the specified parameters.
GetJsonRequestWithBody	- endpoint (String): the REST endpoint to send the request to - queryParameters (Map<String, Object>, Optional): the request parameters - pathParameters (Map<String, String>, Optional): the request path parameters - requestBody (JsonElement, Optional): the request body - headers (Map<String, String>, Optional): the request headers	The response from the REST endpoint	ApiResponse<JsonElement>	Performs a GET request on the provided endpoint with the specified parameters and the given body.
GetJsonRequestWithFormData	- endpoint (String): the REST endpoint to send the request to - queryParameters (Map<String, Object>, Optional): the request parameters - pathParameters (Map<String, String>, Optional): the request path parameters - headers (Map<String, String>, Optional): the request headers - formParameters (Map<String, Object>, Optional): the request form parameters	The response from the REST endpoint	ApiResponse<JsonElement>	Performs a GET request on the provided endpoint with the specified parameters and the given formParameters.
PostJsonRequestWithBody	- endpoint (String): the REST endpoint to send the request to - queryParameters (Map<String, Object>, Optional): the request parameters - pathParameters (Map<String, String>, Optional): the request path parameters - requestBody (JsonElement, Optional): the request body - headers (Map<String, String>, Optional): the request headers	The response from the REST endpoint	ApiResponse<JsonElement>	Performs a POST request on the provided endpoint with the specified parameters and the given body.
PostJsonRequestWithFormData	- endpoint (String): the REST endpoint to send the request to - queryParameters (Map<String, Object>, Optional): the request parameters - pathParameters (Map<String, String>, Optional): the request path parameters - headers (Map<String, String>, Optional): the request headers - formParameters (Map<String, Object>, Optional): the request form parameters	The response from the REST endpoint	ApiResponse<JsonElement>	Performs a POST request on the provided endpoint with the specified parameters and the given formParameters.
PutJsonRequestWithBody	- endpoint (String): the REST endpoint to send the request to - queryParameters (Map<String, Object>, Optional): the request parameters - pathParameters (Map<String, String>, Optional): the request path parameters - requestBody (JsonElement, Optional): the request body - headers (Map<String, String>, Optional): the request headers	The response from the REST endpoint	ApiResponse<JsonElement>	Performs a PUT request on the provided endpoint with the specified parameters and the given body.
PutJsonRequestWithFormData	- endpoint (String): the REST endpoint to send the request to - queryParameters (Map<String, Object>, Optional): the request parameters - pathParameters (Map<String, String>, Optional): the request path parameters - headers (Map<String, String>, Optional): the request headers - formParameters (Map<String, Object>, Optional): the request form parameters	The response from the REST endpoint	ApiResponse<JsonElement>	Performs a PUT request on the provided endpoint with the specified parameters and the given formParameters.
DeleteJsonRequest	- endpoint (String): the REST endpoint to send the request to - queryParameters (Map<String, Object>, Optional): the request parameters - pathParameters (Map<String, String>, Optional): the request path parameters - headers (Map<String, String>, Optional): the request headers	The response from the REST endpoint.	ApiResponse<JsonElement>	Performs a DELETE request on the provided endpoint with the specified parameters.
DeleteJsonRequestWithBody	- endpoint (String): the REST endpoint to send the request to - queryParameters (Map<String, Object>, Optional): the request parameters - pathParameters (Map<String, String>, Optional): the request path parameters - requestBody (JsonElement, Optional): the request body - headers (Map<String, String>, Optional): the request headers	The response from the REST endpoint	ApiResponse<JsonElement>	Performs a DELETE request on the provided endpoint with the specified parameters and the given body.
DeleteJsonRequestWithFormData	- endpoint (String): the REST endpoint to send the request to - queryParameters (Map<String, Object>, Optional): the request parameters - pathParameters (Map<String, String>, Optional): the request path parameters - headers (Map<String, String>, Optional): the request headers - formParameters (Map<String, Object>, Optional): the request form parameters	The response from the REST endpoint	ApiResponse<JsonElement>	Performs a DELETE request on the provided endpoint with the specified parameters and the given formParameters.

Options

The Rest platform supports the following configuration options

Key	Values	Description	Constraint
xatkit.rest.default.query.parameters	String	The default parameters to add to the sent REST request. This value must match the following pattern: param1=value1&param2=value2	Optional (default to no query parameter)
xatkit.rest.default.headers	String	The default headers to add to the sent REST request. This value must match the following pattern: headerName1:value1&headerName2:value2	Optional (default to no headers)