Initializing help system before first use

Compute Interface REST API

The Compute Interface REST API provides an interface to the Xpress Insight Compute Server to allow properly formatted jobs of a permitted file type to be submitted programmatically.

The Compute REST API supports a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations. It is based on REST principles and is therefore organised into resource-oriented URLs, using standard HTTP verbs. With some exceptions, such as when dealing with file contents, responses are in JSON format. Check the details on individual endpoints.

Reference Documentation

Full documentation of the resources offered by this feature are available locally as well as online at the FICO Xpress documentation site.

  • Online documentation includes the API documentation, see the Xpress Insight REST API documentation.
  • The running installation of Insight 5 serves live Swagger API documentation on: 
    <INSIGHTURL>/swagger-ui/

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.
  • Submitting a Job
    The REST API supports submitting Solver and Mosel type jobs.
  • Querying the Job Execution Status
    You can send a request to return the details of a submitted job.
  • Obtaining the Job Results
    The run log for a running or completed job, or the job results for a completed job, can be obtained.
  • Deleting a Compute Job
    Completed jobs can be removed from the job queue. If the job has not completed, it will be cancelled and then deleted.
  • Purging Obsolete Scenarios
    By default, Insight 5 retains all completed compute jobs in the repository. Eventually, this will consume significant amounts of space and impact performance. Insight 5 can be configured to regularly purge completed jobs.
Parent Topic Insight 5 Compute Interface Guide

© 2001-2025 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.