Event Actions

https://api.app.wnology.io/applications/APPLICATION_ID/events/EVENT_ID

Below are the various requests that can be performed against the Event resource, as well as the expected parameters and the potential responses.

Delete

Deletes an event

Method And Url

DELETE https://api.app.wnology.io/applications/APPLICATION_ID/events/EVENT_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, event.*, or event.delete.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EVENT_ID	ID associated with the event	575ed0de7ae143cd83dc4aa5

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.app.wnology.io/applications/APPLICATION_ID/events/EVENT_ID

Successful Responses

Code	Type	Description
200	Success	If event was successfully deleted

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if event was not found

Get

Retrieves information on an event

Method And Url

GET https://api.app.wnology.io/applications/APPLICATION_ID/events/EVENT_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, event.*, or event.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EVENT_ID	ID associated with the event	575ed0de7ae143cd83dc4aa5

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.app.wnology.io/applications/APPLICATION_ID/events/EVENT_ID

Successful Responses

Code	Type	Description
200	Event	Event information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if event was not found

Patch

Updates information about an event

Method And Url

PATCH https://api.app.wnology.io/applications/APPLICATION_ID/events/EVENT_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, event.*, or event.patch.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EVENT_ID	ID associated with the event	575ed0de7ae143cd83dc4aa5

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Event Patch schema. For example, the following would be a valid body for this request:

{
  "state": "acknowledged",
  "comment": "Looking into this issue"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"state":"acknowledged","comment":"Looking into this issue"}' \
    https://api.app.wnology.io/applications/APPLICATION_ID/events/EVENT_ID

Successful Responses

Code	Type	Description
200	Event	Updated event information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if event is not found

Schemas

Error

Schema for errors returned by the API

Error Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
(root){} 2 keys
type:"NotFound"
message:"Application was not found"

Event

Schema for a single Event

Event Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 18 keys
▶
id:{} 2 keys
▶
eventId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
sourceType:{} 2 keys
▶
sourceId:{} 2 keys
▶
sourceName:{} 3 keys
▶
level:{} 2 keys
▶
state:{} 2 keys
▶
subject:{} 3 keys
▶
message:{} 2 keys
data:{} 0 keys
▶
deviceId:{} 2 keys
▶
deviceName:{} 3 keys
▶
disableTagChangeTracking:{} 1 key
▶
eventTags:{} 3 keys
▶
updates:{} 3 keys

Event Example

▶
(root){} 16 keys
id:"575ed0de7ae143cd83dc4aa5"
eventId:"575ed0de7ae143cd83dc4aa5"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
sourceType:"user"
sourceId:"575ed70c7ae143cd83dc4aa9"
sourceName:"hello@example.com"
level:"info"
state:"new"
subject:"Power levels critical"
message:"Power levels on device 432 have surpassed critical thresholds"
updates:[] 0 items
deviceId:"575ecf887ae143cd83dc4aa2"
deviceName:"My Device"
▶
eventTags:{} 1 key

Event Patch

Schema for the body of an Event modification request

Event Patch Schema

▶
(root){} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 7 keys
▶
state:{} 2 keys
▶
level:{} 2 keys
▶
subject:{} 3 keys
▶
deviceId:{} 1 key
▶
comment:{} 2 keys
data:{} 0 keys
▶
eventTags:{} 3 keys
additionalProperties:false

Event Patch Example

▶
(root){} 2 keys
state:"acknowledged"
comment:"Looking into this issue"

Success

Schema for reporting a successful operation

Success Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 1 key
▶
success:{} 2 keys

Success Example

▶
(root){} 1 key
success:true