Waiting for Execution to Complete
The result is a JSON object containing the following values:
| id | The id of the execution. |
| status | Text representing the response from the executing runtime. Valid values include OK and NOT_COMPLETED. |
| exitCode | The value returned by the model or problem's exit statement, or 0 if there was no explicit exit. |
| statusPath | The path from which the current status can be refreshed. |
| inputPath, resultPath, runLogPath | Paths to the relevant files for the current execution. |
| modelParameters | A record of how parameters were set prior to execution—this takes the form of a JSON object mapping names to text values. |
| progress | A floating point number that is initially 0 but can be updated by the model as it executes. |
Of the above, only start, id and statusPath are always present. Other properties may be present, depending on the state of the execution.
The four path properties—statusPath, inputPath, resultPath and runLogPath—are used in GET requests to retrieve the relevant data if it exists. If the data is not present, a 404 Not Found response is returned.
When an execution has not finished, the status field is set to NOT_COMPLETED. In this case, query the statusPath again after a short delay, repeating until it returns something other than NOT_COMPLETED.
The execution result will not be available while the status is NOT_COMPLETED, but you will be able to fetch the run log of an in-progress execution. The model can also set the value of the progress field of the execution status by sending an event of class 38371, for example send(38371, 50.0) ! Set progress to 50
Progress values are intended to be read by your application, and Xpress Executor does not define any meaning for specific values. If your model does not send events of class 38371, the execution progress will always be 0.
Be aware that in some cases Xpress Executor may choose to restart an execution, in which case you may see the progress value decrease and the run log restart from the beginning.
© 2001-2019 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.