Initializing help system before first use

Accessing the Xpress Insight Server Using the REST API

Xpress Insight supports a web services API for integrating with the operations provided by the Insight server.
It is based on REST principles and is therefore organised into resource-oriented URLs, using standard HTTP verbs. The available operations are detailed in the REST API documentation.
  • Online documentation includes the API documentation, see the Xpress Insight REST API documentation.
  • The running installation of Xpress Insight serves live Swagger API documentation on: 
    <INSIGHTURL>/swagger-ui/
The examples shown here include:
  • Create a scenario
  • Clone a scenario
  • Execute a scenario with the LOAD execution mode
  • Read an entity value
  • Delete the scenario

Developer Prerequisites

Developers should have experience in developing against REST Web Services with a suitable client-side language.

Versioning

The API is versioned using a major.minor versioning scheme. For example, a release of the API might have the version "2.0".
  • When non-breaking changes are introduced, a new minor version of the API will become available, for example "2.1".
  • When breaking changes are introduced, a new major version of the API will become available, for example "3.0".

Clients communicating with the REST API should be lenient to minor changes, so that they can continue to work with the latest minor version of the API without change. For example, the addition of a new field to an object is considered a minor change which the client can and should ignore.

Covered Topics
  • Requests
    Requests can be made to your Xpress Insight endpoint via HTTP to elicit a response with a payload normally in JSON format (There are some exceptions, such as when dealing with file contents).
  • Responses
    The Xpress Insight API provides responses using the HTTP protocol.
  • Authenticating via the REST API
    Each file submission sent to the Compute Server must have valid Bearer Token that is generated using the Client ID and Client secret values.
  • Examples
    The following examples show how to use the REST API.
Parent Topic Insight 5 Developers Guide for Mosel

© 2001-2022 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.