Get Started with the Batch Assess REST API

The Batch Assess REST API provides a simple API for processing batches of structured data through a deployed Intelligent Advisor policy model. Batch processing is useful where bulk re-assessments need to happen on a regular basis (for example, daily or monthly). Thousands of cases can be assessed in a single API call. The Batch Assess REST API works equally well for individual REST calls. Decision reports can be retrieved from the batch service to provide an understanding of why decisions were made for each case. For more information, see Using the Batch Assess REST API.

The Batch Assess REST API functions as a wrapper around the existing assess service. The Batch Assess REST API reads request data and writes response data using JSON (instead of the XML used by the assess service). The service will read the request and write the response as simultaneous data streams, so that processing can begin while the potentially large request data is still being uploaded.

Tip: For an example of the Batch Assess REST API using the Retail Discounts policy model, see Example: Batch Assess Request and Response.

The current version of the Batch Assess REST API is 12.2.7.

To use the Batch Assess REST API you need to:

  1. Contact your Oracle sales representative to enable the Batch Assess REST API.
  2. Install a REST tool, such as cURL or OpenAPI. This will be used to send requests to the Batch Assess REST API.
  3. In Policy Modeling, specify names on all attributes, entities and relationships that will be used as inputs and outputs.
  4. Deploy the Policy Modeling project.
  5. In Intelligent Advisor Hub:
    1. Turn on Web Services for the deployed policy model.
    2. Create an API client with the Assessment APIs role.
  6. Use the REST API to Submit a Request to the Batch Assess REST API. Note that size and concurrency limits apply as described in that topic.
  7. Receive a Response From the Batch Assess REST API. This returns the structured input data with identified output attributes populated, and includes a summary of the batch process.

Tip: You can use the Policy Modeling Debugger to export a debug session in the JSON format used by the Batch Assess REST API. If the Batch Assess REST API returns unexpected results, you can import Batch Assess REST API request payloads into the Policy Modeling Debugger to find the root cause of issues that are occurring.

Related Topics