Batching v2

PUB Execute batched operations

from/module/{module_id}/action/batch/execute

Use this endpoint to execute a series of operations batched together.

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 (ex: uuid)	No
target	<string>	Path of the target device, if a module itself is not a target	No
timestamp	<string>		No
ack	<string>		No

Payload information:

Key	Value	Mandatory	Remarks
id	<integer>	No	Identifier of this action for dependencies
dependsOn	Array<integer>	No	Identifiers of other actions that this action depends on
action	<string>	Yes	Resource.action for this request, unless specified in the elevated property
body	<object>	No	Action specific body

Here is a payload example:

[
  {
    "action": "model.create",
    "model": "abb.ability.device",
    "body": {
      "model": "abb.ability.device",
      "objectId": "{object_id}",
      "type": "abb.ability.device.{type}@1",
      "name": "E2E sample1",
      "properties": {
        "serialNumber": {
          "value": "Test123"
        }
      }
    }
  },
  {
    "action": "model.update",
    "model": "abb.ability.device",
    "objectId": "{object_id}",
    "body": {
      "model": "abb.ability.device",
      "objectId": "{object_id}",
      "name": "UAT sample2",
      "version": 1,
      "type": "abb.ability.device.{type}@1",
      "properties": {
        "serialNumber": {
          "value": "Test123"
        }
      }
    }
  }
]

SUB Ack for batched operation

to/module/{module_id}/ack/batch/execute

Use this endpoint to check whether the batched operation was executed successfully.

Parameters:

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