Data access REST API
The data access REST API exposes operations on application submitted data, also known as records.
The data captured by an
HCL Domino Volt
application is stored in a Domino database. Domino Volt 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.
Note: Because HCL Domino does not support OAuth, the Volt REST API is
not designed to be used by a cross-origin web application. It is not a
good practice to use basic authentication to make an API request from
another web application. Therefore, the Volt REST API is most useful
to a server-based application or a native mobile application, where
basic authentication credentials are properly protected. Future
releases of HCL Domino Volt will provide better support for
cross-origin web applications.
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 /volt-api/anon|secure/org/data/swagger.json . To get the Swagger definition for a given application and form, use /volt-api/anon|secure/org/data/{app_uid}/{form_id}/swagger.json.
| URL | HTTP Verb Header | Action Name |
|---|---|---|
| /volt-api/secure|anon/org/data/{app-uid}/{form-id} | GET | List |
| /volt-api/secure|anon/org/data/{app-uid}/{form-id}/{record-uid} | GET | Retrieve |
| /volt-api/secure|anon/org/data/{app-uid}/{form-id}?freedomIdentifyKey={x} | POST | Create |
| /volt-api/secure|anon/org/data/{app-uid}/{form-id}/{record-uid}?freedomIdentifyKey={x} | PUT | Update |
| /volt-api/secure|anon/org/data/{app-uid}/{form-id}/{record-uid}?freedomIdentifyKey={x} | DELETE | Delete |
| /volt-api/secure|anon/org/data/{app-uid}/{form-id}/metadata | GET | Metadata |
| /volt-api/secure|anon/org/data/{app-uid}/{form-id}/attachment/{attachment-uid} | GET | Retrieve Attachment |
| /volt-api/secure|anon/org/data/{app-uid}/{form-id}/attachment/ | POST | Create Attachment |
- app-uid: is the UID of the application
- form-id: is the ID of the form
- record-uid: is the UID of the record
- attachment-uid: is the UID of the attachment
- x: is a randomly generated, difficult to guess single-use numerical value
- The context for the REST API (/volt-api/) is different from accessing Domino Volt in the browser (/volt-apps/).
- The /volt-api/ context uses basic authentication rather than form-based authentication.
- The credentials used for authentication must match the users and permissions specified by the application designer in the Access tab. Each form and stage can have different permissions set for each REST API action.
- Use /anon if your applications allow anonymous access.
All dates, times, and timestamps must be listed in ISO 8601 format.