# References v2

# PUB Create a reference

# from/module/{module_id}/action/reference/create

Use this endpoint to create or update a reference between existing object models.

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/reference/create&objectId={objectId}&model={modelId}&ack=all

Payload information:

Key	Value	Mandatory
name	`<string>`	Yes
to	`<object>`	Yes
to:objectId	`<string>`	Yes
to:model	`<string>`	Yes
from	`<object>`	No
from:objectId	`<string>`	No
from:model	`<string>`	No
attributes	`<string>`	No

Here is a sample payload:

[{
  "name": "children",
  "to": {
    "objectId": "bb495bb9-047a-4fe1-9881-0e3aa3668787",
    "model": "abb.ability.device"
  },
  "attributes": {},
  "from": {
    "objectId": "bb495bb9-047a-4fe1-9881-0e3aa3668787",
    "model": "abb.ability.device"
  }
}]

# SUB Ack for reference creation

# to/module/{module_id}/ack/reference/create

Use this endpoint to check whether the reference was created successfully.

Parameters:

Name	Type	Description	Accepted values
module_id	string	Module identifier	Any

# PUB Delete a reference

# from/module/{module_id}/action/reference/delete

Use this endpoint to delete an existing reference.

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/reference/delete&objectId={objectId}&model={modelId}&ack=all

Payload information:

Key	Value	Mandatory
name	`<string>`	Yes
to	`<object>`	Yes
to:objectId	`<string>`	Yes
to:model	`<string>`	Yes

Here is an example payload:

{
  "name": "children",
  "to": {
    "objectId": "bb495bb9-047a-4fe1-9881-0e3aa3668787",
    "model": "abb.ability.device"
  }
}

# SUB Ack for reference deletion

# to/module/{module_id}/ack/reference/delete

Use this endpoint to check whether the reference was deleted successfully.

Parameters:

Name	Type	Description	Accepted values
module_id	string	Module identifier	Any

← Batching Identity →