Objective Device API 2.0.0 documentation

Objective Device API 2.0.0

application/json

This documents describes the async api for device communication through mqtt.

Servers

tcp://brokerIp:1883mqtt 3.1.1mqtt

Operations

SUB objt/device/${tenant}/${site}/${device}/command
The topic on which can be subscribed to receive device commands for a certain device

Subscribe to Device Command

Operation IDdeviceCommand
tenant
required
string
uid: tenant
Tenant

site
required
string
uid: site
Site

device
required
string
uid: device
Device name
Accepts the following message:
Device CommanddeviceCommandMessage
Correlation ID$message.payload#/headers/correlationData
object
uid: deviceCommandPayload
object
Map structure of parameters expected for command

object
Additional properties are allowed.
device
required
string
Device name

command
required
string
Command to be executed on device

dts
required
string
format: date-time
Datetime when event was published

object
uid: messageHeader
correlationData
string
Identifier for correlation

responseTopic
string
Topic on which response must be sent

messageExpiryInterval
integer
Expiry of message in seconds

Additional properties are allowed.
Additional properties are allowed.
object
uid: deviceCommandResponse
The response which must be posted on the responseTopic

result
string
Result indicating if the processing of the device command was successful

Allowed values:
"OK"
"ERROR"
"WARNING"
message
string
Will contain a detailed errorMessage in case of error.

object
A return object of the device command processing

Additional properties are allowed.
object
uid: responseMessageHeader
correlationData
string
Same correlation id as sent in the originating message header

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "parameters": { "property1": {}, "property2": {} }, "device": "string", "command": "string", "dts": "2019-08-24T14:15:22Z", "headers": { "correlationData": "string", "responseTopic": "string", "messageExpiryInterval": 0 } }

This example has been generated automatically.
PUB objt/device/${tenant}/${site}/${device}/event
The topic on which device events can be published for a certain device

Publish Device Event

Operation IDdeviceEvent
tenant
required
string
uid: tenant
Tenant

site
required
string
uid: site
Site

device
required
string
uid: device
Device name
Accepts the following message:
Device EventdeviceEventMessage
object
uid: deviceEventPayload
Payload for the device event.

device
required
string
Device name

event
required
string
Name of the event

object
Object with corresponding value for chosen event

Additional properties are allowed.
dts
string
format: date-time
Datetime when event was published

object
uid: messageHeader
correlationData
string
Identifier for correlation

responseTopic
string
Topic on which response must be sent

messageExpiryInterval
integer
Expiry of message in seconds

Additional properties are allowed.
Additional properties are allowed.
object
uid: deviceEventResponse
The result of the processing of the device event which will be posted on the responseTopic if both responseTopic and correlationData are provided through the headers. Omit these headers if no result is required.

result
string
Result indicating if the processing of the device event was successful

Allowed values:
"OK"
"ERROR"
message
string
Will contain a detailed errorMessage in case of error.

object
The return object of the device event processing

Additional properties are allowed.
object
uid: responseMessageHeader
correlationData
string
Same correlation id as sent in the originating message header

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "device": "string", "event": "string", "data": {}, "dts": "2019-08-24T14:15:22Z", "headers": { "correlationData": "string", "responseTopic": "string", "messageExpiryInterval": 0 } }

This example has been generated automatically.

Messages

#1Device EventdeviceEventMessage
object
uid: deviceEventPayload
Payload for the device event.

device
required
string
Device name

event
required
string
Name of the event

object
Object with corresponding value for chosen event

Additional properties are allowed.
dts
string
format: date-time
Datetime when event was published

object
uid: messageHeader
correlationData
string
Identifier for correlation

responseTopic
string
Topic on which response must be sent

messageExpiryInterval
integer
Expiry of message in seconds

Additional properties are allowed.
Additional properties are allowed.
object
uid: deviceEventResponse
The result of the processing of the device event which will be posted on the responseTopic if both responseTopic and correlationData are provided through the headers. Omit these headers if no result is required.

result
string
Result indicating if the processing of the device event was successful

Allowed values:
"OK"
"ERROR"
message
string
Will contain a detailed errorMessage in case of error.

object
The return object of the device event processing

Additional properties are allowed.
object
uid: responseMessageHeader
correlationData
string
Same correlation id as sent in the originating message header

Additional properties are allowed.
Additional properties are allowed.
#2Device CommanddeviceCommandMessage
Correlation ID$message.payload#/headers/correlationData
object
uid: deviceCommandPayload
object
Map structure of parameters expected for command

object
Additional properties are allowed.
device
required
string
Device name

command
required
string
Command to be executed on device

dts
required
string
format: date-time
Datetime when event was published

object
uid: messageHeader
correlationData
string
Identifier for correlation

responseTopic
string
Topic on which response must be sent

messageExpiryInterval
integer
Expiry of message in seconds

Additional properties are allowed.
Additional properties are allowed.
object
uid: deviceCommandResponse
The response which must be posted on the responseTopic

result
string
Result indicating if the processing of the device command was successful

Allowed values:
"OK"
"ERROR"
"WARNING"
message
string
Will contain a detailed errorMessage in case of error.

object
A return object of the device command processing

Additional properties are allowed.
object
uid: responseMessageHeader
correlationData
string
Same correlation id as sent in the originating message header

Additional properties are allowed.
Additional properties are allowed.

Schemas

object
uid: deviceEventPayload
Payload for the device event.

device
required
string
Device name

event
required
string
Name of the event

object
Object with corresponding value for chosen event

Additional properties are allowed.
dts
string
format: date-time
Datetime when event was published

object
uid: messageHeader
correlationData
string
Identifier for correlation

responseTopic
string
Topic on which response must be sent

messageExpiryInterval
integer
Expiry of message in seconds

Additional properties are allowed.
Additional properties are allowed.
object
uid: deviceCommandPayload
object
Map structure of parameters expected for command

object
Additional properties are allowed.
device
required
string
Device name

command
required
string
Command to be executed on device

dts
required
string
format: date-time
Datetime when event was published

object
uid: messageHeader
correlationData
string
Identifier for correlation

responseTopic
string
Topic on which response must be sent

messageExpiryInterval
integer
Expiry of message in seconds

Additional properties are allowed.
Additional properties are allowed.
object
uid: messageHeader
correlationData
string
Identifier for correlation

responseTopic
string
Topic on which response must be sent

messageExpiryInterval
integer
Expiry of message in seconds

Additional properties are allowed.
object
uid: responseMessageHeader
correlationData
string
Same correlation id as sent in the originating message header

Additional properties are allowed.
object
uid: deviceCommandResponse
The response which must be posted on the responseTopic

result
string
Result indicating if the processing of the device command was successful

Allowed values:
"OK"
"ERROR"
"WARNING"
message
string
Will contain a detailed errorMessage in case of error.

object
A return object of the device command processing

Additional properties are allowed.
object
uid: responseMessageHeader
correlationData
string
Same correlation id as sent in the originating message header

Additional properties are allowed.
Additional properties are allowed.
object
uid: deviceEventResponse
The result of the processing of the device event which will be posted on the responseTopic if both responseTopic and correlationData are provided through the headers. Omit these headers if no result is required.

result
string
Result indicating if the processing of the device event was successful

Allowed values:
"OK"
"ERROR"
message
string
Will contain a detailed errorMessage in case of error.

object
The return object of the device event processing

Additional properties are allowed.
object
uid: responseMessageHeader
correlationData
string
Same correlation id as sent in the originating message header

Additional properties are allowed.
Additional properties are allowed.

Objective Device API 2.0.0

Servers

Operations

SUB objt/device/${tenant}/${site}/${device}/command

Examples

This example has been generated automatically.

PUB objt/device/${tenant}/${site}/${device}/event

Examples

This example has been generated automatically.

Messages

Schemas