Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The OMS API's can be used in Postman to access necessary 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

This is not a comprehensive guide to Postman, for more information refer to their website: Postman Support.


Section


...

Overview


Section

URL

Users should refer to the reference article for each OMS API as the parameters for each will vary. It is important to format the URL correctly to ensure the request can be returned. The following links will provide offer additional information regarding each API URL and the available parameters.


Panel

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "api-info" and space = "OSD" and type = "page"


Authorization

Postman calls will need to be checked via the LDAP permissions before any data is returned. So a valid user must be used before making the call. The password will be the Lotus Notes Internet password for the user.

  • Select the "Authorization" tab
  • Set the type to "Basic Auth"
  • Enter your email and password


Section



Info

Common error responses:


200 OK

Results were found that match the request and are included in the response body

401 UnauthorizedThe current account in the request header does not have access to the API

403 Forbidden

The current account in the request header does not have access to the territory requested in the request URL

404 Not Found

Returned if NO results were found that match the specified criteria

500 Internal Server ErrorOne or more request string parameters are invalid or an error was encountered by the server while processing the request


...