DRIVR MQTT API 1.0.0

Operations

Messages

DRIVR MQTT API 1.0.0

The API projects the current state of all DRIVR domains in a DRIVR cluster onto MQTT.

Servers

mqtt://mqtt.drivr.cloud:{port}/drivr/v1/ secure-mqtt 3.1.1

DRIVR MQTT Broker

port:
ENUM: 8883 DEFAULT: 8883

Operations

Sub /{slug}

Returns information about the domain.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"

Accepts the following message:

DomainInformation

General information about a Domain in DRIVR. Information is retained until the Domain is deleted.

Payload
object
uuid
string
uuid

The uuid of the domain

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
slug
string

The slug of the domain definition

Examples: "adam" "eve"
name
string

Human readable name of the domain

Examples: "Adam's DRIVR domain" "Eve's DRIVR domain"
status
string

The current status of the domain

Enum: "ACTIVATED" "DEACTIVATED" "ARCHIVED"
Examples: "ACTIVATED" "DEACTIVATED" "ARCHIVED"
hostNames
array<string>

Items:

0
string
url

The host names this domain API is accessible from.

Examples: "https://api.adam.drivr.cloud" "https://api.eve.drivr.cloud"

Additional items are allowed.

ownerUuid
string
uuid

The uuid of the User, Organization, or OrganizationUnit which owns the domain.

Examples: "52319891-c130-43bd-93ff-bad42f464c84" "d837b268-0855-49ab-b6b2-1070ac7c838e"
domainFeatures
array<object>

A list of all features which can parametrize the behavior within a domain and a feature toggle if it is activated or not.

slug
string
Enum: "DELETE_ARCHIVE_ORGANIZATION_USERS" "SYNC_ACCOUNT_ID_AND_EMAIL" "UNIQUE_ACCOUNT_ALIAS" "USER_MUST_HAVE_EMAIL" "USER_MUST_HAVE_PASSWORD"
enabled
boolean
Examples: true false

Additional items are allowed.

createdAt
string
date-time
Examples: "2021-08-06T13:13:06.136333+00:00"
updatedAt
string
date-time
Examples: "2021-08-06T14:39:44.368252+00:00"

Additional properties are NOT allowed.

Examples

DomainInformation
Payload 
{
  "uuid": "24ee14a3-f1c8-49aa-95fc-ad0432e23b99",
  "slug": "adam",
  "name": "Adam's DRIVR domain",
  "status": "ACTIVATED",
  "hostNames": [
    "https://api.adam.drivr.cloud"
  ],
  "ownerUuid": "52319891-c130-43bd-93ff-bad42f464c84",
  "domainFeatures": [
    {
      "slug": "DELETE_ARCHIVE_ORGANIZATION_USERS",
      "enabled": true
    }
  ],
  "createdAt": "2021-08-06T13:13:06.136333+00:00",
  "updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
This example has been generated automatically.

Sub /{slug}/state

Returns the current status of a domain.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"

Accepts the following message:

DomainMqttState

The current state of the Domain. If the state is set to DELETED the Domain MQTT topics and all information within will be deleted.

Payload mqttState
string

The state of the object as presented within MQTT.

Enum: "CREATED" "ACTIVATED" "DEACTIVATED" "ARCHIVED" "DELETED"
Examples: "CREATED" "ACTIVATED" "DEACTIVATED" "ARCHIVED" "DELETED"

Examples

DomainMqttState
Payload
Example #1
"CREATED"
Example #2
"ACTIVATED"
Example #3
"DEACTIVATED"
Example #4
"ARCHIVED"
Example #5
"DELETED"

Sub /{slug}/organizations/{organizationUuid}

Returns information about the Organization in the DRIVR Domain.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
organizationUuid organizationUuid
required
string
uuid

The unique UUID of the Organization within DRIVR.

Examples: "d837b268-0855-49ab-b6b2-1070ac7c838e"

Accepts the following message:

OrganizationInformation

The current information which is stored for the Organization within DRIVR. Information is retained until the Organization is deleted.

Payload
object
uuid
string
uuid

The UUID of the Organization.

Examples: "d837b268-0855-49ab-b6b2-1070ac7c838e"
name
string

The human readable name of the Organization.

Examples: "Acme Ltd" "Onkyon GmbH" "Kvitrix Ltd"
alias
string

An additional unique field which can describe a Domain unique number for the Organization, likely some customer number or similar.

Examples: "6898400c-651d-4b36-8cd5-d1d8a152f68a" "my-organization.internal-reference.de" "263810232" "5233 3286 7648 2725"
domainUuid
string
uuid

The UUID of the Domain the Organization belongs to.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
ownerUuid
string,null
uuid

The UUID of the owner of the Organization or null if no owner is registered in the Organization. The owner if set is always pointing to a User.

Examples: "8718ca2a-5134-41bb-ab81-b65cec310ab9"
metadata
object,null
status
string

The current status of the Organization.

Enum: "ACTIVATED" "DEACTIVATED" "ARCHIVED"
Examples: "ACTIVATED" "DEACTIVATED" "ARCHIVED"
createdAt
string
date-time
Examples: "2021-08-06T13:13:06.136333+00:00"
updatedAt
string
date-time
Examples: "2021-08-06T14:39:44.368252+00:00"

Additional properties are NOT allowed.

Examples

OrganizationInformation
Payload 
{
  "uuid": "d837b268-0855-49ab-b6b2-1070ac7c838e",
  "name": "Acme Ltd",
  "alias": "6898400c-651d-4b36-8cd5-d1d8a152f68a",
  "domainUuid": "24ee14a3-f1c8-49aa-95fc-ad0432e23b99",
  "ownerUuid": "8718ca2a-5134-41bb-ab81-b65cec310ab9",
  "metadata": null,
  "status": "ACTIVATED",
  "createdAt": "2021-08-06T13:13:06.136333+00:00",
  "updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
This example has been generated automatically.

Sub /{slug}/organizations/{organizationUuid}/state

Provides the current state of the Organization.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
organizationUuid organizationUuid
required
string
uuid

The unique UUID of the Organization within DRIVR.

Examples: "d837b268-0855-49ab-b6b2-1070ac7c838e"

Accepts the following message:

OrganizationMqttState

The current state of the Organization. If the state is set to DELETED the Organization MQTT topics and all information within will be deleted.

Payload mqttState
string

The state of the object as presented within MQTT.

Enum: "CREATED" "ACTIVATED" "DEACTIVATED" "ARCHIVED" "DELETED"
Examples: "CREATED" "ACTIVATED" "DEACTIVATED" "ARCHIVED" "DELETED"

Examples

OrganizationMqttState
Payload
Example #1
"CREATED"
Example #2
"ACTIVATED"
Example #3
"DEACTIVATED"
Example #4
"ARCHIVED"
Example #5
"DELETED"

Sub /{slug}/authorization/roleAssignments/{roleAssignmentUuid}

Returns the global assignments which are valid for the complete Domain.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
roleAssignmentUuid roleAssignmentUuid
required
string
uuid

The unique UUID of the RoleAssignment within DRIVR.

Examples: "90525c81-88f7-4fd9-8e10-54ee353cad7d"

Accepts the following message:

DomainRoleAssignment

A RoleAssignment which belongs to the Domain. Information is retained until the RoleAssignment is deleted.

Payload RoleAssignment
object

An assignment which is published for a specific Role in DRIVR.

uuid
string
uuid

The uuid uniquely identified the RoleAssignment.

Examples: "1c97e5d3-299e-4e57-83ae-473b43894f9e"
assignee
object

Returns information about the assignee which the RoleAssignment is valid for.

uuid
string
uuid

The uuid of the User, Organization, or OrganizationUnit which the role is assigned for.

Examples: "8718ca2a-5134-41bb-ab81-b65cec310ab9" "d837b268-0855-49ab-b6b2-1070ac7c838e"
type
string

The type the UUID references.

Enum: "USER" "ORGANIZATION" "ORGANIZATION_UNIT"
Examples: "USER" "ORGANIZATION" "ORGANIZATION_UNIT"

Additional properties are allowed.

role
object

Information about the Role attached to the Assignment.

uuid
string
uuid

The UUID of the Role configuration.

Examples: "958a8603-6d24-4e95-bcb4-e27a654f92f0"
name
string

A human readable name of the role.

Examples: "Administrator" "root" "specialist"

Additional properties are allowed.

status objectStatus
string

The status of a published object.

Enum: "ACTIVATED" "DEACTIVATED" "ARCHIVED"
Examples: "ACTIVATED" "DEACTIVATED" "ARCHIVED"
createdAt
string
date-time
Examples: "2021-08-06T13:13:06.136333+00:00"
updatedAt
string
date-time
Examples: "2021-08-06T14:39:44.368252+00:00"

Additional properties are NOT allowed.

Examples

DomainRoleAssignment
Payload 
{
  "uuid": "1c97e5d3-299e-4e57-83ae-473b43894f9e",
  "assignee": {
    "uuid": "8718ca2a-5134-41bb-ab81-b65cec310ab9",
    "type": "USER"
  },
  "role": {
    "uuid": "958a8603-6d24-4e95-bcb4-e27a654f92f0",
    "name": "Administrator"
  },
  "status": "ACTIVATED",
  "createdAt": "2021-08-06T13:13:06.136333+00:00",
  "updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
This example has been generated automatically.

Sub /{slug}/authorization/roleAssignments/{roleAssignmentUuid}/state

The current state global assignments which are valid for the complete Domain.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
roleAssignmentUuid roleAssignmentUuid
required
string
uuid

The unique UUID of the RoleAssignment within DRIVR.

Examples: "90525c81-88f7-4fd9-8e10-54ee353cad7d"

Accepts the following message:

DomainRoleAssignmentMqttState

The current state of the RoleAssignment. If the state is set to DELETED the RoleAssignment MQTT topics and all information within will be deleted.

Payload mqttState
string

The state of the object as presented within MQTT.

Enum: "CREATED" "ACTIVATED" "DEACTIVATED" "ARCHIVED" "DELETED"
Examples: "CREATED" "ACTIVATED" "DEACTIVATED" "ARCHIVED" "DELETED"

Examples

DomainRoleAssignmentMqttState
Payload
Example #1
"CREATED"
Example #2
"ACTIVATED"
Example #3
"DEACTIVATED"
Example #4
"ARCHIVED"
Example #5
"DELETED"

Sub /{slug}/authorization/systems/{systemUuid}/roleAssignments/{roleAssignmentUuid}

Returns information about the RoleAssignment which is assigned to the provided system.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
roleAssignmentUuid roleAssignmentUuid
required
string
uuid

The unique UUID of the RoleAssignment within DRIVR.

Examples: "90525c81-88f7-4fd9-8e10-54ee353cad7d"

Accepts the following message:

SystemRoleAssignment

A RoleAssignment which assigns roles to the System. Information is retained until the RoleAssignment is deleted.

Payload RoleAssignment
object

An assignment which is published for a specific Role in DRIVR.

uuid
string
uuid

The uuid uniquely identified the RoleAssignment.

Examples: "1c97e5d3-299e-4e57-83ae-473b43894f9e"
assignee
object

Returns information about the assignee which the RoleAssignment is valid for.

uuid
string
uuid

The uuid of the User, Organization, or OrganizationUnit which the role is assigned for.

Examples: "8718ca2a-5134-41bb-ab81-b65cec310ab9" "d837b268-0855-49ab-b6b2-1070ac7c838e"
type
string

The type the UUID references.

Enum: "USER" "ORGANIZATION" "ORGANIZATION_UNIT"
Examples: "USER" "ORGANIZATION" "ORGANIZATION_UNIT"

Additional properties are allowed.

role
object

Information about the Role attached to the Assignment.

uuid
string
uuid

The UUID of the Role configuration.

Examples: "958a8603-6d24-4e95-bcb4-e27a654f92f0"
name
string

A human readable name of the role.

Examples: "Administrator" "root" "specialist"

Additional properties are allowed.

status objectStatus
string

The status of a published object.

Enum: "ACTIVATED" "DEACTIVATED" "ARCHIVED"
Examples: "ACTIVATED" "DEACTIVATED" "ARCHIVED"
createdAt
string
date-time
Examples: "2021-08-06T13:13:06.136333+00:00"
updatedAt
string
date-time
Examples: "2021-08-06T14:39:44.368252+00:00"

Additional properties are NOT allowed.

Examples

SystemRoleAssignment
Payload 
{
  "uuid": "1c97e5d3-299e-4e57-83ae-473b43894f9e",
  "assignee": {
    "uuid": "8718ca2a-5134-41bb-ab81-b65cec310ab9",
    "type": "USER"
  },
  "role": {
    "uuid": "958a8603-6d24-4e95-bcb4-e27a654f92f0",
    "name": "Administrator"
  },
  "status": "ACTIVATED",
  "createdAt": "2021-08-06T13:13:06.136333+00:00",
  "updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
This example has been generated automatically.

Sub /{slug}/authorization/systems/{systemUuid}/roleAssignments/{roleAssignmentUuid}/state

Provides the current state of the referenced RoleAssignment which is assigned to the provided system.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
roleAssignmentUuid roleAssignmentUuid
required
string
uuid

The unique UUID of the RoleAssignment within DRIVR.

Examples: "90525c81-88f7-4fd9-8e10-54ee353cad7d"

Accepts the following message:

SystemRoleAssignmentMqttState

The current state of the RoleAssignment. If the state is set to DELETED the RoleAssignment MQTT topics and all information within will be deleted.

Payload mqttState
string

The state of the object as presented within MQTT.

Enum: "CREATED" "ACTIVATED" "DEACTIVATED" "ARCHIVED" "DELETED"
Examples: "CREATED" "ACTIVATED" "DEACTIVATED" "ARCHIVED" "DELETED"

Examples

SystemRoleAssignmentMqttState
Payload
Example #1
"CREATED"
Example #2
"ACTIVATED"
Example #3
"DEACTIVATED"
Example #4
"ARCHIVED"
Example #5
"DELETED"

Sub /{slug}/authorization/roles/{roleUuid}

Returns information about the configured Role with the provided Role UUID.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
roleUuid roleUuid
required
string
uuid

The unique UUID of the Role within DRIVR.

Examples: "fec617d0-8dc8-4a16-afa0-ed8aae860ee3"

Accepts the following message:

RoleInformation

Information describing one Role within DRIVR. Information is retained until the Role is deleted.

Payload
object
uuid
string
uuid

The uuid of the Role.

Examples: "958a8603-6d24-4e95-bcb4-e27a654f92f0"
name
string

The name of the Role.

Examples: "Administrator" "root" "specialist"
entityType
string

The type of entity the Role is valid for.

Examples: "DOMAIN" "SYSTEM"
createdAt
string
date-time
Examples: "2021-08-06T13:13:06.136333+00:00"
updatedAt
string
date-time
Examples: "2021-08-06T14:39:44.368252+00:00"

Additional properties are NOT allowed.

Examples

RoleInformation
Payload 
{
  "uuid": "958a8603-6d24-4e95-bcb4-e27a654f92f0",
  "name": "Administrator",
  "entityType": "DOMAIN",
  "createdAt": "2021-08-06T13:13:06.136333+00:00",
  "updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
This example has been generated automatically.

Sub /{slug}/authorization/roles/{roleUuid}/state

Provides the current state of the Role.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
roleUuid roleUuid
required
string
uuid

The unique UUID of the Role within DRIVR.

Examples: "fec617d0-8dc8-4a16-afa0-ed8aae860ee3"

Accepts the following message:

RoleInformationMqttState

The current state of the Role. If the state is set to DELETED the Role MQTT topics and all information within will be deleted.

Payload mqttState
string

The state of the object as presented within MQTT.

Enum: "CREATED" "ACTIVATED" "DEACTIVATED" "ARCHIVED" "DELETED"
Examples: "CREATED" "ACTIVATED" "DEACTIVATED" "ARCHIVED" "DELETED"

Examples

RoleInformationMqttState
Payload
Example #1
"CREATED"
Example #2
"ACTIVATED"
Example #3
"DEACTIVATED"
Example #4
"ARCHIVED"
Example #5
"DELETED"

Sub /{slug}/systems/{systemUuid}

Returns information about the System with the provided UUID.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"

Accepts the following message:

SystemInformation

Information about a System within a DRIVR Domain. Information is retained until the System is deleted.

Payload
object
uuid
string
uuid

The uuid of the System.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
code
string,null

The same code as published within the system topic.

Examples: "my-awesome-machine-device-conglomarate.example.com" "this-is-an-awesome-thing-i-built-here" "anything-goes"
name
string

Human readable name of the System.

Examples: "World domination device" "Secret moon base" "Mars explotation utility" "Death star"
description
string

A human readable description for the entity.

Examples: "This system will make me rich." "This system will make others poor." "This system makes excellent kebab."
connectionState systemConnectionState
string

Indicates the current connectivity of a System.

CONNECTED means that the System has at least one ACTIVATED and CONNECTED Component but no ACTIVATED and DISCONNECTED Component.

DISCONNECTED means that the System has no ACTIVATED and CONNECTED Component but at least one ACTIVATED and DISCONNECTED Component.

PARTIALLY_CONNECTED means that the System has at least one ACTIVATED and CONNECTED Component and at least one ACTIVATED and DISCONNECTED Component.

UNDEFINED means that the Components of the System are either all DEACTIVATED or ARCHIVED. The Components do report a connection state of UNDEFINED or NOT_CONNECTIVE. The System status is ARCHIVED or DEACTIVATED.

Examples: "CONNECTED" "DISCONNECTED" "PARTIALLY_CONNECTED" "UNDEFINED"
connectionStateUpdatedAt
string,null
date-time

The last the connection state changed.

Examples: "2021-11-02T17:11:46.833029+00:00"
status
string

The status of a published object.

Enum: "ACTIVATED" "DEACTIVATED" "ARCHIVED"
Examples: "ACTIVATED" "DEACTIVATED" "ARCHIVED"
metadata
object,null
domainUuid
string
uuid

The UUID of the Domain this `System`` is registered in.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
ownerUuid
string,null
uuid

The uuid of the User, Organization, or OrganizationUnit which owns the System.

Examples: "52319891-c130-43bd-93ff-bad42f464c84" "d837b268-0855-49ab-b6b2-1070ac7c838e"
createdAt
string
date-time
Examples: "2021-08-06T13:13:06.136333+00:00"
updatedAt
string
date-time
Examples: "2021-08-06T14:39:44.368252+00:00"

Additional properties are NOT allowed.

Examples

SystemInformation
Payload 
{
  "uuid": "24ee14a3-f1c8-49aa-95fc-ad0432e23b99",
  "code": "my-awesome-machine-device-conglomarate.example.com",
  "name": "World domination device",
  "description": "This system will make me rich.",
  "connectionState": "CONNECTED",
  "connectionStateUpdatedAt": "2021-11-02T17:11:46.833029+00:00",
  "status": "ACTIVATED",
  "metadata": null,
  "domainUuid": "24ee14a3-f1c8-49aa-95fc-ad0432e23b99",
  "ownerUuid": "52319891-c130-43bd-93ff-bad42f464c84",
  "createdAt": "2021-08-06T13:13:06.136333+00:00",
  "updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
This example has been generated automatically.

Sub /{slug}/systems/{systemUuid}/state

Provides the current state of the System.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"

Accepts the following message:

SystemMqttState

The current state of the System. If the state is set to DELETED the System MQTT topics and all information within will be deleted.

Payload mqttState
string

The state of the object as presented within MQTT.

Enum: "CREATED" "ACTIVATED" "DEACTIVATED" "ARCHIVED" "DELETED"
Examples: "CREATED" "ACTIVATED" "DEACTIVATED" "ARCHIVED" "DELETED"

Examples

SystemMqttState
Payload
Example #1
"CREATED"
Example #2
"ACTIVATED"
Example #3
"DEACTIVATED"
Example #4
"ARCHIVED"
Example #5
"DELETED"

Sub /{slug}/systems/{systemUuid}/state/connection

Provides the current connection state of the System.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"

Accepts the following message:

SystemConnectionState

The current connection status of the referenced System. Information is retained until the System is deleted.

Payload systemConnectionState
string

Indicates the current connectivity of a System.

CONNECTED means that the System has at least one ACTIVATED and CONNECTED Component but no ACTIVATED and DISCONNECTED Component.

DISCONNECTED means that the System has no ACTIVATED and CONNECTED Component but at least one ACTIVATED and DISCONNECTED Component.

PARTIALLY_CONNECTED means that the System has at least one ACTIVATED and CONNECTED Component and at least one ACTIVATED and DISCONNECTED Component.

UNDEFINED means that the Components of the System are either all DEACTIVATED or ARCHIVED. The Components do report a connection state of UNDEFINED or NOT_CONNECTIVE. The System status is ARCHIVED or DEACTIVATED.

Examples: "CONNECTED" "DISCONNECTED" "PARTIALLY_CONNECTED" "UNDEFINED"

Examples

SystemConnectionState
Payload
Example #1
"CONNECTED"
Example #2
"DISCONNECTED"
Example #3
"PARTIALLY_CONNECTED"
Example #4
"UNDEFINED"

Sub /{slug}/systems/{systemUuid}/events/{eventUuid}

Lists all Eventss which are assigned directly to the provided System and not to any Components on the System. Retains any currently ACTIVE RANGED events.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
eventUuid eventUuid
required
string
uuid

The unique UUID of the Event within DRIVR.

Examples: "90525c81-88f7-4fd9-8e10-54ee353cad7d"

Accepts the following message:

EventInformation

General information about an Event in DRIVR. Information is retained while Event has an ACTIVE state.

Payload
object
uuid
string
uuid

The uuid of the Event.

Examples: "90525c81-88f7-4fd9-8e10-54ee353cad7d"
time
string
date-time

The time the event happens or happened. This is always set and must not be null.

Examples: "2021-08-06T13:13:06.136333+00:00"
endTime
string
date-time
Examples: "2021-08-07T13:13:06.136333+00:00"
entityUuid
string
uuid

The UUID of the entity the Event is for.

acknowledged
boolean

Describes wether this Event`` has been manually acknowledged by a Useror not. Defaults tofalse`.

Examples: true false
status
string

The current status of the Event. Is always null for SINGLE_POINT events.

Examples: "ACTIVE" "RESOLVED" null
metadata
object,null
eventModel
object

Information about the event model the Event represents. An EventModel describes which kind of possible Events can be emitted in DRIVR.

uuid
string
uuid

The uuid of the EventModel.

Examples: "cb5889ad-71df-4c47-b9dc-27f2e1d796dd"
eventType
string

If the Event is ranged and describes a time range or happened on a single point in time. Depending on this the status field of the Event is set to null for SINGLE_POINT events or includes if the Event is ACTIVE or RESOLVED.

Examples: "RANGED" "SINGLE_POINT"
eventLevel
string

The level of severity for the Event.

Examples: "ERROR" "INFO" "SUCCESS" "WARNING"
code
string

An identifier for the EventModel, usually used for lookups.

Examples: "5343723" "event-1234-from-entity" "death-star-general-error-manual-1" "shield"
message
string

A message which describes the event

Examples: "A rebel ship has penetrated the exhaust port, evacuate immediately." "The shield crack is broken, activate protocol delta v."
entityType
string

The type of entity this EventModel is valid for.

Examples: "COMPONENT" "SYSTEM"

Additional properties are NOT allowed.

createdAt
string
date-time
Examples: "2021-08-06T13:13:06.136333+00:00"
updatedAt
string
date-time
Examples: "2021-08-06T14:39:44.368252+00:00"

Additional properties are NOT allowed.

Examples

EventInformation
Payload 
{
  "uuid": "90525c81-88f7-4fd9-8e10-54ee353cad7d",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "endTime": "2021-08-07T13:13:06.136333+00:00",
  "entityUuid": "98a41658-f66f-460b-bc0a-4e01ab5407e5",
  "acknowledged": true,
  "status": "ACTIVE",
  "metadata": null,
  "eventModel": {
    "uuid": "cb5889ad-71df-4c47-b9dc-27f2e1d796dd",
    "eventType": "RANGED",
    "eventLevel": "ERROR",
    "code": "5343723",
    "message": "A rebel ship has penetrated the exhaust port, evacuate immediately.",
    "entityType": "COMPONENT"
  },
  "createdAt": "2021-08-06T13:13:06.136333+00:00",
  "updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
This example has been generated automatically.

Sub /{slug}/systems/{systemUuid}/events/{eventUuid}/state

Publishes status changes of the Event with the provided UUID. Only emitted for RANGED events. Retained if the status is ACTIVE.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
eventUuid eventUuid
required
string
uuid

The unique UUID of the Event within DRIVR.

Examples: "90525c81-88f7-4fd9-8e10-54ee353cad7d"

Accepts the following message:

EventMqttState

The current state of the Event. Retained if ACTIVE

Payload
string
Examples: "ACTIVE" "RESOLVED"

Examples

EventMqttState
Payload
Example #1
"ACTIVE"
Example #2
"RESOLVED"

Sub /{slug}/systems/{systemUuid}/events/{eventUuid}/ack

Issued when the event is acknowledged. As an event can be acknowledged by multiple people this topic has more information if multiple User acknowledge the event. However, compared to the generic Event topic it is not retained.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
eventUuid eventUuid
required
string
uuid

The unique UUID of the Event within DRIVR.

Examples: "90525c81-88f7-4fd9-8e10-54ee353cad7d"

Accepts the following message:

EventAck

A message describing a User`` to acknowledge an Event. Information is not retained`.

Payload
object
time
string
date-time

When the Event was acknowledged.

Examples: "2021-08-06T14:39:44.368252+00:00"
userUuid
string
uuid

The UUID of the User who acknowledged the Event.

Examples: "8718ca2a-5134-41bb-ab81-b65cec310ab9"

Additional properties are NOT allowed.

Examples

EventAck
Payload 
{
  "time": "2021-08-06T14:39:44.368252+00:00",
  "userUuid": "8718ca2a-5134-41bb-ab81-b65cec310ab9"
}
This example has been generated automatically.

Sub /{slug}/systems/{systemUuid}/components/{componentCode}

Returns information about the Component in the System as it is currently within DRIVR.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
componentCode componentCode
required
string

A uniquely identifiable code of an ACTIVATED Component within a DRIVR System.

Examples: "death-star-laser" "ocean-evaporation-component" "flood-creation-entity"

Accepts the following message:

ComponentInformation

General information about a Component within a DRIVR System.

Payload
object
uuid
string
uuid

The uuid of the Component.

Examples: "993d991e-5ac6-4f1e-be43-be82346f3f88"
code
string

The code of the Component same as the one within the MQTT topic.

Examples: "death-star-laser" "ocean-evaporation-component" "flood-creation-entity"
name
string,null

A human readable optional name of the component.

Examples: "The death star laser" null "Ocean Evaporation Subcomponent" "Flood Creation Device"
metadata
object,null
componentModel
object

Information about the ComponentModel this Component is referenced to.

uuid
string
uuid

The UUID of the ComponentModel which the Component is modelled after.

Examples: "64665d2f-caf9-4976-8c0c-8a4493f5c951"
code
string

The uniquely identifable code of the ComponentModel within ACTIVATED ComponentModel's of the Domain.

Examples: "death-star-laser-plan"
isConnective
boolean

Describes if the ComponentModel has a utility to be connected to other components or to a network at large. If this is set to true the Component is taken into account to check if the System is connected or not.

Additional properties are NOT allowed.

connectionState componentConnectionState
string

Describes the connection state of a Component.

CONNECTED means the Component has an active connection to DRIVR.

DISCONNECTED means the Component has been disconnected from DRIVR.

NOT_CONNECTIVE means the Component does not report the connection state and the Component's ComponentModel's isConnective is set to false.

UNDEFINED means the Component is connective but has never reported a connection state.

Enum: "CONNECTED" "DISCONNECTED" "NOT_CONNECTIVE" "UNDEFINED"
Examples: "CONNECTED" "DISCONNECTED" "NOT_CONNECTIVE" "UNDEFINED"
connectionStateUpdatedAt
string
date-time

The last time the connection state changed.

Examples: "2021-11-02T17:11:46.833029+00:00"
systemUuid
string
uuid

The uuid of the System the Component belongs to.

Examples: "e9423b70-9ded-4c85-8593-111ac872603e"
status objectStatus
string

The status of a published object.

Enum: "ACTIVATED" "DEACTIVATED" "ARCHIVED"
Examples: "ACTIVATED" "DEACTIVATED" "ARCHIVED"
createdAt
string
date-time
Examples: "2021-08-06T13:13:06.136333+00:00"
updatedAt
string
date-time
Examples: "2021-08-06T14:39:44.368252+00:00"

Additional properties are NOT allowed.

Examples

ComponentInformation
Payload 
{
  "uuid": "993d991e-5ac6-4f1e-be43-be82346f3f88",
  "code": "death-star-laser",
  "name": "The death star laser",
  "metadata": null,
  "componentModel": {
    "uuid": "64665d2f-caf9-4976-8c0c-8a4493f5c951",
    "code": "death-star-laser-plan",
    "isConnective": true
  },
  "connectionState": "CONNECTED",
  "connectionStateUpdatedAt": "2021-11-02T17:11:46.833029+00:00",
  "systemUuid": "e9423b70-9ded-4c85-8593-111ac872603e",
  "status": "ACTIVATED",
  "createdAt": "2021-08-06T13:13:06.136333+00:00",
  "updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
This example has been generated automatically.

Sub /{slug}/systems/{systemUuid}/components/{componentCode}/state

Returns the current state of the referenced Component.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
componentCode componentCode
required
string

A uniquely identifiable code of an ACTIVATED Component within a DRIVR System.

Examples: "death-star-laser" "ocean-evaporation-component" "flood-creation-entity"

Accepts the following message:

ComponentMqttState

The current state of the Component. If the state is set to DELETED the Component MQTT topics and all information within will be deleted.

Payload mqttState
string

The state of the object as presented within MQTT.

Enum: "CREATED" "ACTIVATED" "DEACTIVATED" "ARCHIVED" "DELETED"
Examples: "CREATED" "ACTIVATED" "DEACTIVATED" "ARCHIVED" "DELETED"

Examples

ComponentMqttState
Payload
Example #1
"CREATED"
Example #2
"ACTIVATED"
Example #3
"DEACTIVATED"
Example #4
"ARCHIVED"
Example #5
"DELETED"

Sub /{slug}/systems/{systemUuid}/components/{componentCode}/state/connection

Provides the current connection state of the Component.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
componentCode componentCode
required
string

A uniquely identifiable code of an ACTIVATED Component within a DRIVR System.

Examples: "death-star-laser" "ocean-evaporation-component" "flood-creation-entity"

Accepts the following message:

ComponentConnectionState

The current connection status of the referenced Component.

Payload componentConnectionState
string

Describes the connection state of a Component.

CONNECTED means the Component has an active connection to DRIVR.

DISCONNECTED means the Component has been disconnected from DRIVR.

NOT_CONNECTIVE means the Component does not report the connection state and the Component's ComponentModel's isConnective is set to false.

UNDEFINED means the Component is connective but has never reported a connection state.

Enum: "CONNECTED" "DISCONNECTED" "NOT_CONNECTIVE" "UNDEFINED"
Examples: "CONNECTED" "DISCONNECTED" "NOT_CONNECTIVE" "UNDEFINED"

Examples

ComponentConnectionState
Payload
Example #1
"CONNECTED"
Example #2
"DISCONNECTED"
Example #3
"NOT_CONNECTIVE"
Example #4
"UNDEFINED"

Sub /{slug}/systems/{systemUuid}/components/{componentCode}/events/{eventUuid}

Lists all Eventss which are assigned to the referenced Component. Retains any currently ACTIVE RANGED events.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
componentCode componentCode
required
string

A uniquely identifiable code of an ACTIVATED Component within a DRIVR System.

Examples: "death-star-laser" "ocean-evaporation-component" "flood-creation-entity"
eventUuid eventUuid
required
string
uuid

The unique UUID of the Event within DRIVR.

Examples: "90525c81-88f7-4fd9-8e10-54ee353cad7d"

Accepts the following message:

EventInformation

General information about an Event in DRIVR. Information is retained while Event has an ACTIVE state.

Payload
object
uuid
string
uuid

The uuid of the Event.

Examples: "90525c81-88f7-4fd9-8e10-54ee353cad7d"
time
string
date-time

The time the event happens or happened. This is always set and must not be null.

Examples: "2021-08-06T13:13:06.136333+00:00"
endTime
string
date-time
Examples: "2021-08-07T13:13:06.136333+00:00"
entityUuid
string
uuid

The UUID of the entity the Event is for.

acknowledged
boolean

Describes wether this Event`` has been manually acknowledged by a Useror not. Defaults tofalse`.

Examples: true false
status
string

The current status of the Event. Is always null for SINGLE_POINT events.

Examples: "ACTIVE" "RESOLVED" null
metadata
object,null
eventModel
object

Information about the event model the Event represents. An EventModel describes which kind of possible Events can be emitted in DRIVR.

uuid
string
uuid

The uuid of the EventModel.

Examples: "cb5889ad-71df-4c47-b9dc-27f2e1d796dd"
eventType
string

If the Event is ranged and describes a time range or happened on a single point in time. Depending on this the status field of the Event is set to null for SINGLE_POINT events or includes if the Event is ACTIVE or RESOLVED.

Examples: "RANGED" "SINGLE_POINT"
eventLevel
string

The level of severity for the Event.

Examples: "ERROR" "INFO" "SUCCESS" "WARNING"
code
string

An identifier for the EventModel, usually used for lookups.

Examples: "5343723" "event-1234-from-entity" "death-star-general-error-manual-1" "shield"
message
string

A message which describes the event

Examples: "A rebel ship has penetrated the exhaust port, evacuate immediately." "The shield crack is broken, activate protocol delta v."
entityType
string

The type of entity this EventModel is valid for.

Examples: "COMPONENT" "SYSTEM"

Additional properties are NOT allowed.

createdAt
string
date-time
Examples: "2021-08-06T13:13:06.136333+00:00"
updatedAt
string
date-time
Examples: "2021-08-06T14:39:44.368252+00:00"

Additional properties are NOT allowed.

Examples

EventInformation
Payload 
{
  "uuid": "90525c81-88f7-4fd9-8e10-54ee353cad7d",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "endTime": "2021-08-07T13:13:06.136333+00:00",
  "entityUuid": "98a41658-f66f-460b-bc0a-4e01ab5407e5",
  "acknowledged": true,
  "status": "ACTIVE",
  "metadata": null,
  "eventModel": {
    "uuid": "cb5889ad-71df-4c47-b9dc-27f2e1d796dd",
    "eventType": "RANGED",
    "eventLevel": "ERROR",
    "code": "5343723",
    "message": "A rebel ship has penetrated the exhaust port, evacuate immediately.",
    "entityType": "COMPONENT"
  },
  "createdAt": "2021-08-06T13:13:06.136333+00:00",
  "updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
This example has been generated automatically.

Sub /{slug}/systems/{systemUuid}/components/{componentCode}/events/{eventUuid}/state

Publishes status changes of the Event with the provided UUID. Only emitted for RANGED events. Retained if the status is ACTIVE.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
componentCode componentCode
required
string

A uniquely identifiable code of an ACTIVATED Component within a DRIVR System.

Examples: "death-star-laser" "ocean-evaporation-component" "flood-creation-entity"
eventUuid eventUuid
required
string
uuid

The unique UUID of the Event within DRIVR.

Examples: "90525c81-88f7-4fd9-8e10-54ee353cad7d"

Accepts the following message:

EventMqttState

The current state of the Event. Retained if ACTIVE

Payload
string
Examples: "ACTIVE" "RESOLVED"

Examples

EventMqttState
Payload
Example #1
"ACTIVE"
Example #2
"RESOLVED"

Sub /{slug}/systems/{systemUuid}/components/{componentCode}/events/{eventUuid}/ack

Issued when the event is acknowledged. As an event can be acknowledged by multiple people this topic has more information if multiple User acknowledge the event. However, compared to the generic Event topic it is not retained.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
componentCode componentCode
required
string

A uniquely identifiable code of an ACTIVATED Component within a DRIVR System.

Examples: "death-star-laser" "ocean-evaporation-component" "flood-creation-entity"
eventUuid eventUuid
required
string
uuid

The unique UUID of the Event within DRIVR.

Examples: "90525c81-88f7-4fd9-8e10-54ee353cad7d"

Accepts the following message:

EventAck

A message describing a User`` to acknowledge an Event. Information is not retained`.

Payload
object
time
string
date-time

When the Event was acknowledged.

Examples: "2021-08-06T14:39:44.368252+00:00"
userUuid
string
uuid

The UUID of the User who acknowledged the Event.

Examples: "8718ca2a-5134-41bb-ab81-b65cec310ab9"

Additional properties are NOT allowed.

Examples

EventAck
Payload 
{
  "time": "2021-08-06T14:39:44.368252+00:00",
  "userUuid": "8718ca2a-5134-41bb-ab81-b65cec310ab9"
}
This example has been generated automatically.

Sub /{slug}/systems/{systemUuid}/components/{componentCode}/services/{serviceCode}/index/{serviceIndex}/characteristic/{characteristicCode}/dp

Publishes the current value of the referenced Characteristic of the Service of the Component.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
componentCode componentCode
required
string

A uniquely identifiable code of an ACTIVATED Component within a DRIVR System.

Examples: "death-star-laser" "ocean-evaporation-component" "flood-creation-entity"
serviceCode serviceCode
required
string

A uniquely identifiable code of a Service within a DRIVR Domain.

Examples: "death-star-laser" "ocean-evaporation-service" "flood-creation-service"
serviceIndex serviceIndex
required
integer

The index of a Service referenced when adding a Service to a ComponentModel in DRIVR.

Examples: 0 1 2
characteristicCode characteristicCode
required
string

A uniquely identifiable code of a Characteristic within a Service.

Examples: "laser-power" "evaporation-rate" "water-level"

Accepts the following message:

CharacteristicDatapoint

A Datapoint which is published for a specific Characteristic within a Component.

Payload characteristicDatapoint
object

The message structure which DRIVR sends if a Datapoint has been sent from a System.

timeStreamUuid
string
uuid

The unique UUID of the TimeStream within DRIVR. A TimeStream is the combination of a Characteristic, Service and Component.

time
required
string
date-time

The time when the Datapoint was sent from the System.

value
required

The value of a Datapoint or Setpoint which is supposed to be set.

Additional properties are NOT allowed.

Examples

CharacteristicDatapoint
Payload 
{
  "timeStreamUuid": "1e75b89a-810d-4d28-83f8-fffacae4cfad",
  "time": "2019-08-24T14:15:22Z",
  "value": null
}
This example has been generated automatically.

Sub /{slug}/systems/{systemUuid}/components/{componentCode}/services/{serviceCode}/index/{serviceIndex}/characteristic/{characteristicCode}/dp/msgpack

Publishes the current value of the referenced Characteristic of the Service of the Component. Emits payloads encoded as msgpack.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
componentCode componentCode
required
string

A uniquely identifiable code of an ACTIVATED Component within a DRIVR System.

Examples: "death-star-laser" "ocean-evaporation-component" "flood-creation-entity"
serviceCode serviceCode
required
string

A uniquely identifiable code of a Service within a DRIVR Domain.

Examples: "death-star-laser" "ocean-evaporation-service" "flood-creation-service"
serviceIndex serviceIndex
required
integer

The index of a Service referenced when adding a Service to a ComponentModel in DRIVR.

Examples: 0 1 2
characteristicCode characteristicCode
required
string

A uniquely identifiable code of a Characteristic within a Service.

Examples: "laser-power" "evaporation-rate" "water-level"

Accepts the following message:

<anonymous-message-24>

A Datapoint which is published for a specific Characteristic within a Component.

Payload characteristicDatapoint
object

The message structure which DRIVR sends if a Datapoint has been sent from a System.

timeStreamUuid
string
uuid

The unique UUID of the TimeStream within DRIVR. A TimeStream is the combination of a Characteristic, Service and Component.

time
required
string
date-time

The time when the Datapoint was sent from the System.

value
required

The value of a Datapoint or Setpoint which is supposed to be set.

Additional properties are NOT allowed.

Examples

<anonymous-message-24>
Payload 
{
  "timeStreamUuid": "1e75b89a-810d-4d28-83f8-fffacae4cfad",
  "time": "2019-08-24T14:15:22Z",
  "value": null
}
This example has been generated automatically.

Sub /{slug}/systems/{systemUuid}/components/{componentCode}/services/{serviceCode}/index/{serviceIndex}/characteristic/{characteristicCode}/sp/{receiptId}

Publishes the current request to change a Setting of the referenced Characteristic of the Service of the Component.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
componentCode componentCode
required
string

A uniquely identifiable code of an ACTIVATED Component within a DRIVR System.

Examples: "death-star-laser" "ocean-evaporation-component" "flood-creation-entity"
serviceCode serviceCode
required
string

A uniquely identifiable code of a Service within a DRIVR Domain.

Examples: "death-star-laser" "ocean-evaporation-service" "flood-creation-service"
serviceIndex serviceIndex
required
integer

The index of a Service referenced when adding a Service to a ComponentModel in DRIVR.

Examples: 0 1 2
characteristicCode characteristicCode
required
string

A uniquely identifiable code of a Characteristic within a Service.

Examples: "laser-power" "evaporation-rate" "water-level"
receiptId receiptId
required
string

The receipt ID of a Setpoint within DRIVR used by a System to report back once the Setting change request on a TimeStream has been done.

Examples: "asd28dfa"

Accepts the following message:

CharacteristicSetpoint

A Setpoint for a specific Characteristic within a Service and Component.

Payload characteristicSetpoint
allOf

The message structure which DRIVR sends if a Setpoint has been sent from a System.

0
object
timeStreamUuid
string
uuid

The unique UUID of the TimeStream within DRIVR. A TimeStream is the combination of a Characteristic, Service and Component.

Additional properties are allowed.

1 characteristicSetpointBaseFieldsWithValue
allOf
0
object
value

The value of a Datapoint or Setpoint which is supposed to be set.

Additional properties are allowed.

1 characteristicSetpointBaseFields
object
time
string
date-time

The time when the Setpoint change request was received by DRIVR.

receiptId
string

The unique ID of the Setpoint change request. This ID is used to identify the Setpoint change request in the SetpointReceipt and is used by the System to return to DRIVR once the change has been processed.

Examples: "fn2rn3"

Additional properties are allowed.

Examples

CharacteristicSetpoint
Payload 
{
  "timeStreamUuid": "1e75b89a-810d-4d28-83f8-fffacae4cfad",
  "value": null,
  "time": "2019-08-24T14:15:22Z",
  "receiptId": "fn2rn3"
}
This example has been generated automatically.

Sub /{slug}/systems/{systemUuid}/components/{componentCode}/services/{serviceCode}/index/{serviceIndex}/characteristic/{characteristicCode}/sp/{receiptId}/msgpack

Publishes the current request to change a Setting of the referenced Characteristic of the Service of the Component. Emits payloads encoded as msgpack.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
componentCode componentCode
required
string

A uniquely identifiable code of an ACTIVATED Component within a DRIVR System.

Examples: "death-star-laser" "ocean-evaporation-component" "flood-creation-entity"
serviceCode serviceCode
required
string

A uniquely identifiable code of a Service within a DRIVR Domain.

Examples: "death-star-laser" "ocean-evaporation-service" "flood-creation-service"
serviceIndex serviceIndex
required
integer

The index of a Service referenced when adding a Service to a ComponentModel in DRIVR.

Examples: 0 1 2
characteristicCode characteristicCode
required
string

A uniquely identifiable code of a Characteristic within a Service.

Examples: "laser-power" "evaporation-rate" "water-level"
receiptId receiptId
required
string

The receipt ID of a Setpoint within DRIVR used by a System to report back once the Setting change request on a TimeStream has been done.

Examples: "asd28dfa"

Accepts the following message:

CharacteristicSetpoint

A Setpoint for a specific Characteristic within a Service and Component.

Payload characteristicSetpoint
allOf

The message structure which DRIVR sends if a Setpoint has been sent from a System.

0
object
timeStreamUuid
string
uuid

The unique UUID of the TimeStream within DRIVR. A TimeStream is the combination of a Characteristic, Service and Component.

Additional properties are allowed.

1 characteristicSetpointBaseFieldsWithValue
allOf
0
object
value

The value of a Datapoint or Setpoint which is supposed to be set.

Additional properties are allowed.

1 characteristicSetpointBaseFields
object
time
string
date-time

The time when the Setpoint change request was received by DRIVR.

receiptId
string

The unique ID of the Setpoint change request. This ID is used to identify the Setpoint change request in the SetpointReceipt and is used by the System to return to DRIVR once the change has been processed.

Examples: "fn2rn3"

Additional properties are allowed.

Examples

CharacteristicSetpoint
Payload 
{
  "timeStreamUuid": "1e75b89a-810d-4d28-83f8-fffacae4cfad",
  "value": null,
  "time": "2019-08-24T14:15:22Z",
  "receiptId": "fn2rn3"
}
This example has been generated automatically.

Sub /{slug}/systems/{systemUuid}/components/{componentCode}/services/{serviceCode}/index/{serviceIndex}/characteristic/{characteristicCode}/sp/{receiptId}/state

Publishes the current state of a Setpoint change.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
componentCode componentCode
required
string

A uniquely identifiable code of an ACTIVATED Component within a DRIVR System.

Examples: "death-star-laser" "ocean-evaporation-component" "flood-creation-entity"
serviceCode serviceCode
required
string

A uniquely identifiable code of a Service within a DRIVR Domain.

Examples: "death-star-laser" "ocean-evaporation-service" "flood-creation-service"
serviceIndex serviceIndex
required
integer

The index of a Service referenced when adding a Service to a ComponentModel in DRIVR.

Examples: 0 1 2
characteristicCode characteristicCode
required
string

A uniquely identifiable code of a Characteristic within a Service.

Examples: "laser-power" "evaporation-rate" "water-level"
receiptId receiptId
required
string

The receipt ID of a Setpoint within DRIVR used by a System to report back once the Setting change request on a TimeStream has been done.

Examples: "asd28dfa"

Accepts the following message:

CharacteristicSetpointState

A state change of a Setpoint for a specific Characteristic within a Service and Component.

Payload characteristicSetpointState
allOf

The payload of a Setpoint state change.

0
object
state
string

The state of the Setpoint.

Enum: "CREATED" "ACCEPTED" "REJECTED"

Additional properties are allowed.

1 characteristicSetpointBaseFields
object
time
string
date-time

The time when the Setpoint change request was received by DRIVR.

receiptId
string

The unique ID of the Setpoint change request. This ID is used to identify the Setpoint change request in the SetpointReceipt and is used by the System to return to DRIVR once the change has been processed.

Examples: "fn2rn3"

Additional properties are allowed.

Examples

CharacteristicSetpointState
Payload 
{
  "state": "CREATED",
  "time": "2019-08-24T14:15:22Z",
  "receiptId": "fn2rn3"
}
This example has been generated automatically.

Sub /{slug}/systems/{systemUuid}/components/{componentCode}/services/{serviceCode}/index/{serviceIndex}/characteristic/{characteristicCode}/sp/{receiptId}/state/msgpack

Publishes the current state of a Setpoint change. Publishes the payload encoded as msgpack.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
componentCode componentCode
required
string

A uniquely identifiable code of an ACTIVATED Component within a DRIVR System.

Examples: "death-star-laser" "ocean-evaporation-component" "flood-creation-entity"
serviceCode serviceCode
required
string

A uniquely identifiable code of a Service within a DRIVR Domain.

Examples: "death-star-laser" "ocean-evaporation-service" "flood-creation-service"
serviceIndex serviceIndex
required
integer

The index of a Service referenced when adding a Service to a ComponentModel in DRIVR.

Examples: 0 1 2
characteristicCode characteristicCode
required
string

A uniquely identifiable code of a Characteristic within a Service.

Examples: "laser-power" "evaporation-rate" "water-level"
receiptId receiptId
required
string

The receipt ID of a Setpoint within DRIVR used by a System to report back once the Setting change request on a TimeStream has been done.

Examples: "asd28dfa"

Accepts the following message:

<anonymous-message-28>

A state change of a Setpoint for a specific Characteristic within a Service and Component.

Payload characteristicSetpointState
allOf

The payload of a Setpoint state change.

0
object
state
string

The state of the Setpoint.

Enum: "CREATED" "ACCEPTED" "REJECTED"

Additional properties are allowed.

1 characteristicSetpointBaseFields
object
time
string
date-time

The time when the Setpoint change request was received by DRIVR.

receiptId
string

The unique ID of the Setpoint change request. This ID is used to identify the Setpoint change request in the SetpointReceipt and is used by the System to return to DRIVR once the change has been processed.

Examples: "fn2rn3"

Additional properties are allowed.

Examples

<anonymous-message-28>
Payload 
{
  "state": "CREATED",
  "time": "2019-08-24T14:15:22Z",
  "receiptId": "fn2rn3"
}
This example has been generated automatically.

Sub /{slug}/systems/{systemUuid}/components/{componentCode}/services/{serviceCode}/index/{serviceIndex}/characteristic/{characteristicCode}/sp/{receiptId}/message

Published when a message has been published during a Setpoint change.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
componentCode componentCode
required
string

A uniquely identifiable code of an ACTIVATED Component within a DRIVR System.

Examples: "death-star-laser" "ocean-evaporation-component" "flood-creation-entity"
serviceCode serviceCode
required
string

A uniquely identifiable code of a Service within a DRIVR Domain.

Examples: "death-star-laser" "ocean-evaporation-service" "flood-creation-service"
serviceIndex serviceIndex
required
integer

The index of a Service referenced when adding a Service to a ComponentModel in DRIVR.

Examples: 0 1 2
characteristicCode characteristicCode
required
string

A uniquely identifiable code of a Characteristic within a Service.

Examples: "laser-power" "evaporation-rate" "water-level"
receiptId receiptId
required
string

The receipt ID of a Setpoint within DRIVR used by a System to report back once the Setting change request on a TimeStream has been done.

Examples: "asd28dfa"

Accepts the following message:

CharacteristicSetpointMessage

A message for a Setpoint for a specific Characteristic within a Service and Component.

Payload characteristicSetpointMessage
allOf

The payload of a Setpoint message emitted by the System to explain why a Setpoint was rejected.

0
object
message
string

The message explaining why the Setpoint was rejected.

Examples: "Unrestricted submarine warfare is not allowed by international law." "The laser has not enough power." "Using nukes to heat up the coffee is not allowed." "The coffee is already hot enough." "Why would you want to do THAT to yourself?"

Additional properties are allowed.

1 characteristicSetpointBaseFields
object
time
string
date-time

The time when the Setpoint change request was received by DRIVR.

receiptId
string

The unique ID of the Setpoint change request. This ID is used to identify the Setpoint change request in the SetpointReceipt and is used by the System to return to DRIVR once the change has been processed.

Examples: "fn2rn3"

Additional properties are allowed.

Examples

CharacteristicSetpointMessage
Payload 
{
  "message": "Unrestricted submarine warfare is not allowed by international law.",
  "time": "2019-08-24T14:15:22Z",
  "receiptId": "fn2rn3"
}
This example has been generated automatically.

Sub /{slug}/systems/{systemUuid}/components/{componentCode}/services/{serviceCode}/index/{serviceIndex}/characteristic/{characteristicCode}/sp/{receiptId}/message/msgpack

Published when a message has been published during a Setpoint change. Publishes the payload encoded as msgpack.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
componentCode componentCode
required
string

A uniquely identifiable code of an ACTIVATED Component within a DRIVR System.

Examples: "death-star-laser" "ocean-evaporation-component" "flood-creation-entity"
serviceCode serviceCode
required
string

A uniquely identifiable code of a Service within a DRIVR Domain.

Examples: "death-star-laser" "ocean-evaporation-service" "flood-creation-service"
serviceIndex serviceIndex
required
integer

The index of a Service referenced when adding a Service to a ComponentModel in DRIVR.

Examples: 0 1 2
characteristicCode characteristicCode
required
string

A uniquely identifiable code of a Characteristic within a Service.

Examples: "laser-power" "evaporation-rate" "water-level"
receiptId receiptId
required
string

The receipt ID of a Setpoint within DRIVR used by a System to report back once the Setting change request on a TimeStream has been done.

Examples: "asd28dfa"

Accepts the following message:

<anonymous-message-30>

A message for a Setpoint for a specific Characteristic within a Service and Component.

Payload characteristicSetpointMessage
allOf

The payload of a Setpoint message emitted by the System to explain why a Setpoint was rejected.

0
object
message
string

The message explaining why the Setpoint was rejected.

Examples: "Unrestricted submarine warfare is not allowed by international law." "The laser has not enough power." "Using nukes to heat up the coffee is not allowed." "The coffee is already hot enough." "Why would you want to do THAT to yourself?"

Additional properties are allowed.

1 characteristicSetpointBaseFields
object
time
string
date-time

The time when the Setpoint change request was received by DRIVR.

receiptId
string

The unique ID of the Setpoint change request. This ID is used to identify the Setpoint change request in the SetpointReceipt and is used by the System to return to DRIVR once the change has been processed.

Examples: "fn2rn3"

Additional properties are allowed.

Examples

<anonymous-message-30>
Payload 
{
  "message": "Unrestricted submarine warfare is not allowed by international law.",
  "time": "2019-08-24T14:15:22Z",
  "receiptId": "fn2rn3"
}
This example has been generated automatically.

Sub /{slug}/users/{userUuid}

Receives information about a User in the Domain.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
userUuid userUuid
required
string
uuid

The unique UUID of the User within DRIVR.

Examples: "8718ca2a-5134-41bb-ab81-b65cec310ab9"

Accepts the following message:

UserInformation

The current information which is stored for the User within DRIVR. Information is retained until the User is deleted.

Payload
object
uuid
string
uuid

The UUID of the User.

Examples: "8718ca2a-5134-41bb-ab81-b65cec310ab9"
email
string,null
email

The email of the User if one was provided.

Examples: "user@drivr.cloud"
name
string,null

The name of the current User. This is a human readable name.

Examples: "Dan Moore"
alias
string

The alias of the User. Defines a login name the User can use to authenticate against DRIVR if he has a valid password and the login via password functionality is enabled for the Domain.

Examples: "danmoore@gmail.com" "danmoor" "dan-moor" "danny-boy"
domainUuid
string
uuid

The UUID of the Domain the user belongs to.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
organizationUuid
string
uuid

The UUID of the Organization the User belongs to or None if the User is not assigned to any Organization.

Examples: "d837b268-0855-49ab-b6b2-1070ac7c838e"
metadata
object,null
status
string

The status of a published object.

Enum: "ACTIVATED" "DEACTIVATED" "ARCHIVED"
Examples: "ACTIVATED" "DEACTIVATED" "ARCHIVED"
createdAt
string
date-time
Examples: "2021-08-06T13:13:06.136333+00:00"
updatedAt
string
date-time
Examples: "2021-08-06T14:39:44.368252+00:00"

Additional properties are NOT allowed.

Examples

UserInformation
Payload 
{
  "uuid": "8718ca2a-5134-41bb-ab81-b65cec310ab9",
  "email": "user@drivr.cloud",
  "name": "Dan Moore",
  "alias": "danmoore@gmail.com",
  "domainUuid": "24ee14a3-f1c8-49aa-95fc-ad0432e23b99",
  "organizationUuid": "d837b268-0855-49ab-b6b2-1070ac7c838e",
  "metadata": null,
  "status": "ACTIVATED",
  "createdAt": "2021-08-06T13:13:06.136333+00:00",
  "updatedAt": "2021-08-06T14:39:44.368252+00:00"
}
This example has been generated automatically.

Sub /{slug}/users/{userUuid}/state

Receives information about a User's state in the Domain.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
userUuid userUuid
required
string
uuid

The unique UUID of the User within DRIVR.

Examples: "8718ca2a-5134-41bb-ab81-b65cec310ab9"

Accepts the following message:

UserState

The current state of the User. If the state is set to DELETED the User MQTT topics and all information within will be deleted.

Payload mqttState
string

The state of the object as presented within MQTT.

Enum: "CREATED" "ACTIVATED" "DEACTIVATED" "ARCHIVED" "DELETED"
Examples: "CREATED" "ACTIVATED" "DEACTIVATED" "ARCHIVED" "DELETED"

Examples

UserState
Payload
Example #1
"CREATED"
Example #2
"ACTIVATED"
Example #3
"DEACTIVATED"
Example #4
"ARCHIVED"
Example #5
"DELETED"

Pub /{slug}/input/event/json

Publish Events by Connectors. Only entities which are allowed to manipulate a complete Domain can use this topic. This topic is intended for other Applications which are sending data from multiple Systems. Compared to adding the issuerUuid in the topic it can be added in the payload. If not set, issuerUuid will not be recorded or set. The data payload is expected to be JSON.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"

Accepts the following message:

<anonymous-message-33>

The payload to be processed by DRIVR to import Events on the global MQTT endpoints. Allows to additionally record an issuerUuid in the payload and is intended for Connectors, Systems and mass data processing.

Payload
oneOf
0 GlobalEventInputWithIssuer
object allOf

The message structure used to send a new to be recorded Event with an optional added issuerUuid in the payload.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR. An EventModel acts as a template for DRIVR Events and is used to model an Event on different types of entities. They outline severity level, the type of Event, and define to which type of DRIVR entities an Event can be linked to (e.g. a Component, System).

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
object
issuerUuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Additional properties are allowed.

1
array<object>

Items:

0 GlobalEventInputWithIssuer
object allOf

The message structure used to send a new to be recorded Event with an optional added issuerUuid in the payload.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR. An EventModel acts as a template for DRIVR Events and is used to model an Event on different types of entities. They outline severity level, the type of Event, and define to which type of DRIVR entities an Event can be linked to (e.g. a Component, System).

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
object
issuerUuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Additional properties are allowed.

Additional items are allowed.

Examples

<anonymous-message-33>
Payload
Example #1
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Example #2
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Example #3
{
  "eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}

Pub /{slug}/input/event/msgpack

Publish Events by Connectors. Only entities which are allowed to manipulate a complete Domain can use this topic. This topic is intended for other Applications which are sending data from multiple Systems. Compared to adding the issuerUuid in the topic it can be added in the payload. If not set, issuerUuid will not be recorded or set. The data payload is expected to be in the msgpack format.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"

Accepts the following message:

<anonymous-message-34>

The payload to be processed by DRIVR to import Events on the global MQTT endpoints. Allows to additionally record an issuerUuid in the payload and is intended for Connectors, Systems and mass data processing.

Payload
oneOf
0 GlobalEventInputWithIssuer
object allOf

The message structure used to send a new to be recorded Event with an optional added issuerUuid in the payload.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR. An EventModel acts as a template for DRIVR Events and is used to model an Event on different types of entities. They outline severity level, the type of Event, and define to which type of DRIVR entities an Event can be linked to (e.g. a Component, System).

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
object
issuerUuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Additional properties are allowed.

1
array<object>

Items:

0 GlobalEventInputWithIssuer
object allOf

The message structure used to send a new to be recorded Event with an optional added issuerUuid in the payload.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR. An EventModel acts as a template for DRIVR Events and is used to model an Event on different types of entities. They outline severity level, the type of Event, and define to which type of DRIVR entities an Event can be linked to (e.g. a Component, System).

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
object
issuerUuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Additional properties are allowed.

Additional items are allowed.

Examples

<anonymous-message-34>
Payload
Example #1
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Example #2
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Example #3
{
  "eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}

Pub /{slug}/input/event/json/{issuerUuid}

Publish Events by Connectors. Only entities which are allowed to manipulate a complete Domain can use this topic. This topic is intended for other Applications which are sending data from multiple Systems. Compared to adding the issuerUuid in the topic it can be added in the payload. If not set, issuerUuid will not be recorded or set. The data payload is expected to be JSON.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
issuerUuid issuerUuid
required
string
uuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Examples: "f5b7c457-b6f8-4eb2-9bbe-9c7a81f22bea"

Accepts the following message:

<anonymous-message-35>

The payload to be processed by DRIVR to import Events on the global MQTT endpoints.

Payload
oneOf
0 GlobalEventInput
object allOf

The message structure used to send a new to be recorded Event.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
array<object>

Items:

0 GlobalEventInput
object allOf

The message structure used to send a new to be recorded Event.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

Additional items are allowed.

Examples

<anonymous-message-35>
Payload
Example #1
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00"
}
Example #2
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00"
}
Example #3
{
  "eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00"
}

Pub /{slug}/input/event/msgpack/{issuerUuid}

Publish Events by Connectors. Only entities which are allowed to manipulate a complete Domain can use this topic. This topic is intended for other Applications which are sending data from multiple Systems. Compared to adding the issuerUuid in the topic it can be added in the payload. If not set, issuerUuid will not be recorded or set. The data payload is expected to be in the msgpack format.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
issuerUuid issuerUuid
required
string
uuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Examples: "f5b7c457-b6f8-4eb2-9bbe-9c7a81f22bea"

Accepts the following message:

<anonymous-message-36>

The payload to be processed by DRIVR to import Events on the global MQTT endpoints.

Payload
oneOf
0 GlobalEventInput
object allOf

The message structure used to send a new to be recorded Event.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
array<object>

Items:

0 GlobalEventInput
object allOf

The message structure used to send a new to be recorded Event.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

Additional items are allowed.

Examples

<anonymous-message-36>
Payload
Example #1
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00"
}
Example #2
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00"
}
Example #3
{
  "eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00"
}

Pub /{slug}/input/event/s/{systemUuid}/json

Publish Events by Systems. This topic can only be used by Systems themselves. Compared to adding the issuerUuid in the topic it can be added in the payload. If not set, systemUuid will used as issuerUuid. The data payload is expected to be JSON.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"

Accepts the following message:

<anonymous-message-37>

The payload to be processed by DRIVR to import Events on the global MQTT endpoints. Allows to additionally record an issuerUuid in the payload and is intended for Connectors, Systems and mass data processing.

Payload
oneOf
0 GlobalEventInputWithIssuer
object allOf

The message structure used to send a new to be recorded Event with an optional added issuerUuid in the payload.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR. An EventModel acts as a template for DRIVR Events and is used to model an Event on different types of entities. They outline severity level, the type of Event, and define to which type of DRIVR entities an Event can be linked to (e.g. a Component, System).

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
object
issuerUuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Additional properties are allowed.

1
array<object>

Items:

0 GlobalEventInputWithIssuer
object allOf

The message structure used to send a new to be recorded Event with an optional added issuerUuid in the payload.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR. An EventModel acts as a template for DRIVR Events and is used to model an Event on different types of entities. They outline severity level, the type of Event, and define to which type of DRIVR entities an Event can be linked to (e.g. a Component, System).

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
object
issuerUuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Additional properties are allowed.

Additional items are allowed.

Examples

<anonymous-message-37>
Payload
Example #1
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Example #2
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Example #3
{
  "eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}

Pub /{slug}/input/event/s/{systemUuid}/msgpack

Publish Events by Systems. This topic can only be used by Systems themselves. If not set, systemUuid will used as issuerUuid. The data payload is expected to be in the msgpack format.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"

Accepts the following message:

<anonymous-message-38>

The payload to be processed by DRIVR to import Events on the global MQTT endpoints. Allows to additionally record an issuerUuid in the payload and is intended for Connectors, Systems and mass data processing.

Payload
oneOf
0 GlobalEventInputWithIssuer
object allOf

The message structure used to send a new to be recorded Event with an optional added issuerUuid in the payload.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR. An EventModel acts as a template for DRIVR Events and is used to model an Event on different types of entities. They outline severity level, the type of Event, and define to which type of DRIVR entities an Event can be linked to (e.g. a Component, System).

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
object
issuerUuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Additional properties are allowed.

1
array<object>

Items:

0 GlobalEventInputWithIssuer
object allOf

The message structure used to send a new to be recorded Event with an optional added issuerUuid in the payload.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR. An EventModel acts as a template for DRIVR Events and is used to model an Event on different types of entities. They outline severity level, the type of Event, and define to which type of DRIVR entities an Event can be linked to (e.g. a Component, System).

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
object
issuerUuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Additional properties are allowed.

Additional items are allowed.

Examples

<anonymous-message-38>
Payload
Example #1
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Example #2
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Example #3
{
  "eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}

Pub /{slug}/input/event/s/{systemUuid}/json/{issuerUuid}

Publish Events by Systems. This topic can only be used by Systems themselves. If not set, systemUuid will used as issuerUuid. The data payload is expected to be JSON.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
issuerUuid issuerUuid
required
string
uuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Examples: "f5b7c457-b6f8-4eb2-9bbe-9c7a81f22bea"

Accepts the following message:

<anonymous-message-39>

The payload to be processed by DRIVR to import Events on the global MQTT endpoints.

Payload
oneOf
0 GlobalEventInput
object allOf

The message structure used to send a new to be recorded Event.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
array<object>

Items:

0 GlobalEventInput
object allOf

The message structure used to send a new to be recorded Event.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

Additional items are allowed.

Examples

<anonymous-message-39>
Payload
Example #1
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00"
}
Example #2
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00"
}
Example #3
{
  "eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00"
}

Pub /{slug}/input/event/s/{systemUuid}/msgpack/{issuerUuid}

Publish Events for Systems. This topic can only be used by Systems themselves. If not set, systemUuid will used as issuerUuid. The data payload is expected to be in the msgpack format.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
systemUuid systemUuid
required
string
uuid

The unique UUID of the System within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
issuerUuid issuerUuid
required
string
uuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Examples: "f5b7c457-b6f8-4eb2-9bbe-9c7a81f22bea"

Accepts the following message:

<anonymous-message-40>

The payload to be processed by DRIVR to import Events on the global MQTT endpoints.

Payload
oneOf
0 GlobalEventInput
object allOf

The message structure used to send a new to be recorded Event.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
array<object>

Items:

0 GlobalEventInput
object allOf

The message structure used to send a new to be recorded Event.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

Additional items are allowed.

Examples

<anonymous-message-40>
Payload
Example #1
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00"
}
Example #2
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00"
}
Example #3
{
  "eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00"
}

Pub /{slug}/input/event/c/{componentUuid}/json

Publish Events by Components. This topic can only be used by Components themselves. Compared to adding the issuerUuid in the topic it can be added in the payload. If not set, componentUuid will used as issuerUuid. The data payload is expected to be JSON.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
componentUuid componentUuid
required
string
uuid

The unique UUID of the Component within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"

Accepts the following message:

<anonymous-message-41>

The payload to be processed by DRIVR to import Events on the global MQTT endpoints. Allows to additionally record an issuerUuid in the payload and is intended for Connectors, Systems and mass data processing.

Payload
oneOf
0 GlobalEventInputWithIssuer
object allOf

The message structure used to send a new to be recorded Event with an optional added issuerUuid in the payload.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR. An EventModel acts as a template for DRIVR Events and is used to model an Event on different types of entities. They outline severity level, the type of Event, and define to which type of DRIVR entities an Event can be linked to (e.g. a Component, System).

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
object
issuerUuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Additional properties are allowed.

1
array<object>

Items:

0 GlobalEventInputWithIssuer
object allOf

The message structure used to send a new to be recorded Event with an optional added issuerUuid in the payload.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR. An EventModel acts as a template for DRIVR Events and is used to model an Event on different types of entities. They outline severity level, the type of Event, and define to which type of DRIVR entities an Event can be linked to (e.g. a Component, System).

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
object
issuerUuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Additional properties are allowed.

Additional items are allowed.

Examples

<anonymous-message-41>
Payload
Example #1
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Example #2
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Example #3
{
  "eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}

Pub /{slug}/input/event/c/{componentUuid}/msgpack

Publish Events by Components. This topic can only be used by Components themselves. If not set, componentUuid will used as issuerUuid. The data payload is expected to be in the msgpack format.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
componentUuid componentUuid
required
string
uuid

The unique UUID of the Component within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"

Accepts the following message:

<anonymous-message-42>

The payload to be processed by DRIVR to import Events on the global MQTT endpoints. Allows to additionally record an issuerUuid in the payload and is intended for Connectors, Systems and mass data processing.

Payload
oneOf
0 GlobalEventInputWithIssuer
object allOf

The message structure used to send a new to be recorded Event with an optional added issuerUuid in the payload.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR. An EventModel acts as a template for DRIVR Events and is used to model an Event on different types of entities. They outline severity level, the type of Event, and define to which type of DRIVR entities an Event can be linked to (e.g. a Component, System).

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
object
issuerUuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Additional properties are allowed.

1
array<object>

Items:

0 GlobalEventInputWithIssuer
object allOf

The message structure used to send a new to be recorded Event with an optional added issuerUuid in the payload.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR. An EventModel acts as a template for DRIVR Events and is used to model an Event on different types of entities. They outline severity level, the type of Event, and define to which type of DRIVR entities an Event can be linked to (e.g. a Component, System).

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
object
issuerUuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Additional properties are allowed.

Additional items are allowed.

Examples

<anonymous-message-42>
Payload
Example #1
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Example #2
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}
Example #3
{
  "eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00",
  "issuerUuid": "77f353ee-36b7-4f42-8634-38e51c01ded4"
}

Pub /{slug}/input/event/c/{componentUuid}/json/{issuerUuid}

Publish Events by Components. This topic can only be used by Components themselves. If not set, componentUuid will used as issuerUuid. The data payload is expected to be JSON.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
componentUuid componentUuid
required
string
uuid

The unique UUID of the Component within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
issuerUuid issuerUuid
required
string
uuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Examples: "f5b7c457-b6f8-4eb2-9bbe-9c7a81f22bea"

Accepts the following message:

<anonymous-message-43>

The payload to be processed by DRIVR to import Events on the global MQTT endpoints.

Payload
oneOf
0 GlobalEventInput
object allOf

The message structure used to send a new to be recorded Event.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1
array<object>

Items:

0 GlobalEventInput
object allOf

The message structure used to send a new to be recorded Event.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

Additional items are allowed.

Examples

<anonymous-message-43>
Payload
Example #1
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00"
}
Example #2
{
  "eventModelUuid": "3a1531f3-071b-4886-9fb5-b9b1dbd10263",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00"
}
Example #3
{
  "eventModelUuid": "83c2fbb4-62a7-4432-9dce-564c8883cb1f",
  "entityUuid": "46358f27-e4ff-4260-8df8-36cfd1b156d3",
  "time": "2021-08-06T13:13:06.136333+00:00"
}

Pub /{slug}/input/event/c/{componentUuid}/msgpack/{issuerUuid}

Publish Events for Components. This topic can only be used by Components themselves. If not set, componentUuid will used as issuerUuid. The data payload is expected to be in the msgpack format.

Parameters
slug slug
required
string

The slug of your individual Domain.

Examples: "adam" "eve"
componentUuid componentUuid
required
string
uuid

The unique UUID of the Component within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
issuerUuid issuerUuid
required
string
uuid

The unique UUID of the User or System of the entity in DRIVR which issues the change.

Examples: "f5b7c457-b6f8-4eb2-9bbe-9c7a81f22bea"

Accepts the following message:

<anonymous-message-44>

The payload to be processed by DRIVR to import Events on the global MQTT endpoints.

Payload
oneOf
0 GlobalEventInput
object allOf

The message structure used to send a new to be recorded Event.

Additional properties are allowed.

0
object
eventModelUuid
required
string
uuid

The unique UUID of the EventModel within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
entityUuid
required
string
uuid

The unique UUID of the Entity within DRIVR.

Examples: "24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
time
string
date-time

The timestamp when the Event occurred. Optional and will be set to the current server time if not set.

Examples: "2019-01-01T00:00:00.000Z"
endTime
string
date-time

The timestamp when the Event ended. Optional.

Examples: "2019-01-01T00:00:00.000Z"
metadata
object,null

Additional properties are allowed.

1