Administration APIs for interacting with HCL Traveler administration data
The HCL Traveler Administration service provides a set of REST-based APIs for interacting with HCL Traveler administration data.
The HCL Traveler Admin Service is built on Domino Access Services. The service receives requests and sends responses using HTTP and HTTPS protocols using the /api/traveler URI. The response data is provided in JSON format.
Examples of service usage:
- To retrieve the first 10 Traveler users:
https://my.trav.server/api/traveler/users - To retrieve the next 10 Traveler users:
https://my.trav.server/api/traveler/users?page=2 - To retrieve the first 40 Traveler users (Page 1, increasing the page size to 40
using the page multiplier parameter):
https://my.trav.server/api/traveler/users?page=1&pm=4 - To retrieve the first 10 Traveler devices:
https://my.trav.server/api/traveler/devices - To retrieve devices 41-80 (page 2 with pm of 4):
https://my.trav.server/api/traveler/devices?page=2&pm=4
The Traveler Web-based administration interface uses the same APIs as described in this topic. These APIs are supported in both on-premises stand-alone and high availability configurations. For the full API documentation, see this article.