Method Invocation

With this API, you can receive method invocation targeting an object model that your module owns, and publish results of method invocations.

SUB Receive and respond to method invocation

to/module/{module_id}/action/method/invoke

Parameters

Name	Type	Description	Accepted values
module_id	string	Module identifier	Name of module

Message format

Properties:

Key	Value	Notes	Mandatory
correlationId	<string>	Unique String (e.g. uuid)	No
target	<string>		No
context	<string>		No
objectId	<string>	Format: uuid	Yes
model	<string>		Yes
method	<string>		Yes

Payload information:

The payload should contain a well-formed JSON body.

Payload example:

{
        "input": {
          "target": "blmodule1"
        }
}

PUB Publish a result of a method invocation

from/module/{module_id}/ack/method/invoke

Parameters:

Name	Type	Description	Accepted values
module_id	string	Module identifier	Name of module

Payload information:

Key	Value	Mandatory
error	<string>	No
output	<object>	No

Here is an example of a payload:

{
  "error": "string",
  "output": {}
}