Community articleIBM Domino Access Services overview
Added by IBM contributorIBM on October 25, 2013
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

IBM® Domino® Access Services are Web REST services that provide a standard way of accessing Domino resources over HTTP.
IBM Domino Access Services are REST services that provide a standard way of accessing Domino resources over HTTP. Applications that use REST services use HTTP requests to post data (create and/or update), read data (for example, make queries), and delete data. REST services use HTTP for all create, read, update, and delete operations.

The services that are currently available with IBM Domino Access Services are the following:
  • Domino Core Service - This REST API provides access to resources not specific to any one service domain. For example, most applications have a requirement to read information about authenticated user passwords (last change date, expiration date, etc). Since this requirement is not specific to any one particular REST service (calendar, mail, etc.), this feature is included in the Core services. The resources currently available from the Core services include:
    • password statistics resource (pwstats)
    • nonce resource
  • Domino Data Service - This is a REST API that accesses databases on Domino servers. The Domino Data Service receives requests and sends responses using HTTP and HTTPS protocols with body content in JSON format.
  • Domino Calendar Service - This is a REST API that provides resources and methods to access calendar data. The service represents calendar data in both JSON and iCalendar format.

IBM Domino Access Services are implemented by the OSGI plugins that are installed with this release of Domino. Once you have installed Domino, no additional steps are required to install the services. A client application discovers which REST services are installed and enabled on a server by sending a GET request to /api. To look at a sample response, refer to the Services GET (Services resource) reference topic.

As seen in the sample response, each REST service has its own resource address space: /api/data for the Data service, /api/calendar for the Calendar service, /api/core for the Core service, and so on.

In most cases the Domino administrator can decide which services will run on a particular server. For example, the response example shows the administrator has enabled the Calendar service ("enabled": true), but not the Data service ("enabled": false). All requests to /api/data would then fail with HTTP status 403 (Forbidden).

The Core service is always enabled. Unlike the other services, the administrator does not have to intentionally enable the Core service. As long as the HTTP task is loaded, the Core service is available.

What's new in IBM Domino Access Services Release 9.0.1 Social Edition

The following changes are made for IBM Domino Access Services Release 9.0.1 Social Edition:
  • The core service was added. The resources available from the core service include:
    • password statistics resource (pwstats)
    • nonce resource
  • The calendar service was added. This is a REST API that provides resources and methods to access calendar data. The service represents calendar data in both JSON and iCalendar format.

Relative URLs in the data service


All URLs in JSON responses are now relative to the server. In other words, data service URLs no longer include the protocol, server and port number.

For example, in 9.0, a data service @href property looked like the following:


In 9.0.1, the same property looks like the following:
"@href":"/admin4.nsf/api/data/collections"


This change has the potential to break existing applications using the data service. If necessary, you can restore the old behavior by adding the following setting to the Domino server NOTES.INI file:
DataServiceAbsoluteUrls=1

This setting only affects the data service.

Related concepts


IBM Domino Access Services overview
Administering IBM Domino Access Services overview
Accessing IBM Domino Access Services
Troubleshooting IBM Domino Access Services