Initializing help system before first use

Accessing the Xpress Insight Server Using the REST API

The Xpress Insight REST API provides a web services interface to the Xpress Insight server.
Xpress Insight supports a Representation State Transfer (REST) API to access and interact with the Xpress Insight resources using a fixed set of operations. The Xpress Insight REST API exposes concepts with which end users are familiar; specifically, apps, scenarios and their data, as well as the schema of the model and the execution queue.
Note Detailed documentation on the Xpress Insight REST API can be found at http://www.fico.com/fico-xpress-optimization/docs/latest/insight/rest_api/index.html.

This documentation covers details regarding available resources, operations and the data model.

Some of these concepts are described in the following sections.

Covered Topics
  • Authentication
    The supported authentication method is Token-based authentication.
  • Mime Types
    The REST API accepts and produces JSON content using the mime type application/json.
  • Identifiers
    All REST resources are identified by a Globally Unique Identifier (GUID).
  • Locking
    All REST operations are atomic.
  • Pagination
    All operations that return lists of results are paginated to ensure the scalability and performance of the REST API.
  • REST API Example
    This example demonstrates the Xpress Insight REST API using Node.js as a client—you can adapt it to your own needs.
Parent Topic Insight 4 Developers Guide for Mosel