Calculation Run (Master and Analytic Models)
  • 1 Minute to read
  • Dark
    Light
  • PDF

Calculation Run (Master and Analytic Models)

  • Dark
    Light
  • PDF

Article summary

Use this API to run a Calculation defined on a Master or Analytic model. Only one Calculation can be invoked per API invocation. Only those Calculations that are enabled to run in the background can be invoked with this API. Invoking any other type will result in an error.

You can also optionally pass variables and values for variables into the calculation.

POST /modeling/model/calcscript/run HTTP/1.1
Content-Type: application/xml
Accept: application/xml
X-ACCESS-TOKEN:
 
<?xml version="1.0" encoding="UTF-8"?>
<run-calcscript-payload>
<model-name>$ModelName</model-name>
<calcscript-name>$CalcScriptName</calcscript-name>
<runtime-values>
<entry>
<key> @calcvariablename@ </key>
<value> VariableValue </value>
</entry>
<entry>
<key> @calcvariablename@ </key>
<value> VariableValue </value>
</entry>
</runtime-values>
</run-calcscript-payload>

Was this article helpful?