Extensions v2

PUB Create an extension

from/module/{module_id}/action/extension/create

Use this endpoint to create an object extension.

Parameters:

Name	Type	Description	Accepted values
module_id	string	Module identifier	Any

Message format

Properties:

Key	Value	Notes	Mandatory
correlationId	<string>	Unique String (e.g. uuid)	No
ack	<string>		No
target	<string>		No
context	<string>		No
timestamp	<string>	Date time in ISO-8601 format	No
objectId	<string>	Format: uuid	Yes
model	<string>		Yes

These properties can be included in the request by adding them to the topic you are sending the messages to. To find out more, click here.

Here is an example of the properties used:

from/module/{module_id}/action/extension/create&objectId={objectId}&model={modelId}&ack=all

Payload:

A well-formed JSON compliant to the request payload format of the PUT /objects/{objectId}/models/{model}/extension operation.

Here is an example payload:

{
      "properties": {
      "{property_name}": {
        "dataType": "{data_type}"
      }
    }  
}

SUB Ack for extension creation

to/module/{module_id}/ack/extension/create

Use this endpoint to check whether the object extension was created successfully.

Parameters:

Name	Type	Description	Accepted values
module_id	string	Module identifier	Any

PUB Get an extension

from/module/{module_id}/action/extension/get

Use this endpoint to retrieve an object extension.

Parameters:

Name	Type	Description	Accepted values
module_id	string	Module identifier	Any

Message format

Properties:

Key	Value	Notes	Mandatory
correlationId	<string>	Unique String (e.g. uuid)	No
ack	<string>		No
target	<string>		No
context	<string>		No
timestamp	<string>	Date time in ISO-8601 format	No
objectId	<string>	Format: uuid	Yes
model	<string>		Yes

These properties can be included in the request by adding them to the topic you are sending the messages to. See the Message Properties section to find out more.

Here is an example of the properties used:

from/module/{module_id}/action/extension/get&objectId={objectId}&model={modelId}&ack=all

Payload information:

{ }

SUB Ack for getting extension

to/module/{module_id}/ack/extension/get

Use this endpoint to check whether the object extension was retrieved successfully.

Parameters:

Name	Type	Description	Accepted values
module_id	string	Module identifier	Any