The data access REST API exposes operations on application submitted data, also known as records.
The data captured by an HCL Leap application is stored in a relational database. Leap provides secure access to that data through the View Responses function, which allows filters and searches, and also allows data to be exported for analysis and reports. When accessing the data using the API, all security permissions as defined in the Access rules for the application are enforced.
All examples in this documentation use the program curl, which is available on most Linux™ systems, and can be downloaded for Windows™. However, you can use any tool or library for calling the REST API. For example, the Poster add-on for FireFox is useful for experimenting with the REST API.
To get the Swagger definition for the entire Data Access REST API, use /apps-basic/anon|secure/org/data/swagger.json . To get the Swagger definition for a given application and form, use /apps-basic/anon|secure/org/data/{app_uid}/{form_id}/swagger.json.
URL | HTTP Verb Header | Action Name |
---|---|---|
/apps-basic/secure|anon/org/data/{app-uid}/{form-id} | GET | List |
/apps-basic/secure|anon/org/data/{app-uid}/{form-id}/{record-uid} | GET | Retrieve |
/apps-basic/secure|anon/org/data/{app-uid}/{form-id}?freedomIdentifyKey={x} | POST | Create |
/apps-basic/secure|anon/org/data/{app-uid}/{form-id}/{record-uid}?freedomIdentifyKey={x} | PUT | Update |
/apps-basic/secure|anon/org/data/{app-uid}/{form-id}/{record-uid}?freedomIdentifyKey={x} | DELETE | Delete |
/apps-basic/secure|anon/org/data/{app-uid}/{form-id}/metadata | GET | Metadata |
/apps-basic/secure|anon/org/data/{app-uid}/{form-id}/attachment/{attachment-uid} | GET | Retrieve Attachment |
/apps-basic/secure|anon/org/data/{app-uid}/{form-id}/attachment/ | POST | Create Attachment |
All dates, times, and timestamps must be listed in ISO 8601 format.