OMS uses APIs to pull data from the IHQ database and load the information into the application. The OMS APIs can be run in Postman to access the desired JSON data. There are many options in Postman so the following outlines what a user needs to do in order to get results when calling an OMS API.
| Note |
|---|
For more information on using Postman refer to their website: Postman Support. |
Overview
URL
Users should refer to the articles below for each OMS API as the parameters will vary for each one. It is important to format the URL correctly to ensure the request can be returned. The following articles will offer additional information regarding each API URL and the available parameters. All of these APIs are "GET" calls and return JSON data. All endpoints require an authorization header included in the request.
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Authorization
API calls will be validated via the LDAP permissions before any data is returned. Therefore, a valid user must be used when making the call. The password for the user will be the Lotus Notes Internet password.
- Select the "Authorization" tab
- Set the type to "Basic Auth"
- Enter your email and password
| Info | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
Common error responses:
|
Related articles
| Filter by label (Content by label) | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Page Properties | ||
|---|---|---|
| ||
| Related issues |