Lists
Lists correspond to your Domino views and are lists of documents.
By default, no lists will be exposed. You need to choose which views should be accessible.
Configure Lists
Back in the Domino REST API Admin UI, access the todorest Domino REST API Database again. This time, switch from “Database Forms” to “Database Views”. Select all views.
Remember to click “Save” to submit the changes.
Show Available Lists
- Hover over the “domino-restapi-todo” collection name and click on the ellipsis (three dots). Select “Add Request”.
- Name the request “get-lists” and click “Save to domino-restapi-todo”.
- Set the URL as “{{HOST}}/lists?dataSource=todorest”.
- Set the headers for “Authorization”.
- Click “Send”. You will get a list of all views available in the database. Domino REST API allows you to exclude access to certain views.
- Save and close the request.
Get Entries from a View
- Hover over the “domino-restapi-todo” collection name and click on the ellipsis (three dots). Select “Add Request”.
- Name the request “get-todo” and click “Save to domino-restapi-todo”.
- Set the URL as “{{HOST}}/lists/todosView?db=todorest”.
- Set the headers for “Authorization”.
- Click “Send”. You will get a list of entries in the view. The request can be refined with various querystring parameters:
- count specifies the number of entries to return.
- start specifies the number of entries entries to skip in a view
- documents set to
truereturns the full document data, using the “default” Form Access Mode. - mode can select the mode to display, only applicable if
documentsis set to true.
- Save and close the request.
By default, the column values are returned. This will include hidden columns, because visibility settings are being defined for the Notes Client. Domino REST API is designed for API access for other developers, not for end users. However, if documents is set to true, then the column values will be replaced with the fields on the underlying document as defined by the mode.