Understanding the Operation
In Reachware Studio, Operations define the communication between systems and Reachware via API endpoints. These operations can either export (retrieve data from a system) or import (send data to a system).
This guide outlines how to create a new operation, set it up, and test its functionality.
How to Create a New Operation
Click "Add Operation" on the dashboard.
A list of available systems appears. Each entry shows the system logo, name, and description. Use the search bar to quickly find your target system, then click on it to proceed.
Complete the general information for the operation.
General Information
| Field | Description |
|---|---|
| Operation Name | A user-defined name to identify the operation. |
| Operation Type | Export (GET/POST) or Import (POST/PUT/PATCH/DELETE) |
| System | Choose from a predefined list of systems. |
| Operation Group | Classify the operation (e.g., Customer, Invoice). |
| Retrieve URI | The endpoint URL used to retrieve or send data (e.g., /api/customer/{{customer_id}}). |
You can create a new Operation Group by navigating to the System window, then from the System List select Actions → View, opening the Operation Group tab, and clicking "Add New Group".
Query Parameters
| Field | Description |
|---|---|
| Key | Parameter name (e.g., status) |
| Value | Can be set in two ways: 1. Dynamic: Use {{double curly braces}} to define a variable, the value gets filled in the Flow Template at runtime. 2. Fixed: Enter a plain value, use this only if the value will never change. |
Always try to use the Dynamic way, it gives you more flexibility to reuse the same operation across different flows.
Request Body
HTTP Method
| Method | Use |
|---|---|
| GET | Retrieve data |
| POST | Create records |
| PUT | Update entire record |
| PATCH | Update specific fields |
| DELETE | Remove records |
Body Type
| Type | Use When |
|---|---|
| none | GET or DELETE requests |
| raw | Most API calls (JSON/XML) |
| form-data | File uploads |
| x-www-form-urlencoded | HTML forms |
Format (for raw type)
- Json — Most common
- Xml — For XML APIs
- Text — Plain text
- JavaScript — JavaScript data format
- HTML — HTML content format
Request Body Structure
Use JSON format with placeholders:
"SiteID": "{{site_id}}",
"ExpiryDate": "{{expiry_date}}"
}
Operation Variables
| Field | Description |
|---|---|
| Name | Variable name used in the operation. |
| Value | Optional default value. Leave Value empty and filled in the Flow Template. This keeps the operation flexible and reusable across multiple flows. |
| Description | A short note explaining what this variable is for, helps others understand the operation. |
Variable Type | The data type of the variable's value (String, boleen, integer, etc...) |
Select the relevant connection, then click "Test Connection" to verify the endpoint's accessibility. After successful validation, click "Run" to simulate the API operation.
Inspect both the HTTP Request and HTTP Response formats. You can download or save the result as JSON for further analysis.
Click Save to apply your configuration.
Related Topics
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article