Skip to content

ExecuteModule

Use this endpoint when a script module function should be executed from an external caller rather than from a process or form directly.

Executes the specified module and returns the result of the module function.

Required Scope

module_execute

Parameters

Parameter Name Description
apiKey A unique key used to authenticate and authorise the calling system.
logonId User’s logon Id.
logonProvider The authentication provider used for user login (e.g., 'Organization' for Emakin's default login system).
process The name or Id of the process to initiate.
module The name of the module to call.
function The name of the function to call within the module.
arguments An array of parameters to pass to the function.

Example Call

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
POST https://mydomain.emakin.com/rest/v1/executeModule

{
     "apiKey": "xxxx",
     "logonId": "[email protected]",
     "logonProvider": "Organization",
     "process" : "MyProcess",
     "module": "MyModule",
     "function": "myFunction",
     "arguments": ["myParameter","myOtherParameter"]
}

1
2
3
4
5
6
7
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
     "property1": 1,
     "property2": "value"
}