What's new in Domino REST API v1.1.2 - v1.1

Important

Items marked in red are API changes that may impact your applications and should be reviewed before upgrading.
Always be aware of features that have been deprecated in the current and earlier releases by checking deprecated features.

v1.1.2 - What's new or changed

Release date: February 24, 2025

New features

Domino REST API Administrators can now create a support package from either the Management console or by using specific console commands on the Domino console. The support package is a collection of files that can help the support team to better identify, troubleshoot, and resolve encountered issues. For more information, see Create support package.
Added the console command tell restapi support for creating a support package and tell restapi support -includensf for creating a support package that includes the KeepConfig.nsf when executed on the Domino console. For more information, see Domino REST API task.
Added the console command tell restapi refresh to update the Domino REST API configuration without restarting the Domino REST API task. For more information, see Domino REST API task.
Added GET webdav-v1/locks endpoint to get a list of all currently locked OFBA documents.
Added DELETE webdav-v1/lock/{lockKey} endpoint to remove the OFBA lock specified by a lockKey and to terminate the session of the user who owns the lock. The requestor must be the lock owner, the manager of the locked document's database, or a member of the LocalKeepAdmins group to remove the lock.
Added the Prevent Design Refresh toggle in the Admin UI to flag the schema written to the database, so the Domino design task won't replace or delete the schema. For more information, see Edit a schema.
Added the Required toggle in the Field Setting under Schema Management of the Admin UI to mark a field as a required field.
Added the Validation Rules section under Schema Management of the Admin UI to allow the addition of rules for validating fields using Formula Language. For more information, see Change form configuration.
Added support for schema backup.
Preview: New options for logging in to the Admin UI

There are new options for logging in to the Admin UI. One new option uses Domino REST API IdP and implements the OAuth process requiring user consent to log in. The other new option is using an external IdP to log in to the Admin UI that uses authorization code flow with PKCE.

For more information on how to log in to the Admin UI, see Log in options. For more information on how to configure and use an external IdP to log in to the Admin UI, see Set up Admin UI external IdP login configuration.

Improvements

Added an Overview link on the Admin UI landing page that opens the Domino REST API functional diagram when clicked. Clicking parts of the functional diagram directs you to corresponding documentation topics for easier navigation.
Enhanced user experience when editing a supported Microsoft Office file attached to a Domino document as the editing session does not expire as long as the Microsoft Office application is open.

Others

Moved the GET webdav-v1/login/idpList endpoint from WebDAV OpenAPI to Basis OpenAPI and renamed it to GET v1/auth/idpList endpoint. Added the configFor query parameter as a required parameter of the endpoint to specify what external IdP to retrieve.
Specifying a kyr file name in the KeepCertStoreName is set to be deprecated and is no longer encouraged. A warning will be issued if a kyr file name is specified.
Using KeepCertStoreName=* to specify multiple explicit DNS names in the KeepCertStoreName is set to be deprecated and is no longer encouraged. While it is still functional, a warning will appear when used.
Added procedure for testing access formulas in Mode Settings under Schema Management of the Admin UI. For more information, see Test formulas.
Installer jar files:
- For Domino 14: restapiInstall-r14.jar
- For Domino 12: restapiInstall-r12.jar
Docker image version for docker compose .env file (CONTAINER_IMAGE):
- For Domino 14: domino-rest-api:1.1.2-r14
- For Domino 12: domino-rest-api:1.1.2-r12
Docker image version for docker compose .env file from Harbor:
- For Domino 14: hclcr.io/domino/restapi:1.1.2-r14
- For Domino 12: hclcr.io/domino/restapi:1.1.2-r12

v1.1.1 - What's new or changed

Release date: December 02, 2024

New features

When using the DRAPI IdP users can be locked out if they enter incorrect credentials several times. You can now view and reinstate these users without waiting for the lockout period to end via the Management console. For more information, see Release suspended users.
Users with valid JWT tokens can now be identified via the Users tab on the Management console. For more information, see Identify known users with valid JWT token.
The Domino REST API configuration settings and where they are located can be identified via the Config src tab on the Management console. For more information, see Find configuration sources.
Domino REST API administrators can now customize which API schemas and endpoints are available to meet specific requirements and use cases. For more information, see Customize available API schemas and endpoints.
Implemented the Monaco Editor to the Text View mode on the Source tab on the Schema Management page of the Admin UI. With this implementation, users can now also edit the database schema from the Text View mode. For more information, see Edit database schema JSON.
Added a new OpenAPI landing page that shows all the general API schemas and application-specific schemas, enabling users to easily find the schemas they require.
Added OpenAPI schema and Swagger page for the WebDAV API that provides endpoints to perform remote Web content authoring operations that support the Office Round Trip Experience and Virtual Spreadsheet features of Domino REST API.
Added the console command tell restapi idpstatus that shows the state of the configured identity providers when executed on the Domino console.

Improvements

When adding a JSON object to the database schema on the Source tab on the Schema Management page in the Admin UI, the value of the JSON object is now validated to ensure the correct format based on the selected JSON object type. For more information, see Edit database schema JSON.
When adding fields to a form on the Schema Management page in the Admin UI, users can now identify the property of the field by hovering over the info icon beside the field name. For more information, see Change form configuration.
The Clear passkey option has been removed from the Admin UI login page to avoid user confusion. This option only clears local storage data, not the actual passkey. To enhance the user experience, both the LOG IN WITH PASSWORD and LOG IN WITH PASSKEY options are available on the Admin UI login page. For more information, see Use WebAuthn (Passkey) to log in to Admin UI.
Added the column attributes twisties and responsesonly to the GET v1/lists endpoint response when the columns parameter is set to true.
Added hourly task to refresh TLS certificates when using the Domino Certificate Manager.
Implemented the remaining special-text functions when retrieving a view. Special-text functions are calculated at runtime and include functions, such as @DocNumber, @DocDecendants, @DocParentNumber.

Resolved issues

Forms or views with some special characters were not encoded when performing a REST call to retrieve the list of fields or columns, resulting in a 405 Method Not Allowed error response.
Editing a schema in the Admin UI led to an empty page when the name of the schema form or view contained #.
When calling the GET v1/lists/{name} endpoint using the view alias, the configured external names were not retrieved; instead, the column programmatic names were retrieved.
Implemented various fixes resolving issues when using Domino Certificate Manager to enable HTTPs.
Fixed the issue with the Domino REST API Task not always showing correctly via Domino Administrator Monitor pane.
Fixed the issues around Office Round Trip Editing in Windows using Webdav APIs.

Others

Added tip for ensuring successful round-trip editing on Windows.
Added Bruno as one of the tools you can use when dealing with REST APIs. For more information, see Bruno.
Installer jar files:
- For Domino 14: restapiInstall-r14.jar
- For Domino 12: restapiInstall-r12.jar
Docker image version for docker compose .env file (CONTAINER_IMAGE):
- For Domino 14: domino-rest-api:1.1.1-r14
- For Domino 12: domino-rest-api:1.1.1-r12
Docker image version for docker compose .env file from Harbor:
- For Domino 14: hclcr.io/domino/restapi:1.1.1-r14
- For Domino 12: hclcr.io/domino/restapi:1.1.1-r12

v1.1 - What's new or changed

Release date: September 30, 2024

New features

Domino REST API can now encrypt document fields and sign a document with keys stored in your Notes ID file. This protects data from unauthorized access and further enhances data security and integrity.

To learn more about encrypting, decrypting, and signing, see Using encryption, decryption, and signing during development.

To set up Domino REST API and enable this feature, see Set up Domino REST API for encryption, decryption, and signing.
Domino REST API can now enable HTTPS setup in Domino using Domino's certificate configuration. To learn more, see Enable HTTPS using the Domino Certificate Manager.
Added support for using external IdP for Office Round Trip Experience. For more information, see Setup external IdP for Office Round Trip Experience.
Added DELETE v1/nameddocument endpoint to delete a named document.
Added GET v1/nameddocument endpoint to retrieve a named document using the appropriate name.
Added GET v1/nameddocumentlist endpoint to retrieve a list of named documents.
Added POST v1/nameddocument endpoint to create and update a named document.

Important

A POST request replaces all fields listed in your schema. Ensure to include all the fields in the POST request body and the corresponding values you want to retain and overwrite.
Added GET v1/richtext/{richTextAs}/{unid} endpoint that returns a stream of data from a Rich Text field based on the specified format. The endpoint is usable for all Rich Text processors and combines the functionalities of the following endpoints:
- GET v1/richtext/markdown/{unid}
- GET v1/richtext/mime/{unid}
- GET v1/richtext/plain/{unid}

Improvements

Domino REST API Task

The Domino Addin Task has been updated with the following:
- When Domino REST API is started, it displays the messages REST API: Starting... and then REST API Started instead of printing a JSON status message.
- When Domino REST API is stopped, it now displays the message REST API: Shutdown instead of a long output of JSON.
- The Domino REST API Java process is now integrated with the Domino process, resulting in a better-integrated product and improved reliability.
- The Domino REST API Statistics can now be accessed via the Domino Console SHOW STAT command. To see just the Domino REST API statistics, use the SHOW STAT restapi command.
- The KeepManagementURL line in the notes.ini is no longer necessary. If set, it will be ignored.
Added an option of selecting additional modes when executing Quick Config.
Implemented UI enhancements to the Source tab under Schema Management in the Admin UI.
Added an option for exporting database schema as JSON file by copying the schema and then creating a JSON file containing the copied schema. For more information, see Export database schema as JSON file.

Resolved issues

The GET admin-v1/access/users endpoint returned a 404 No users found with requested name error when the value entered for the query parameter startsWith included a slash character.
Swedish characters were not correctly encoded and displayed in the response body when Office Round Trip Experience with RichText content was attempted using POST /v1/document endpoint.
Issues were encountered when logging in with MS-OFBA via Internet Explorer 8, as some login functions were not supported by the web browser.

Others

Updated Edit database schema JSON and Export schema as JSON file based on the UI enhancements to the Source tab under Schema Management.
The following endpoints have been replaced with the GET v1/richtext/{richTextAs}/{unid} endpoint:
- GET v1/richtext/markdown/{unid}
- GET v1/richtext/mime/{unid}
- GET v1/richtext/plain/{unid}
Installer jar files:
- For Domino 14: restapiInstall-r14.jar
- For Domino 12: restapiInstall-r12.jar
Docker image version for docker compose .env file (CONTAINER_IMAGE):
- For Domino 14: domino-rest-api:1.1.0-r14
- For Domino 12: domino-rest-api:1.1.0-r12
Docker image version for docker compose .env file from Harbor:
- For Domino 14: hclcr.io/domino/restapi:1.1.0-r14
- For Domino 12: hclcr.io/domino/restapi:1.1.0-r12