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.20/
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.20/policy-models/{policy-model-name}/assessor
Get assessor details
Method: get
Path: https://{your_site_interface}/determinations-server/batch/12.2.20/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.20/policy-models/{policy-model-name}
Get details about all deployed policy models
Method: get
Path: https://{your_site_interface}/determinations-server/batch/12.2.20/policy-models
Get example request and response assessor payloads
Method: get
Path: https://{your_site_interface}/determinations-server/batch/12.2.20/policy-models/{policy-model-name}/assessor/example
Get the assessor data model
Method: get
Path: https://{your_site_interface}/determinations-server/batch/12.2.20/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.23/
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.23/about
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.23/audit-entries
Get an audit entry
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/audit-entries/{audit-entry-auditId}
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.23/corsallowlist
Create or replace a CORS allowlist
Method: put
Path: https://{your_site_interface}/opa-hub/api/12.2.23/corsallowlist
Get a CORS allowlist
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/corsallowlist
Update a CORS allowlist
Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.23/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.23/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.23/clientCertificates
Create or replace client certificates
Method: put
Path: https://{your_site_interface}/opa-hub/api/12.2.23/clientCertificates
Delete a client certificate
Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.23/clientCertificates/{client-certificate-name}
Get a client certificate
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/clientCertificates/{client-certificate-name}
Get all client certificates
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/clientCertificates
Update a client certificate
Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.23/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.23/connections
Create or replace connections
Method: put
Path: https://{your_site_interface}/opa-hub/api/12.2.23/connections
Delete a connection
Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.23/connections/{connection-serviceName}
Get a connection
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/connections/{connection-serviceName}
Get all connections
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/connections
Test the connection status
Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.23/connections/{connection-serviceName}/status
Update a connection
Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.23/connections/{connection-serviceName}
Hub Administration/Deployments
Manage Intelligent Advisor Hub deployments, including upload, download, activation, and status.

See the Deployments section of the Project Administrator's Guide for more information about deployments.

Create deployments
Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments
Delete a deployment
Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}
Delete a deployment version
Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}/activeVersion
Get a deployment
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}
Get a snapshot
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}/activeVersion/snapshot
Get active deployment version
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}/activeVersion
Get all deployments
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments
Get available locales
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}/activeVersion/locales
Get object mappings
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}/activeVersion/mappings
Get URL parameters
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}/activeVersion/urlParameters
Update a deployment
Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}
Update a deployment version
Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.23/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.23/deployments/{deployment-name}/debugLogs/{deployment-debug-log-uid}
Delete deployment debug logs
Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}/debugLogs
Get a deployment debug log
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/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.23/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.23/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.23/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.23/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.23/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.23/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.23/deployments/{deployment-name}/versions
Delete a deployment version
Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}/versions/{deployment-version-versionNo}
Get a deployment version
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}/versions/{deployment-version-versionNo}
Get a snapshot
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}/versions/{deployment-version-versionNo}/snapshot
Get all deployment versions
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}/versions
Get available locales
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}/versions/{deployment-version-versionNo}/locales
Get object mappings
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}/versions/{deployment-version-versionNo}/mappings
Get URL parameters
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/deployments/{deployment-name}/versions/{deployment-version-versionNo}/urlParameters
Update a deployment version
Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.23/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.23/jwk
Get a verify
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/jwk/verify
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.23/message-log-entries/{message-log-entry-logEntryId}
Get all message log entries
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/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.23/operations
Get an operation
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/operations/{operation-name}
Replace an operation
Method: put
Path: https://{your_site_interface}/opa-hub/api/12.2.23/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.23/operations/{operation-name}/interfaces
Get an interface
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/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.23/projects
Delete a project
Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.23/projects/{project-name}
Get a project
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/projects/{project-name}
Get all projects
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/projects
Update a project
Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.23/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.23/projects/{project-name}/versions
Delete a project version
Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.23/projects/{project-name}/versions/{project-version-version}
Get a project version
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/projects/{project-name}/versions/{project-version-version}
Get all project versions
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/projects/{project-name}/versions
Update a project version
Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.23/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.23/sslcertificates
Create SSL certificates
Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.23/sslcertificates
Delete a SSL certificate
Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.23/sslcertificates/{SSL-certificate-name}
Get a SSL certificate
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/sslcertificates/{SSL-certificate-name}
Get all SSL certificates
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/sslcertificates
Update a SSL certificate
Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.23/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.23/statistics
Retrieve statistics
Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.23/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.23/users
Create users
Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.23/users
Delete a user
Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.23/users/{user-name}
Get a user
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/users/{user-name}
Get all users
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/users
Update users
Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.23/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.23/workspaces
Create workspaces
Method: post
Path: https://{your_site_interface}/opa-hub/api/12.2.23/workspaces
Delete a workspace
Method: delete
Path: https://{your_site_interface}/opa-hub/api/12.2.23/workspaces/{workspace-name}
Get a workspace
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/workspaces/{workspace-name}
Get all workspaces
Method: get
Path: https://{your_site_interface}/opa-hub/api/12.2.23/workspaces
Update a workspace
Method: patch
Path: https://{your_site_interface}/opa-hub/api/12.2.23/workspaces/{workspace-name}