Initializing help system before first use

Starting an Execution

To invoke a new execution, you send a REST request specifying the input data and additional options.
To submit the request, use the following endpoint: 
POST /rest/runtime/execution

This request accepts an optional request body specifying the input data and any parameters for the Mosel model or the MPS/LP problem. Input data is supplied as a file called input. This file can contain either Mosel model input data or an MPS/LP problem.

Depending on how you have configured the web service, you can submit the input data using either JSON format or as an iframe AJAX request using a form.

  • To submit the input using JSON, pass a JSON object with the following properties:
    inputText
    inputBase64
    The input data file. Use either (but not both) of these properties: inputText for text-based MPS/LP problem formats, or inputBase64 for non-text formats like LP.GZ and MPS.GZ.

    The maximum allowed size of the input file is 250 MB.

    parameters
    A JSON object specifying the names and values of Mosel model or MPS/LP parameters, as in this example: 
    {"DEBUG": "True", "MAX_EMPLOYEES": "15"}
  • To submit an iframe AJAX request using a form, use the following form parameters:
    input
    The contents of the input file.
    param-<parameter-name>
    Text fields specifying the parameters.
    Note: This method is more efficient than JSON when the input file is of significant size. It can also be useful when passing an input file from the local file system.
If the request is successful, the response is a JSON status object; otherwise it is an HTTP error code explaining the error. The status object includes the following properties:
id
The requested model or problem execution.
statusPath
The full path to the status object. You can use this path in a subsequent request to poll the current status.
If the request was submitted as JSON data, the response is returned directly. If it was submitted via a form, an HTTP 200 OK status code is issued, and the response data is wrapped in a JSON object with these properties:
status
The underlying status code for the request.
entity
Either the JSON status object or the error message, as appropriate. (The entity property might not be valid JSON.)
Covered Topics
Parent Topic Using Web Service Endpoints

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