Initializing help system before first use

Compute Interface REST API

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

This API supports a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations.

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.html

Developer Prerequisites

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

Covered Topics
  • Authenticating with 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