Initializing help system before first use

ModelExecution

Structure containing status information about a model execution.

Properties
name data type description
id string An ID string that uniquely identifies this execution.
status ModelStatus The status of the model execution
exitCode number The exit code, returned by a call to exit() from the model.
Only available for completed executions.
progress number The progress value, which is a measure of how much work an in-progress execution has performed.
This is set to 0 when an execution starts and can be updated from the model by calling send(38371,NEWVALUE). This field can thus be used by the modeller to communicate optimization progress.
creation number The creation time of the model execution.
start number The start time of the model execution.
finish number The finish time of the model execution.
Only available for completed executions.
parameters map of string The parameters used in the execution the model.
runLogPath string The path to the REST endpoint for querying the runlog of this execution
Only available for completed executions.
statusPath string The path to the REST endpoint for querying the status of this execution
inputPath string The path to the REST endpoint for querying the input file of this execution
Only available for executions that specified an input file
resultPath string The path to the REST endpoint for querying the result file of this execution
Only available for completed executions that produced a result file
isExecuting boolean
executionNode string
retryInSafeDebugMode boolean Flag indicating whether the execution's initial run failed unexpectedly, and as a result was queued to be rerun with solver 'safe' and 'debug' modes activated.

Example

{
  "id" : "...",
  "status" : "IOERR",
  "exitCode" : 12345,
  "progress" : 12345.0,
  "creation" : 12345,
  "start" : 12345,
  "finish" : 12345,
  "parameters" : {
    "property1" : "...",
    "property2" : "..."
  },
  "runLogPath" : "...",
  "statusPath" : "...",
  "inputPath" : "...",
  "resultPath" : "...",
  "isExecuting" : true,
  "executionNode" : "...",
  "retryInSafeDebugMode" : true
}

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