Optimize APIs¶
Introduction¶
Optimize API is a REST API and provides searching, getting, and changing Optimize data. Requests and responses are in JSON notation.
API documentation as Swagger¶
A detailed API description is also available as Swagger UI. Refer here to get the reference of Swagger UI.
Host URL for Optima Gateway environments will be as given below:
| Environment | {host-url} |
|---|---|
| Dev | optima-dev.optumrx.com |
| Stage | optima-stage.optumrx.com |
| Prod | optima-prod.optumrx.com |
Endpoints¶
Enable Sharing¶
POST - https://{host-url}/gateway/optimize/enable-sharing
TBD
Disable Sharing¶
POST - https://{host-url}/gateway/optimize/disable-sharing
TBD
Get all Dashboard IDs¶
POST - https://{host-url}/gateway/optimize/dashboards/{collectionId}
TBD
Export Dashboard Definition¶
POST - https://{host-url}/gateway/optimize/export-dashboard-definition
TBD
Get all Report IDs¶
POST - https://{host-url}/gateway/optimize/reports/{collectionId}
TBD
Delete a Report¶
DELETE - https://{host-url}/gateway/optimize/report/{reportId}
TBD
Export Report Definition¶
POST - https://{host-url}/gateway/optimize/export-report-definition
TBD
Export Report Result Data¶
GET - https://{host-url}/gateway/optimize/export-report-result-data/{reportId}
TBD