POST api/Calculation/triggerAction

Triggers a CMAP action (such as a Script, SQL, Item Update or Saved Report) offline and returns the resulting data

Request Information

URI Parameters

None.

Body Parameters

triggerActionParams
NameDescriptionTypeAdditional information
actionId

The calculation id obtained from Administration > Calculations > Calculations

string

None.

priority

A numeric value where a higher number is treated as a priority for scheduling

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "actionId": "sample string 1",
  "priority": 2
}

application/xml, text/xml

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

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 'triggerActionParams'.

Response Information

Resource Description

A JSON string confirming the scheduling of the action (e.g. {result:"OK"})

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>