API Endpoints
A list of the API Endpoints available to you in your instance of Re-flow can be retrieved using the following URL.
Method | Request URL |
|---|---|
GET |
Example Response
These are the packaged Re-flow endpoints.
A typical API GET Response ‘Header’
{"status": "success","requestTime": "2020-09-04 13:47:37","data": {"total": 25656,"limit": 10,"offset": 0,"count": 10,"items": [{........Field | Value | Comments |
|---|---|---|
status | success | API Response status. |
requestTime | 2020-09-04 13:47:37 | When the request was made. |
data.total | 25656 | Total number of records. |
data.limit | 10 | Maximum number of records to return in response. |
data.offset | 0 | Starting point of the 10 records to return. 0 equates to starting from the 1st record. |
data.count | 10 | Number of records returned in response. |
data.items | Many | Records |
Available Methods
Method | Details | System area supported |
|---|---|---|
GET | Retrieve data | All |
POST | Create a new record | All apart from 'Forms'. It is not currently possible to create a new form template using an API. |
PUT | Update a new record | All apart from 'Forms'. It is not currently possible to update a form template using an API. |
DELETE | Delete a record | All apart from 'Forms'. It is not currently possible to delete a form template using an API. |
Please Note is it not currently possible to POST, PUT or DELETE multiple Entities at a Time - Each request must be written to action on a single Resource at a time.
You cannot, for example, string a number of requests together in a single Json payload to create multiple Jobs in one go.