Calculation Status (Master and Analytic Models)

1 Minute to read

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Use this API to determine the current status, the last status of the running of a calculation, the last run time, as well as run in background and description details.

This API returns the following status:

For current status: the response is "submitted", "in progress" or "not running"
For last status: the response is "success" or "failed"

Please note that the request payload is the same as the run calculation payload.

POST modeling/model/calcscript/status HTTP/1.1
Content-Type: application/xml
Accept: application/xml
X-ACCESS-TOKEN:

Request body:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<run-calcscript-payload>
<model-name>BOA_Model</model-name>
<calcscript-name>BOA_Model</calcscript-name>
</run-calcscript-payload>

Response body:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<calcscript-status>
<model-name>BOA_Model</model-name>
<calcscript-name>BOA_Model</calcscript-name>
<status>not running</status>
<last-status>success</last-status>
<description></description>
<run-in-background>Yes</run-in-background>
<last-run-time>2019-05-15T10:37:56.036Z</last-run-time>
</calcscript-status>

Was this article helpful?

What's Next

Clear Data (Master and Analytic Models)