Skip to content

Tutotials

The tutorials are designed to familiarize Domino REST API administrators, as well as Notes and web developers, with the features and usage of the Domino REST API.

Quickstart

Intended for users with experience working with HCL Notes and HCL Domino who want to quickly install, configure, and start using the Domino REST API.

Installation and configuration

Outlines the steps to install the Domino REST API and the necessary configuration tasks after installation to complete a production-ready deployment, ensuring full capability and a secure interface for your Domino applications.

Capability walkthrough

Guides you step-by-step through using and configuring the Domino REST API, utilizing the command line, Postman, the Domino REST API Admin UI, and code examples.

Using Admin UI

Provides simple, step-by-step instructions for using the Admin UI to set up and manage a Domino database. It guides you through preparing database access, logging in, creating schemas and scopes, configuring forms, views, and agents, and finally logging out from the Admin UI.

Using Postman and curl

Guides you on using Domino REST API with Postman and curl.

Using Swagger UI

Guides you through using the Swagger UI to visualize and interact with the Domino REST API endpoints.

OData tutorial

Demonstrates how to export data from Notes databases to OData using Domino REST API.

Extensibility tutorial

Guides you through the creation of a custom URL endpoint that handles the approval and rejection of generic requests.

Note

You need to be familiar with Java and Domino to follow the tutorial.

More tutorials

Additional tutorials are available at the HCL Domino REST API Tutorials page. For more information, see the tutorial descriptions below:

  • Domino ToDo Database tutorial

    Intended for Notes and Domino developers. The tutorial walks you through:

    • Using the XPages ToDo Application.
    • Viewing the ACL via Domino REST API Postman APIs.
    • Configuring it for validated Domino REST API access.
    • Using OData to access data in Microsoft Excel 1. All steps are done via the Domino REST API Admin UI.

  • New Domino Database tutorial

    Intended for web developers who are new to Domino. The tutorial walks you through:

    • Creating a new Domino database.
    • Adding forms for customers and contacts.
    • Adding views.
    • Configuring the database for validated REST API access.
    • Updating the access for the database. Some steps are done via the Domino REST API Admin UI, some via Postman.

  1. Microsoft and Microsoft Excel are registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. ↩