DRIVR MQTT API 1.1.0

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

Servers

  • mqtt://mqtt.drivr.cloud:{port}/drivr/v1secure-mqtt 3.1.1drivr-mqtt-broker

    DRIVR MQTT Broker

    object
    port
    required
    string
    Default value:"8883"
      Allowed values:
    • "8883"

Operations

  • SUB /{slug}

    Returns information about the domain.

    Operation IDgetDomainInformation

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"

    Accepts the following message:

    DomainInformation
    Message IDDomainInformation

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

    object

    Examples

  • SUB /{slug}/state

    Returns the current status of a domain.

    Operation IDgetDomainState

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"

    Accepts the following message:

    DomainMqttState
    Message IDDomainMqttState

    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
    string

    The state of the object as presented within MQTT.

      Allowed values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"
      Examples values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"

    Examples

  • SUB /{slug}/organizations/{organizationUuid}

    Returns information about the Organization in the DRIVR Domain.

    Operation IDgetOrganizationInformation

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    organizationUuid
    required
    string
    format: uuid

    The unique UUID of the Organization within DRIVR.

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

    Accepts the following message:

    OrganizationInformation
    Message IDOrganizationInformation

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

    object

    Examples

  • SUB /{slug}/organizations/{organizationUuid}/state

    Provides the current state of the Organization.

    Operation IDgetOrganizationState

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    organizationUuid
    required
    string
    format: uuid

    The unique UUID of the Organization within DRIVR.

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

    Accepts the following message:

    OrganizationMqttState
    Message IDOrganizationMqttState

    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
    string

    The state of the object as presented within MQTT.

      Allowed values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"
      Examples values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"

    Examples

  • SUB /{slug}/authorization/roleAssignments/{roleAssignmentUuid}

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

    Operation IDgetDomainRoleAssignment

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    roleAssignmentUuid
    required
    string
    format: uuid

    The unique UUID of the RoleAssignment within DRIVR.

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

    Accepts the following message:

    DomainRoleAssignment
    Message IDDomainRoleAssignment

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

    object

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

    Examples

  • SUB /{slug}/authorization/roleAssignments/{roleAssignmentUuid}/state

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

    Operation IDgetDomainRoleAssignmentState

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    roleAssignmentUuid
    required
    string
    format: uuid

    The unique UUID of the RoleAssignment within DRIVR.

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

    Accepts the following message:

    DomainRoleAssignmentMqttState
    Message IDDomainRoleAssignmentMqttState

    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
    string

    The state of the object as presented within MQTT.

      Allowed values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"
      Examples values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"

    Examples

  • SUB /{slug}/authorization/applicationConsumers/{applicationConsumerUuid}/roleAssignments/{roleAssignmentUuid}

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

    Operation IDsubscribe

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    applicationConsumerUuid
    required
    string
    format: uuid

    The unique UUID of the ApplicationConsumer within DRIVR.

      Examples values:
    • "90525c81-88f7-4fd9-8e10-54ee353cad7d"
    roleAssignmentUuid
    required
    string
    format: uuid

    The unique UUID of the RoleAssignment within DRIVR.

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

    Accepts the following message:

    DomainRoleAssignment
    Message IDDomainRoleAssignment

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

    object

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

    Examples

  • SUB /{slug}/authorization/applicationConsumers/{applicationConsumerUuid}/roleAssignments/{roleAssignmentUuid}/state

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

    Operation IDsubscribe

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    applicationConsumerUuid
    required
    string
    format: uuid

    The unique UUID of the ApplicationConsumer within DRIVR.

      Examples values:
    • "90525c81-88f7-4fd9-8e10-54ee353cad7d"
    roleAssignmentUuid
    required
    string
    format: uuid

    The unique UUID of the RoleAssignment within DRIVR.

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

    Accepts the following message:

    DomainRoleAssignmentMqttState
    Message IDDomainRoleAssignmentMqttState

    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
    string

    The state of the object as presented within MQTT.

      Allowed values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"
      Examples values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"

    Examples

  • SUB /{slug}/authorization/systems/{systemUuid}/roleAssignments/{roleAssignmentUuid}

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

    Operation IDgetSystemRoleAssignment

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

    The unique UUID of the RoleAssignment within DRIVR.

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

    Accepts the following message:

    SystemRoleAssignment
    Message IDSystemRoleAssignment

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

    object

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

    Examples

  • SUB /{slug}/authorization/systems/{systemUuid}/roleAssignments/{roleAssignmentUuid}/state

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

    Operation IDgetSystemRoleAssignmentState

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

    The unique UUID of the RoleAssignment within DRIVR.

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

    Accepts the following message:

    SystemRoleAssignmentMqttState
    Message IDSystemRoleAssignmentMqttState

    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
    string

    The state of the object as presented within MQTT.

      Allowed values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"
      Examples values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"

    Examples

  • SUB /{slug}/authorization/organizations/{organizationUuid}/roleAssignments/{roleAssignmentUuid}

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

    Operation IDsubscribe

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    organizationUuid
    required
    string
    format: uuid

    The unique UUID of the Organization within DRIVR.

      Examples values:
    • "d837b268-0855-49ab-b6b2-1070ac7c838e"
    roleAssignmentUuid
    required
    string
    format: uuid

    The unique UUID of the RoleAssignment within DRIVR.

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

    Accepts the following message:

    DomainRoleAssignment
    Message IDDomainRoleAssignment

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

    object

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

    Examples

  • SUB /{slug}/authorization/organizations/{organizationUuid}/roleAssignments/{roleAssignmentUuid}/state

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

    Operation IDsubscribe

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    organizationUuid
    required
    string
    format: uuid

    The unique UUID of the Organization within DRIVR.

      Examples values:
    • "d837b268-0855-49ab-b6b2-1070ac7c838e"
    roleAssignmentUuid
    required
    string
    format: uuid

    The unique UUID of the RoleAssignment within DRIVR.

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

    Accepts the following message:

    DomainRoleAssignmentMqttState
    Message IDDomainRoleAssignmentMqttState

    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
    string

    The state of the object as presented within MQTT.

      Allowed values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"
      Examples values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"

    Examples

  • SUB /{slug}/authorization/roles/{roleUuid}

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

    Operation IDgetRoleInformation

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    roleUuid
    required
    string
    format: uuid

    The unique UUID of the Role within DRIVR.

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

    Accepts the following message:

    RoleInformation
    Message IDRoleInformation

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

    object

    Examples

  • SUB /{slug}/authorization/roles/{roleUuid}/state

    Provides the current state of the Role.

    Operation IDgetRoleState

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    roleUuid
    required
    string
    format: uuid

    The unique UUID of the Role within DRIVR.

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

    Accepts the following message:

    RoleInformationMqttState
    Message IDRoleInformationMqttState

    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
    string

    The state of the object as presented within MQTT.

      Allowed values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"
      Examples values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"

    Examples

  • SUB /{slug}/systems/{systemUuid}

    Returns information about the System with the provided UUID.

    Operation IDgetSystemInformation

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

    Accepts the following message:

    SystemInformation
    Message IDSystemInformation

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

    object

    Examples

  • SUB /{slug}/systems/{systemUuid}/state

    Provides the current state of the System.

    Operation IDgetSystemState

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

    Accepts the following message:

    SystemMqttState
    Message IDSystemMqttState

    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
    string

    The state of the object as presented within MQTT.

      Allowed values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"
      Examples values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"

    Examples

  • SUB /{slug}/systems/{systemUuid}/state/connection

    Provides the current connection state of the System.

    Operation IDgetSystemConnectionState

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

    Accepts the following message:

    SystemConnectionState
    Message IDSystemConnectionState

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

    Payload
    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 values:
    • "CONNECTED"
    • "DISCONNECTED"
    • "PARTIALLY_CONNECTED"
    • "UNDEFINED"

    Examples

  • 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.

    Operation IDgetSystemEventInformation

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

    The unique UUID of the Event within DRIVR.

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

    Accepts the following message:

    EventInformation
    Message IDEventInformation

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

    object

    Examples

  • 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.

    Operation IDgetSystemEventState

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

    The unique UUID of the Event within DRIVR.

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

    Accepts the following message:

    EventMqttState
    Message IDEventMqttState

    The current state of the Event. Retained if ACTIVE

    Payload
    string
      Examples values:
    • "ACTIVE"
    • "RESOLVED"

    Examples

  • 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.

    Operation IDgetSystemEventAck

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

    The unique UUID of the Event within DRIVR.

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

    Accepts the following message:

    EventAck
    Message IDEventAck

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

    object

    Examples

  • SUB /{slug}/systems/{systemUuid}/components/{componentCode}

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

    Operation IDgetComponentInformation

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

    Accepts the following message:

    ComponentInformation
    Message IDComponentInformation

    General information about a Component within a DRIVR System.

    object

    Examples

  • SUB /{slug}/systems/{systemUuid}/components/{componentCode}/state

    Returns the current state of the referenced Component.

    Operation IDgetComponentState

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

    Accepts the following message:

    ComponentMqttState
    Message IDComponentMqttState

    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
    string

    The state of the object as presented within MQTT.

      Allowed values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"
      Examples values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"

    Examples

  • SUB /{slug}/systems/{systemUuid}/components/{componentCode}/state/connection

    Provides the current connection state of the Component.

    Operation IDgetComponentConnectionState

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

    Accepts the following message:

    ComponentConnectionState
    Message IDComponentConnectionState

    The current connection status of the referenced Component.

    Payload
    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.

      Allowed values:
    • "CONNECTED"
    • "DISCONNECTED"
    • "NOT_CONNECTIVE"
    • "UNDEFINED"
      Examples values:
    • "CONNECTED"
    • "DISCONNECTED"
    • "NOT_CONNECTIVE"
    • "UNDEFINED"

    Examples

  • SUB /{slug}/systems/{systemUuid}/components/{componentCode}/events/{eventUuid}

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

    Operation IDgetComponentEventInformation

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

    The unique UUID of the Event within DRIVR.

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

    Accepts the following message:

    EventInformation
    Message IDEventInformation

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

    object

    Examples

  • 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.

    Operation IDgetComponentEventState

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

    The unique UUID of the Event within DRIVR.

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

    Accepts the following message:

    EventMqttState
    Message IDEventMqttState

    The current state of the Event. Retained if ACTIVE

    Payload
    string
      Examples values:
    • "ACTIVE"
    • "RESOLVED"

    Examples

  • 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.

    Operation IDgetComponentEventAck

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

    The unique UUID of the Event within DRIVR.

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

    Accepts the following message:

    EventAck
    Message IDEventAck

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

    object

    Examples

  • 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.

    Operation IDgetCharacteristicDatapointJson

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

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

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

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

      Examples values:
    • 0
    • 1
    • 2
    characteristicCode
    required
    string

    A uniquely identifiable code of a Characteristic within a Service.

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

    Accepts the following message:

    CharacteristicDatapoint
    Message IDCharacteristicDatapoint

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

    object

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

    Examples

  • 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.

    Operation IDgetCharacteristicDatapointMsgpack

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

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

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

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

      Examples values:
    • 0
    • 1
    • 2
    characteristicCode
    required
    string

    A uniquely identifiable code of a Characteristic within a Service.

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

    Accepts the following message:

    CharacteristicDatapoint
    Message IDCharacteristicDatapoint

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

    object

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

    Examples

  • 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.

    Operation IDgetCharacteristicSetpointJson

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

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

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

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

      Examples values:
    • 0
    • 1
    • 2
    characteristicCode
    required
    string

    A uniquely identifiable code of a Characteristic within a Service.

      Examples values:
    • "laser-power"
    • "evaporation-rate"
    • "water-level"
    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 values:
    • "asd28dfa"

    Accepts the following message:

    CharacteristicSetpoint
    Message IDCharacteristicSetpoint

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

    restricted any allOf

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

    Examples

  • 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.

    Operation IDgetCharacteristicSetpointMsgpack

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

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

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

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

      Examples values:
    • 0
    • 1
    • 2
    characteristicCode
    required
    string

    A uniquely identifiable code of a Characteristic within a Service.

      Examples values:
    • "laser-power"
    • "evaporation-rate"
    • "water-level"
    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 values:
    • "asd28dfa"

    Accepts the following message:

    CharacteristicSetpoint
    Message IDCharacteristicSetpoint

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

    restricted any allOf

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

    Examples

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

    Publishes the current state of a Setpoint change.

    Operation IDgetCharacteristicSetpointStateJson

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

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

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

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

      Examples values:
    • 0
    • 1
    • 2
    characteristicCode
    required
    string

    A uniquely identifiable code of a Characteristic within a Service.

      Examples values:
    • "laser-power"
    • "evaporation-rate"
    • "water-level"
    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 values:
    • "asd28dfa"

    Accepts the following message:

    CharacteristicSetpointState
    Message IDCharacteristicSetpointState

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

    restricted any allOf

    The payload of a Setpoint state change.

    Examples

  • 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.

    Operation IDgetCharacteristicSetpointStateMsgpack

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

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

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

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

      Examples values:
    • 0
    • 1
    • 2
    characteristicCode
    required
    string

    A uniquely identifiable code of a Characteristic within a Service.

      Examples values:
    • "laser-power"
    • "evaporation-rate"
    • "water-level"
    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 values:
    • "asd28dfa"

    Accepts the following message:

    CharacteristicSetpointState
    Message IDCharacteristicSetpointState

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

    restricted any allOf

    The payload of a Setpoint state change.

    Examples

  • 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.

    Operation IDgetCharacteristicSetpointMessageJson

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

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

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

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

      Examples values:
    • 0
    • 1
    • 2
    characteristicCode
    required
    string

    A uniquely identifiable code of a Characteristic within a Service.

      Examples values:
    • "laser-power"
    • "evaporation-rate"
    • "water-level"
    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 values:
    • "asd28dfa"

    Accepts the following message:

    CharacteristicSetpointMessage
    Message IDCharacteristicSetpointMessage

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

    restricted any allOf

    An optional message to add to the receipt of a Setpoint.

    Examples

  • 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.

    Operation IDgetCharacteristicSetpointMessageMsgpack

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

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

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

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

      Examples values:
    • 0
    • 1
    • 2
    characteristicCode
    required
    string

    A uniquely identifiable code of a Characteristic within a Service.

      Examples values:
    • "laser-power"
    • "evaporation-rate"
    • "water-level"
    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 values:
    • "asd28dfa"

    Accepts the following message:

    CharacteristicSetpointMessage
    Message IDCharacteristicSetpointMessage

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

    restricted any allOf

    An optional message to add to the receipt of a Setpoint.

    Examples

  • SUB /{slug}/users/{userUuid}

    Receives information about a User in the Domain.

    Operation IDgetUserInformation

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    userUuid
    required
    string
    format: uuid

    The unique UUID of the User within DRIVR.

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

    Accepts the following message:

    UserInformation
    Message IDUserInformation

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

    object

    Examples

  • SUB /{slug}/users/{userUuid}/state

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

    Operation IDgetUserState

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    userUuid
    required
    string
    format: uuid

    The unique UUID of the User within DRIVR.

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

    Accepts the following message:

    UserState
    Message IDUserState

    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
    string

    The state of the object as presented within MQTT.

      Allowed values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"
      Examples values:
    • "CREATED"
    • "ACTIVATED"
    • "DEACTIVATED"
    • "ARCHIVED"
    • "DELETED"

    Examples

  • 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. If a uuid is set in the payload, the event with it will be updated. The data payload is expected to be JSON.

    Operation IDpublishGlobalEventJson

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"

    Accepts the following message:

    GlobalEventInputWithIssuer
    Message IDGlobalEventInputWithIssuer

    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. The EventModel can be specified via either its uuid or code. Existing Events within DRIVR get updated if uuid is set or the Event can be identified via the exact time and either the eventModelUuid or eventModelCode

    oneOf

    Examples

  • PUB /{slug}/input/event/json/error

    This topic is used by DRIVR to publish errors which occur during processing on the parent topic. The data payload is expected to be in the JSON format.

    Operation IDpublish

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"

    Accepts the following message:

    ValidationError
    Message IDValidationError

    An error message from the server.

    object

    Examples

  • 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. If a uuid is set in the payload, the event with it will be updated. The data payload is expected to be in the msgpack format.

    Operation IDpublishGlobalEventMsgpack

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"

    Accepts the following message:

    GlobalEventInputWithIssuer
    Message IDGlobalEventInputWithIssuer

    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. The EventModel can be specified via either its uuid or code. Existing Events within DRIVR get updated if uuid is set or the Event can be identified via the exact time and either the eventModelUuid or eventModelCode

    oneOf

    Examples

  • PUB /{slug}/input/event/msgpack/error

    This topic is used by DRIVR to publish errors which occur during processing on the parent topic. The data payload is expected to be in the msgpack format.

    Operation IDpublish

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"

    Accepts the following message:

    ValidationError
    Message IDValidationError

    An error message from the server.

    object

    Examples

  • 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. If a uuid is set in the payload, the event with it will be updated. The data payload is expected to be JSON.

    Operation IDpublishGlobalEventJsonWithIssuer

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    issuerUuid
    required
    string
    format: uuid

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

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

    Accepts the following message:

    GlobalEventInput
    Message IDGlobalEventInput

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

    oneOf

    Examples

  • PUB /{slug}/input/event/json/{issuerUuid}/error

    This topic is used by DRIVR to publish errors which occur during processing on the parent topic. The data payload is expected to be in the JSON format.

    Operation IDpublish

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    issuerUuid
    required
    string
    format: uuid

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

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

    Accepts the following message:

    ValidationError
    Message IDValidationError

    An error message from the server.

    object

    Examples

  • 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. If a uuid is set in the payload, the event with it will be updated. The data payload is expected to be in the msgpack format.

    Operation IDpublishGlobalEventMsgpackWithIssuer

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    issuerUuid
    required
    string
    format: uuid

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

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

    Accepts the following message:

    GlobalEventInput
    Message IDGlobalEventInput

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

    oneOf

    Examples

  • PUB /{slug}/input/event/msgpack/{issuerUuid}/error

    This topic is used by DRIVR to publish errors which occur during processing on the parent topic. The data payload is expected to be in the msgpack format.

    Operation IDpublish

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    issuerUuid
    required
    string
    format: uuid

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

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

    Accepts the following message:

    ValidationError
    Message IDValidationError

    An error message from the server.

    object

    Examples

  • 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. If a uuid is set in the payload, the event with it will be updated. The data payload is expected to be JSON.

    Operation IDpublishSystemEventJson

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

    Accepts the following message:

    SystemEventInputWithIssuer
    Message IDSystemEventInputWithIssuer

    The payload to be processed by DRIVR to import Events on the system MQTT endpoints. Allows to additionally record an issuerUuid in the payload and is intended for Connectors, Systems and mass data processing. The EventModel can be specified via either its uuid or code. Existing Events within DRIVR get updated if uuid is set or the Event can be identified via the exact time and either the eventModelUuid or eventModelCode

    oneOf

    Examples

  • PUB /{slug}/input/event/s/{systemUuid}/json/error

    This topic is used by DRIVR to publish errors which occur during processing on the parent topic. The data payload is expected to be in the JSON format.

    Operation IDpublish

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

    Accepts the following message:

    ValidationError
    Message IDValidationError

    An error message from the server.

    object

    Examples

  • 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. If a uuid is set in the payload, the event with it will be updated. The data payload is expected to be in the msgpack format.

    Operation IDpublishSystemEventMsgpack

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

    Accepts the following message:

    SystemEventInputWithIssuer
    Message IDSystemEventInputWithIssuer

    The payload to be processed by DRIVR to import Events on the system MQTT endpoints. Allows to additionally record an issuerUuid in the payload and is intended for Connectors, Systems and mass data processing. The EventModel can be specified via either its uuid or code. Existing Events within DRIVR get updated if uuid is set or the Event can be identified via the exact time and either the eventModelUuid or eventModelCode

    oneOf

    Examples

  • PUB /{slug}/input/event/s/{systemUuid}/msgpack/error

    This topic is used by DRIVR to publish errors which occur during processing on the parent topic. The data payload is expected to be in the msgpack format.

    Operation IDpublish

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

    Accepts the following message:

    ValidationError
    Message IDValidationError

    An error message from the server.

    object

    Examples

  • 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. If a uuid is set in the payload, the event with it will be updated. The data payload is expected to be JSON.

    Operation IDpublishSystemEventJsonWithIssuer

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

    Accepts the following message:

    SystemEventInput
    Message IDSystemEventInput

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

    oneOf

    Examples

  • PUB /{slug}/input/event/s/{systemUuid}/json/{issuerUuid}/error

    This topic is used by DRIVR to publish errors which occur during processing on the parent topic. The data payload is expected to be in the JSON format.

    Operation IDpublish

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

    Accepts the following message:

    ValidationError
    Message IDValidationError

    An error message from the server.

    object

    Examples

  • 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. If a uuid is set in the payload, the event with it will be updated. The data payload is expected to be in the msgpack format.

    Operation IDpublishSystemEventMsgpackWithIssuer

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

    Accepts the following message:

    SystemEventInput
    Message IDSystemEventInput

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

    oneOf

    Examples

  • PUB /{slug}/input/event/s/{systemUuid}/msgpack/{issuerUuid}/error

    This topic is used by DRIVR to publish errors which occur during processing on the parent topic. The data payload is expected to be in the msgpack format.

    Operation IDpublish

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    systemUuid
    required
    string
    format: uuid

    The unique UUID of the System within DRIVR.

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

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

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

    Accepts the following message:

    ValidationError
    Message IDValidationError

    An error message from the server.

    object

    Examples

  • 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. If a uuid is set in the payload, the event with it will be updated. The data payload is expected to be JSON.

    Operation IDpublishComponentEventJson

    Available only on servers:

    object
    slug
    required
    string

    The slug of your individual Domain.

      Examples values:
    • "adam"
    • "eve"
    componentUuid
    required
    string
    format: uuid

    The unique UUID of the Component within DRIVR.

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

    Accepts the following message:

    ComponentEventInputWithIssuer
    Message IDComponentEventInputWithIssuer

    The payload to be processed by DRIVR to import Events on the component MQTT endpoints. Optionally, an issuerUuid can be set to identify the issuer of the Event.

    oneOf