REST API for Intelligent Advisor 24A

All REST Endpoints

Batch REST API Assessments

This version of the Batch API allows processing of batches of structured data through an Intelligent Advisor policy model

Top-level entry point: Method: get
Path: https://{your_site_interface}/determinations-server/batch/12.2.26/

Batch REST API Assessments/Deployed Policy Models

Batch assessment of Intelligent Advisor policy models

Assess one or more cases of data: Method: post
Path: https://{your_site_interface}/determinations-server/batch/12.2.26/policy-models/{policy-model-name}/assessor
Get assessor details: Method: get
Path: https://{your_site_interface}/determinations-server/batch/12.2.26/policy-models/{policy-model-name}/assessor
Get details about a single deployed policy model: Method: get
Path: https://{your_site_interface}/determinations-server/batch/12.2.26/policy-models/{policy-model-name}
Get details about all deployed policy models: Method: get
Path: https://{your_site_interface}/determinations-server/batch/12.2.26/policy-models
Get example request and response assessor payloads: Method: get
Path: https://{your_site_interface}/determinations-server/batch/12.2.26/policy-models/{policy-model-name}/assessor/example
Get the assessor data model: Method: get
Path: https://{your_site_interface}/determinations-server/batch/12.2.26/policy-models/{policy-model-name}/data-model

Decision Service Assessments/Deployed projects

Available decision service operations for a deployment.

Assess a single case: Method: post
Path: https://{your_site_interface}/determinations-server/v2/{deployment-name}
Assess multiple cases: Method: post
Path: https://{your_site_interface}/determinations-server/v2/{deployment-name}/batch
Get the OpenAPI 2.0 specification for a deployed project: Method: get
Path: https://{your_site_interface}/determinations-server/v2/{deployment-name}/swagger.json

Decision Service Assessments/Project versions in development

Available decision service operations for a project version.

Assess a single case: Method: post
Path: https://{your_site_interface}/determinations-server/project/v2/{project-name}/{project-version}
Assess multiple cases: Method: post
Path: https://{your_site_interface}/determinations-server/project/v2/{project-name}/{project-version}/batch
Get the OpenAPI 2.0 specification for a project version: Method: get
Path: https://{your_site_interface}/determinations-server/project/v2/{project-name}/{project-version}/swagger.json

Hub Administration

This version of the API allows management of Intelligent Advisor Hub users, deployments, version, and connection information.

Top-level entry point: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/

Hub Administration/About Release

Basic Hub version information. Use this to determine the currently installed version of the Hub.

Get an about: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/about

Hub Administration/All Projects Inclusions Report

Lists all projects included by other projects

Get an all projects inclusions report: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/projects-inclusions

Hub Administration/Audit Entries

Get entries from the Intelligent Advisor Hub audit log.

Get all audit entries: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/audit-entries
Get an audit entry: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/audit-entries/{audit-entry-auditId}

Hub Administration/Authorization Providers

Manage authorization providers in the Intelligent Advisor Hub to secure interviews within different workspaces.

Create authorization providers: Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.34/authorization-providers
Delete an authorization provider: Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.34/authorization-providers/{authorization-provider-id}
Get all authorization providers: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/authorization-providers
Get an authorization provider: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/authorization-providers/{authorization-provider-id}
Update an authorization provider: Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.34/authorization-providers/{authorization-provider-id}

Hub Administration/CORS Allowlist

Manage Cross-Origin Resource Sharing (CORS) allowlists for Intelligent Advisor Hub, Intelligent Advisor web interviews, and Intelligent Advisor Determinations API.

See the Developer Guide of the Intelligent Advisor Documentation Library for more information.

Create a CORS allowlist: Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.34/corsallowlist
Create or replace a CORS allowlist: Method: put
Path: https://{your_site_interface}/opa-hub/api/12.2.34/corsallowlist
Get a CORS allowlist: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/corsallowlist
Update a CORS allowlist: Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.34/corsallowlist

Hub Administration/Checkpoint Inspect

A checkpoint inspection data model

Inspect a checkpoint: Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.34/checkpointInspect

Hub Administration/Client Certificates

Manage SSL client-side certificates for connections in the Intelligent Advisor Hub.

See the client certificates page of the Connections section of the Project Administrator Guide for more information about SSL Client Certificates.

Create client certificates: Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.34/clientCertificates
Create or replace client certificates: Method: put
Path: https://{your_site_interface}/opa-hub/api/12.2.34/clientCertificates
Delete a client certificate: Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.34/clientCertificates/{client-certificate-name}
Get a client certificate: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/clientCertificates/{client-certificate-name}
Get all client certificates: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/clientCertificates
Update a client certificate: Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.34/clientCertificates/{client-certificate-name}

Hub Administration/Connections

Manage Intelligent Advisor Hub connections. This includes adding, deleting, testing, and authentication management.

See the Connections section of the Project Administrator Guide for information about Intelligent Advisor Hub connections.

Create connections: Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.34/connections
Create or replace connections: Method: put
Path: https://{your_site_interface}/opa-hub/api/12.2.34/connections
Delete a connection: Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.34/connections/{connection-serviceName}
Get a connection: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/connections/{connection-serviceName}
Get all connections: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/connections
Test the connection status: Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.34/connections/{connection-serviceName}/status
Update a connection: Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.34/connections/{connection-serviceName}

Hub Administration/Deployments

Manage Intelligent Advisor Hub deployments, including upload, download, activation, and status.

See the Manage deployments section of the Intelligent Advisor Documentation Library for more information about deployments.

Create a referencesTo: Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/referencesTo
Create deployments: Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments
Delete a deployment: Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}
Delete active deployment version: Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/activeVersion
Get a deployment: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}
Get a projectDefinition: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/activeVersion/projectDefinition
Get a snapshot: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/activeVersion/snapshot
Get active deployment version: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/activeVersion
Get all deployments: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments
Get available locales: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/activeVersion/locales
Get object mappings: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/activeVersion/mappings
Get URL parameters: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/activeVersion/urlParameters
Update a deployment: Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}
Update active deployment version: Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/activeVersion

Hub Administration/Deployments/Deployment Debug Logs

A collection of debug logs for a deployment.

Delete a deployment debug log: Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/debugLogs/{deployment-debug-log-uid}
Delete deployment debug logs: Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/debugLogs
Get a deployment debug log: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/debugLogs/{deployment-debug-log-uid}
Get a deployment debug log content: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/debugLogs/{deployment-debug-log-uid}/content
Get all deployment debug logs: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/debugLogs

Hub Administration/Deployments/Deployment Debug Logs/Deployment Debug Events

A collection of debug events for a debug log of a deployment.

Get a debug event: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/debugLogs/{deployment-debug-log-uid}/events/{debug-event-id}
Get a debug event content: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/debugLogs/{deployment-debug-log-uid}/events/{debug-event-id}/content
Get all deployment debug events: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/debugLogs/{deployment-debug-log-uid}/events

Hub Administration/Deployments/Deployment Logs

Get the deployment logs for a policy model deployment. A log entry contains information about when a policy model was activated or deactivated, who performed the operation, and the date and time that it occurred.

Get all deployment logs: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/logs

Hub Administration/Deployments/Deployment Versions

Version information for a versioned deployment in the Intelligent Advisor Hub. A deployment consists of one or more policy model versions.

Create deployment versions: Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/versions
Delete a deployment version: Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/versions/{deployment-version-versionNo}
Get a deployment version: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/versions/{deployment-version-versionNo}
Get a projectDefinition: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/versions/{deployment-version-versionNo}/projectDefinition
Get a snapshot: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/versions/{deployment-version-versionNo}/snapshot
Get all deployment versions: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/versions
Get available locales: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/versions/{deployment-version-versionNo}/locales
Get object mappings: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/versions/{deployment-version-versionNo}/mappings
Get URL parameters: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/versions/{deployment-version-versionNo}/urlParameters
Update a deployment version: Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/versions/{deployment-version-versionNo}

Hub Administration/Jwk

Hub public jwk

Get a jwk: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/jwk
Get a verify: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/jwk/verify

Hub Administration/Jwksets

Manage JWK sets used for various Intelligent Advisor services and purposes.

Create a jwkset generate active key: Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.34/jwksets/{jwkset-purpose}/generate-active-key
Get a jwkset: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/jwksets/{jwkset-purpose}
Get all jwksets: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/jwksets
Update a jwkset: Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.34/jwksets/{jwkset-purpose}

Hub Administration/Jwksets/Jwkset Keys

Manage keys in a particular JWK set.

Delete a jwkset key: Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.34/jwksets/{jwkset-purpose}/keys/{jwkset-key-kid}
Get a jwkset key: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/jwksets/{jwkset-purpose}/keys/{jwkset-key-kid}
Get all jwkset keys: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/jwksets/{jwkset-purpose}/keys

Hub Administration/Message Log Entries

Get entries from the Intelligent Advisor Hub customer message log.

Get a message log entry: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/message-log-entries/{message-log-entry-logEntryId}
Get all message log entries: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/message-log-entries

Hub Administration/Operations

Manage interview operations published by policy models within Intelligent Advisor Hub.

Get all operations: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/operations
Get an operation: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/operations/{operation-name}
Replace an operation: Method: put
Path: https://{your_site_interface}/opa-hub/api/12.2.34/operations/{operation-name}

Hub Administration/Operations/Interfaces

The data interfaces for an operation

Get all interfaces: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/operations/{operation-name}/interfaces
Get an interface: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/operations/{operation-name}/interfaces/{interface-name}

Hub Administration/Projects

Projects management

Create projects: Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.34/projects
Delete a project: Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.34/projects/{project-name}
Get a project: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/projects/{project-name}
Get a project inclusions report: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/projects/{project-name}/inclusions-report
Get all projects: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/projects
Update a project: Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.34/projects/{project-name}

Hub Administration/Projects/Project Versions

Project versions management

Create project versions: Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.34/projects/{project-name}/versions
Delete a project version: Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.34/projects/{project-name}/versions/{project-version-version}
Get a project version: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/projects/{project-name}/versions/{project-version-version}
Get a project version inclusions report: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/projects/{project-name}/versions/{project-version-version}/inclusions-report
Get all project versions: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/projects/{project-name}/versions
Update a project version: Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.34/projects/{project-name}/versions/{project-version-version}

Hub Administration/SSL Certificates

Manage SSL custom root certificates for connections in the Intelligent Advisor Hub.

See the custom root certificate page of the Connections section of the Project Administrator Guide for more information about Custom Root Certificates.

Create or replace SSL certificates: Method: put
Path: https://{your_site_interface}/opa-hub/api/12.2.34/sslcertificates
Create SSL certificates: Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.34/sslcertificates
Delete a SSL certificate: Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.34/sslcertificates/{SSL-certificate-name}
Get a SSL certificate: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/sslcertificates/{SSL-certificate-name}
Get all SSL certificates: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/sslcertificates
Update a SSL certificate: Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.34/sslcertificates/{SSL-certificate-name}

Hub Administration/Statistics

Manage Intelligent Advisor Hub statistics.

Empty statistics: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/statistics
Retrieve statistics: Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.34/statistics

Hub Administration/Users

Intelligent Advisor Hub user management

Create or replace users: Method: put
Path: https://{your_site_interface}/opa-hub/api/12.2.34/users
Create users: Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.34/users
Delete a user: Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.34/users/{user-name}
Get a user: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/users/{user-name}
Get all users: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/users
Update users: Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.34/users

Hub Administration/Workspaces

Manage Intelligent Advisor Hub workspaces

Create or replace workspaces: Method: put
Path: https://{your_site_interface}/opa-hub/api/12.2.34/workspaces
Create workspaces: Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.34/workspaces
Delete a workspace: Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.34/workspaces/{workspace-name}
Get a workspace: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/workspaces/{workspace-name}
Get all workspaces: Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.34/workspaces
Update a workspace: Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.34/workspaces/{workspace-name}