POST api/calculation/triggerCalculationOnline

Triggers a calculation to run synchronously

Request Information

URI Parameters

None.

Body Parameters

Contains both a calcId and parameters (can be an empty JSON array)

Name	Description	Type	Additional information
calcId	The calculationId to be triggered (found in Administration > Calculations > Calculations)	string	None.
parameters	A JSON array of parameters in the format of paramName, paramValue (this is optional but you must pass an empty array at minimum)	string	None.

Request Formats

application/json, text/json

Sample:

{
  "calcId": "sample string 1",
  "parameters": "sample string 2"
}

application/xml, text/xml

Sample:

<CalculationController.triggerCalculationOnlineParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMAPWebAPI.Controllers">
  <calcId>sample string 1</calcId>
  <parameters>sample string 2</parameters>
</CalculationController.triggerCalculationOnlineParams>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'triggerCalculationOnlineParams'.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>