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.
Metadata
This JSON-only action retrieves a description of the items in your form.

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.

Metadata

This JSON-only action retrieves a description of the items in your form.

Note: The curl command must be entered as a single line.

curl --user <loginId>:<passwd> http://<host>:<port>/volt-api/secure/org/data/
dd34da19-15c4-4267-8f1e-9f12ece743d7/F_Form1/metadata

{
	"metadata": {
		"fields": [{
			"name": "F_SingleLine1",
			"uiType": "textField",
			"dataType": "string",
			"label": "First Name"
		},
		{
			"name": "F_SingleLine2",
			"uiType": "textField",
			"dataType": "string",
			"label": "Last Name"
		},
		{
			"name": "F_Number1",
			"uiType": "number",
			"dataType": "decimal",
			"label": "Hours worked",
			"decimalPlaces": 2
		}]
            }
}