POST CustomCalculations/{id}?appid={appid}&sg={sg}&hash={hash}&token={token}&message_post_body={message_post_body}¶meters={parameters}&run_id={run_id}
post a end user form and a parameter list to activate a custom calculation
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
Required |
|
| appid | string |
Required |
|
| sg | string |
Required |
|
| hash | string |
Required |
|
| token | string |
Required |
|
| message_post_body | string |
Required |
|
| parameters | string |
Default value is |
|
| run_id | string |
None. |
Body Parameters
EndUserMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| for_type | string |
None. |
|
| for_id | string |
None. |
|
| source_type | string |
None. |
|
| source_id | string |
None. |
|
| message_type_id | string |
None. |
|
| appid | string |
None. |
|
| end_user_id | string |
None. |
|
| field_list | Collection of DataUnit |
None. |
|
| received_date | date |
None. |
|
| processed | boolean |
None. |
|
| guid | string |
None. |
|
| guid_datetime | date |
None. |
Request Formats
application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CalculationDataPointSet| Name | Description | Type | Additional information |
|---|---|---|---|
| data_items | Collection of Collection of string |
None. |
|
| success | boolean |
None. |
|
| message | string |
None. |
|
| return_data_meaining | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"data_items": [
[
"sample string 1",
"sample string 2"
],
[
"sample string 1",
"sample string 2"
]
],
"success": true,
"message": "sample string 2",
"return_data_meaining": "sample string 3"
}
application/xml, text/xml
Sample:
<CalculationDataPointSet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/productious_reports">
<data_items xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:ArrayOfstring>
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</d2p1:ArrayOfstring>
<d2p1:ArrayOfstring>
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</d2p1:ArrayOfstring>
</data_items>
<message>sample string 2</message>
<return_data_meaining>sample string 3</return_data_meaining>
<success>true</success>
</CalculationDataPointSet>