Introduction

Topics

Messages

Schemas

IoT Data simulator websocket/STOMP API 1.0.0

Connection details

URL Scheme Description
services:8080/ws stomp

sessions management API

Topics

/user/queue/error

Message

Services unexpected error message.

Payload

Name Title Type Format Default Description
message string error message property

Example of payload (generated)

{
  "message": "string"
}

Tags

error

/user/queue/sessions

Message

Active sesssions status information.

Payload

Name Title Type Format Default Description
type (Required) string sessions_status_command_result "sessions_status_command_result" message type
result string command processing result. One of the following: "success" | "failure"
errorMessage string contains error description in case of result: "failure"
statuses (Required) array (object) active sessions statuses
sessionId string session id property
state string current active session state. One of the following: "running" | "paused" | "completed" | "failed"
errors array (string) contains session errors in case of session state "failed"

Example of payload (generated)

{
  "type": "sessions_status_command_result",
  "result": "success",
  "errorMessage": "string",
  "statuses": [
    {
      "sessionId": "string",
      "state": "running",
      "errors": [
        "string"
      ]
    }
  ]
}

Tags

session
status
command
result

Publish /sessions

Message

An empty message to trigger provision of all active sessions statuses.

Payload

Name Title Type Format Default Description
Message Payload

Tags

sessions
status
command

/user/queue/sessions.{sessionId}

Message

Active sesssion managemnt command result.

Payload

Name Title Type Format Default Description
type string session_management_command_result "session_management_command_result" message type
sessionId string session id property
result string command processing result. One of the following: "success" | "failure"
errorMessage string contains error description in case of result: "failure"

Example of payload (generated)

{
  "type": "session_management_command_result",
  "sessionId": "string",
  "result": "success",
  "errorMessage": "string"
}

Tags

sessions
management
command
result

Publish /sessions.{sessionId}

Message

Message to manage session execution.

Payload

Name Title Type Format Default Description
sessionId (Required) string session id property
command (Required) string session management command. One of the following: "start" | "pause" | "stop" | "restart"

Example of payload (generated)

{
  "sessionId": "string",
  "command": "start"
}

Tags

sessions
management
command

/topic/sessions.{sessionId}

Message

Active sesssions status result message.

Payload

Name Title Type Format Default Description
type string session_status "session_status" message type
status object
sessionId string session id property
state string current active session state. One of the following: "running" | "paused" | "completed" | "failed"
errors array (string) contains session errors in case of session state "failed"

Example of payload (generated)

{
  "type": "session_status",
  "status": {
    "sessionId": "string",
    "state": "running",
    "errors": [
      "string"
    ]
  }
}

Tags

session
status

/topic/sessions.{sessionId}.payload

Message

Active sesssions processed payload message.

Payload

Name Title Type Format Default Description
type string session_payload "session_payload" message type
sessionId string session id property
message string session payload message which has been successfully sent to external target system
timestamp number int64 unix format timestamp

Example of payload (generated)

{
  "type": "session_payload",
  "sessionId": "string",
  "message": "string",
  "timestamp": 0
}

Tags

session
payload

/topic/sessions.{sessionId}.analytics

Message

Active sesssion analytics message.

Payload

Name Title Type Format Default Description
type string session_analytics "session_analytics" message type
tag string session analytics tag. One of the following: "sessions_started" | "session_completed" | "session_paused" | "session_failed"
sessionId string session id property
message string session analytics message
timestamp number int64 unix format timestamp

Example of payload (generated)

{
  "type": "session_analytics",
  "tag": "sessions_started",
  "sessionId": "string",
  "message": "string",
  "timestamp": 0
}

Tags

session
analytics

/topic/sessions.{sessionId}.errors

Message

Active sesssion error message.

Payload

Name Title Type Format Default Description
type string session_error "session_error" message type
sessionId string session id property
message string error message
timestamp number int64 unix format timestamp

Example of payload (generated)

{
  "type": "session_error",
  "sessionId": "string",
  "message": "string",
  "timestamp": 0
}

Tags

session
error

Messages

errorMessage

Services unexpected error message.

Payload

Name Title Type Format Default Description
message string error message property

Example of payload (generated)

{
  "message": "string"
}

sessionStatusesCommandMessage

An empty message to trigger provision of all active sessions statuses.

Payload

Name Title Type Format Default Description
Message Payload

sessionManagementCommandMessage

Message to manage session execution.

Payload

Name Title Type Format Default Description
sessionId (Required) string session id property
command (Required) string session management command. One of the following: "start" | "pause" | "stop" | "restart"

Example of payload (generated)

{
  "sessionId": "string",
  "command": "start"
}

sessionManagementCommandResultMessage

Active sesssion managemnt command result.

Payload

Name Title Type Format Default Description
type string session_management_command_result "session_management_command_result" message type
sessionId string session id property
result string command processing result. One of the following: "success" | "failure"
errorMessage string contains error description in case of result: "failure"

Example of payload (generated)

{
  "type": "session_management_command_result",
  "sessionId": "string",
  "result": "success",
  "errorMessage": "string"
}

sessionStatusesCommandResultMessage

Active sesssions status information.

Payload

Name Title Type Format Default Description
type (Required) string sessions_status_command_result "sessions_status_command_result" message type
result string command processing result. One of the following: "success" | "failure"
errorMessage string contains error description in case of result: "failure"
statuses (Required) array (object) active sessions statuses
sessionId string session id property
state string current active session state. One of the following: "running" | "paused" | "completed" | "failed"
errors array (string) contains session errors in case of session state "failed"

Example of payload (generated)

{
  "type": "sessions_status_command_result",
  "result": "success",
  "errorMessage": "string",
  "statuses": [
    {
      "sessionId": "string",
      "state": "running",
      "errors": [
        "string"
      ]
    }
  ]
}

sessionStatusMessage

Active sesssions status result message.

Payload

Name Title Type Format Default Description
type string session_status "session_status" message type
status object
sessionId string session id property
state string current active session state. One of the following: "running" | "paused" | "completed" | "failed"
errors array (string) contains session errors in case of session state "failed"

Example of payload (generated)

{
  "type": "session_status",
  "status": {
    "sessionId": "string",
    "state": "running",
    "errors": [
      "string"
    ]
  }
}

sessionsPayloadMessage

Active sesssions processed payload message.

Payload

Name Title Type Format Default Description
type string session_payload "session_payload" message type
sessionId string session id property
message string session payload message which has been successfully sent to external target system
timestamp number int64 unix format timestamp

Example of payload (generated)

{
  "type": "session_payload",
  "sessionId": "string",
  "message": "string",
  "timestamp": 0
}

sessionsAnalyticsMessage

Active sesssion analytics message.

Payload

Name Title Type Format Default Description
type string session_analytics "session_analytics" message type
tag string session analytics tag. One of the following: "sessions_started" | "session_completed" | "session_paused" | "session_failed"
sessionId string session id property
message string session analytics message
timestamp number int64 unix format timestamp

Example of payload (generated)

{
  "type": "session_analytics",
  "tag": "sessions_started",
  "sessionId": "string",
  "message": "string",
  "timestamp": 0
}

sessionsErrorMessage

Active sesssion error message.

Payload

Name Title Type Format Default Description
type string session_error "session_error" message type
sessionId string session id property
message string error message
timestamp number int64 unix format timestamp

Example of payload (generated)

{
  "type": "session_error",
  "sessionId": "string",
  "message": "string",
  "timestamp": 0
}

Schemas

sessionStatus

Name Title Type Format Default Description
sessionId string session id property
state string current active session state. One of the following: "running" | "paused" | "completed" | "failed"
errors array (string) contains session errors in case of session state "failed"

Example (generated)

{
  "sessionId": "string",
  "state": "running",
  "errors": [
    "string"
  ]
}

commandResult

Name Title Type Format Default Description
commandResult string command processing result. One of the following: "success" | "failure"

Example (generated)

"success"

commandErrorMessage

Name Title Type Format Default Description
commandErrorMessage string contains error description in case of result: "failure"

Example (generated)

"string"