References
This section provides technical descriptions, configuration parameters, access control settings, troubleshooting steps, and other essential information for using HCL Domino REST API. It provides resources to help you effectively configure, manage, and utilize the Domino REST API.
System requirements
Specifies the minimum system requirements necessary to install and run the Domino REST API, ensuring compatibility and optimal performance.
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.
Configuration overview
Covers the core configuration concepts and parameters that enable effective management and customization of the Domino REST API.
Functional accounts
Describes functional accounts for accessing Domino REST API ports, each serving different purposes and requiring distinct access controls and security settings.
OpenAPI
Discusses OpenAPI definitions and specifications.
Access control
Details responsibilities and access rights of key roles and discusses application access, anonymous access, and access requirements for certain tools.
Schema and scope overview
Introduces key concepts essential to working with and using the Domino REST API.
Using Domino REST API
Provides essential information for effectively using the Domino REST API.
Using Admin UI
Introduces the web-based, intuitive interface that allows users to manage schemas, scopes, and applications.
Security
Describes the multi-layered security measures implemented by the Domino REST API.
Extensibility
Introduces the required fundamental understanding of the architecture, tooling, and extension points to ease the extensibility of the Domino REST API.
Domino REST API SDKs
List of available Domino REST API SDKs
Troubleshooting
Details common errors in installing and running the Domino REST API service and their corresponding resolutions.
Limitations and constraints
Outlines known limitations and important considerations for using the Domino REST API.
Rich Text extensions
Details how users can have or use their own implementation of Rich Text processors to better meet specific needs and enhance Rich Text representation.
Standards and glossary
List of standards and commonly used terms for the Domino REST API.
Contact support
Helps you understand what information to provide to ensure that your support needs are addressed effectively.
User tools
List of tools you can use when dealing with REST APIs.
Downloads
Downloadable assets to get you started in using the Domino REST API.
Deprecated features
List of deprecated features along with recommended alternatives to ensure a smooth transition and continued compatibility with current and future versions of the Domino REST API.
Guide to documentation
Provides information on using the Domino REST API documentation.
Documentation references
- Provides documentation, release information, and more details on how to install, configure, and manage Domino servers and related components.
- Provides documentation and release information about HCL Volt MX Go.
Acknowledgements
Database icons by monkik from www.flaticon.com.