v1

latestOpenAPI 3.0.42026-08-064075233.0 KB

Events

Get event by id

Returns an event with the specified id.

get/api/events/{eventId}

Path parameters

eventIdstring uuid required

The identifier for the event that we want to get.

Response

idstring uuid

The identifier of the event.

typestring nullable

levelstring nullable

timestampstring date-time

The time of the event.

subjectstring nullable

The subject of the event. A short summary of what has happened.

messagestring nullable

The message of the event. A more detailed description of what has happened.

applicationstring nullable

organizationIdstring uuid

The identifier of the organization.

userIdstring uuid nullable

Optional. For events that are related to a user this property contains that user id.

userNamestring nullable

Optional. For events that are related to a user this property contains that user name.

edgenodeIdstring uuid nullable

Optional. For events that are related to a node this property contains that node id.

edgenodeNamestring nullable

Optional. For events that are related to a node this property contains that node name.

softwareVersionstring nullable

Optional. For events that are related to a node and software version is of interest, this property contains that software version.

flowIdstring uuid nullable

Optional. For events that are related to a flow this property contains that flow id.

parameterIdstring nullable

Optional. For events that are related to a parameter this property contains that parameter id.

flowNamestring nullable

Optional. For events that are related to a flow this property contains that flow name.

flowVersionstring nullable

Optional. For events that are related to a flow this property contains that flow version.

moduleIdstring uuid nullable

Optional. For events that are related to a module this property contains that module id.

moduleVersionstring nullable

Optional. For events that are related to a module this property contains that module version.

moduleNamestring nullable

Optional. For events that are related to a module this property contains that module name.

rolestring nullable

statestring nullable

Optional. For events that are related to a node state this property contains that state. Available values are online, offline.

lastHeardFromstring date-time

Optional. For events that are related to a node state this property contains the last time the node was heard from.

flowDefinitionIdstring uuid nullable

Optional. For events that are related to a flow definition this property contains that flow definition id.

flowDeploymentIdstring uuid nullable

Optional. For events that are related to a flow deployment this property contains that flow deployment id.

flowDefinitionNamestring nullable

Optional. For events that are related to a flow definition this property contains that flow definition name.

priorityinteger

The priority of the event as an integer.

Example response

{
  "id": "00ec431b-0f2b-4f4e-9cc9-1af9231a8584",
  "timestamp": "2024-09-24T09:33:38.013347Z",
  "subject": "My subject",
  "message": "My message",
  "organizationId": "8c84e649-1669-428c-8506-47b0815180e8",
  "createdBy": {
    "type": "User",
    "id": "256f791c-fbc0-4435-9429-d291227f6577",
    "name": "My User"
  },
  "userId": "256f791c-fbc0-4435-9429-d291227f6577",
  "userName": "My User",
  "edgenodeId": "88cd62fa-6cb1-43d3-b243-787bd6ec8041",
  "edgenodeName": "MyNode",
  "softwareVersion": "2.5.6",
  "flowId": "955a5c39-e3fe-4f30-ac78-e1648f18f491",
  "parameterId": "My parameter",
  "flowName": "My flow",
  "flowVersion": "1",
  "moduleId": "74f1d6b6-02dc-4604-aa67-1b585e90b14c",
  "moduleVersion": "1.0.0",
  "moduleName": "My module",
  "state": "online",
  "lastHeardFrom": "2024-09-24T09:33:38.013347Z",
  "flowDefinitionId": "0bb6b120-468a-4c7b-b121-65e88e990c9d",
  "flowDeploymentId": "2896e0bd-ef25-4315-9e61-4bebfb53612b",
  "flowDefinitionName": "My flow definition"
}