OMS Ad Hoc Report API
- Jason Reel (Deactivated)
This API will return the results of a custom ad hoc report created in OMS.
Note the data is flattened and only the requested columns are returned. Because the data is flattened, there may be duplicate rows for some people, but that can easily be handled during processing once the data is returned. Going this route allows users to dictate which fields are returned by the API.
URL
https://base.url.org/api/oms/adhoc-query/query-results/{{ ID }}
Parameters
Parameter Name | Required | Description | Default |
|---|---|---|---|
ID | required | the numeric ID of the saved ad hoc report query |
Responses
200 OK | Results were found that match the request and are included in the response body |
401 Unauthorized | The 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 Error | One or more request string parameters are invalid or an error was encountered by the server while processing the request |