Home
Reference
The documents in this section provide reference material and samples for HCL Domino Volt .
REST API reference
The REST API can be used by other programs to communicate with Domino Volt.
Data access REST API
The data access REST API exposes operations on application submitted data, also known as records.
Retrieve Attachment
This action retrieves a single attachment.

Reference
The documents in this section provide reference material and samples for HCL Domino Volt .
- REST API reference
  The REST API can be used by other programs to communicate with Domino Volt.
  - Data access REST API
    The data access REST API exposes operations on application submitted data, also known as records.
    - List
      This action retrieves a list of records.
    - Retrieve
      This action retrieves a single record.
    - Create
      This action creates new records.
    - Update
      This action updates an existing record.
    - Delete
      This action deletes an existing record.
    - Metadata
      This JSON-only action retrieves a description of the items in your form.
    - Retrieve Attachment
      This action retrieves a single attachment.
    - Create Attachment
      This action creates a single attachment.
  - Application management REST API
    The Application management REST API allows for programmatic import, export, upgrade, and delete of Domino Volt applications.
- JavaScript™ API
- Services
  The following topics provide reference information about adding services to HCL Volt.
- Embedding items in an iframe
  You can use iFrames to embed charts and applications in a web page.
- Embedding API
  The Embedding API is used to embed a Volt form directly in another webpage without using an <iframe>. The Volt form is inserted into the DOM of the hosting page and can be interacted with using the JavaScript API or any custom JavaScript. Additionally, the style of items in the form can be customized by the CSS of the hosting page.
- Creating customized Cascading Style Sheets
  You can apply your own custom Cascading Style Sheet (CSS) to the rendering of your HCL Domino Volt application. To create a custom theme, you must be familiar with the basic concepts of CSS.

Retrieve Attachment

This action retrieves a single attachment.

curl --user <loginId>:<passwd> "http://<host>:<port>/volt-api/secure/org/data/dd34da19-15c4-4267-8f1e-9f12ece743d7/F_Form1/attachment/ccb92c12-d435-4288-baff-878d8d3c2923"

Replace dd34da19-15c4-4267-8f1e-9f12ece743d7 with the app ID of the desired attachment.
Replace F_Form1 with the form ID of the desired attachment.
Replace ccb92c12-d435-4288-baff-878d8d3c2923 with the UID of the desired attachment.

To determine the UID of an attachment, you can use the Data access REST API to retrieve the data for a given record. If the form contains an attachment item, the data for that record will contain the UID, ID, and filename of the attachment. This information is also available in the response when you upload a file using the Create Attachment REST operation.

For example:

"F_Attachment1" :
{
  "fileName" : "some file.doc",
  "id" : 123,
  "uid" : "ccb92c12-d435-4288-baff-878d8d3c2923"
}

When retrieving an attachment, the credentials used for authentication must match the users and permissions specified by the application designer in the Access tab.