Accessing the Intelligent Advisor REST API

To access the Intelligent Advisor REST API, you use standard HTTP operations on uniform resource identifiers (URIs).

Launch URI

To access the Intelligent Advisor Hub REST API, use the following launch URI:

https://{your_site_interface}/opa-hub/api

To access the Intelligent Advisor Batch Assess REST API, use the following launch URI:

https://{your_site_interface}/determinations-server/batch

OpenAPI 2.0 specifications

An OpenAPI 2.0 description is available using the GET operation. This returns the resources and methods provided by the REST API in a single JSON payload.

The URI for the Intelligent Advisor Hub REST API is:

https://{your_site_interface}/opa-hub/api/{version}/swagger.json

The URI for the Intelligent Advisor Batch Assess REST API is:

https://{your_site_interface}/determinations-server/batch/{version}/swagger.json

The URI for the Intelligent Advisor Decision Service REST API for a deployment is:

https://{your_site_interface}/determinations-server/v2/{deployment-name}/swagger.json

The URI for the Intelligent Advisor Decision Service REST API for a project version is:

https://{your_site_interface}/determinations-server/project/v2/{project-name}/{project-version}/swagger.json

URI syntax

Requests in the Intelligent Advisor Hub REST API use the following syntax:

https://{your_site_interface}/opa-hub/api/{version}/{resource}

Requests in the Intelligent Advisor Batch Assess REST API use the following syntax:

https://{your_site_interface}/determinations-server/batch/{version}/{resource}

Requests in the Intelligent Advisor Decision Service REST API use the following syntax for deployments:

https://{your_site_interface}/determinations-server/v2/{resource}

Requests in the Intelligent Advisor Decision Service REST API use the following syntax for project versions:

https://{your_site_interface}/determinations-server/project/v2/{resource}/{project_version}

For example:

https://mysite.example.com/opa-hub/api/12.2.35/projects/Master_OPM_Project/inclusions-report

https://mysite.example.com/determinations-server/batch/12.2.26/policy-models/mybenefits

https://mysite.example.com/determinations-server/project/v2/DeliveriesRUs/1