...
Executes the specified module and returns result value of module function.
Required Scope
module_execute
Parameters
| Parameter Name | Description |
|---|
| apiKey | Caller system identifier. |
| logonId | User logon id |
| logonProvider | User logon provider. |
| process | Name or id number of process |
| module | Name of module to be call. |
| function | Name of function to be call. |
| arguments | Array of function parameters. |
Example Call
| Request | Response |
|---|
| No Format |
|---|
POST http://mydomain.emakin.com/rest/trigger
{
"apiKey": "xxxx",
"logonId": "user@emakin.com",
"logonProvider": "Organization",
"process" : "MyProcess",
"module": "MyModule",
"function": "myFunction",
"arguments": ["myParameter","myOtherParameter"]
} |
| | No Format |
|---|
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"property1": 1,
"property2": "value"
}
|
|
Trigger
Triggers an event for listeners on all processes and returns array of id number of triggered work items. When there is no listener return value is a empty array.
Required Scope
event_trigger
Parameters
| Parameter Name | Description |
|---|
| apiKey | Caller system identifier. |
| logonId | User logon id |
| logonProvider | User logon provider. |
| eventName | Name of event |
| testMode | Trigger the test mode or not work items |
| inputData | Event Data in XML can be null. |
| culture | Culture preference. Can be null. |
Example Call
| Request | Response |
|---|
| No Format |
|---|
POST http://mydomain.emakin.com/rest/trigger
{
"apiKey": "xxxx",
"logonId": "user@emakin.com",
"logonProvider": "Organization",
"eventName" : "myEvent",
"inputData": "<pool><eventParameter>ABC</eventParameter></pool>",
"testMode": false,
"culture": null
} |
| | No Format |
|---|
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"d": ["716F8FCB-98C2-4591-8C43-043D54DEAADA"]
}
|
|
...
Returns the decision result.
Required Scope
decision_execute
Parameters
| Parameter Name | Description |
|---|
| apiKey | Caller system identifier. |
| logonId | User logon id |
| logonProvider | User logon provider. |
| process | Name or Id number of the process |
| model | Name or Id number of the decision model |
| decision | Name or Id number of the decision |
| inputData | Decision input data. Xml or Json string. |
Example Call
| Request | Response |
|---|
| No Format |
|---|
POST https://mydomain.emakin.com/rest/decision
{
"apiKey": "",
"logonId": "user@emakin.com",
"logonProvider": "Organization",
"process" : "Decision",
"model" : "dinner",
"decision" : "Dish",
"inputData": "<pool><Season>Fall</Season><NumberOfGuests>2</NumberOfGuests></pool>"
} |
| | No Format |
|---|
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 26
{"d":{"Dish":"Spareribs"}}
|
|
...