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.
Create Attachment
This action creates 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.

Create Attachment

This action creates a single attachment.

curl --user <loginId>:<passwd> -F filename=@c:\new file.doc --header "Accept:application/json" "http://<host>:<port>/volt-api/secure/org/data/dd34da19-15c4-4267-8f1e-9f12ece743d7/F_Form1/attachment/"

Accept

Indicates the type of accepted response.

ATOM: application/atom+xml
JSON: application/json

The attachment that is created must be uploaded to the server as multipart/form-data in the body of a POST.

The response from this call contains the UID, ID, and filename of the newly created attachment.

For example:

{"id" : 178, "fileName" : "new file.doc", "uid" : "ccb92c12-d435-4288-baff-878d8d3c2923" }

The UID value that is returned here can be later used with the Retrieve Attachment REST operation.

For the attachment to be associated with a form record, a form record must be created or updated that refers to that attachment. Use the Data access REST API, passing the UID, ID, and filename of the attachment.

Example JSON payload:

{
	"pressedButton":"S_Submit",
	"F_SingleLine1" : "22",
	"F_Number2" : 1,
	"F_Number3" : 2,
	"F_Number4" : 3,
	"F_Attachment1" :
	{
		"uid" : "ccb92c12-d435-4288-baff-878d8d3c2923",
		"fileName" : "new file.doc",
		"id" : 178
	}
}

If an attachment is not associated with a form record within a certain time period (48 hours by default), the attachment is deleted automatically. Deleting the record that is associated with an attachment also deletes the attachment.