Push Event By Adapter Kind Key

Push Event By Adapter Kind Key

If the adapter kind specified is not present in the system, it will be created dynamically. However,
if the adapter kind specified does already exist, then it must be of OPENAPI adapter kind type.
Also the API sanitizes the Push Adapter Kind key by removing invalid characters (e.g.: Embedded HTML & JS)

Request
URI
POST
https://{api_host}/suite-api/api/events/adapterkinds/{adapterKind}
COPY
Path Parameters
string
adapterKind
Required

The adapter kind key of the adapter source

Request Body

The event object

event of type(s) application/json
Required

Show optional properties

{
    "eventType": "string",
    "resourceId": "string",
    "message": "string"
}
"{\n  \"eventType\" : \"NOTIFICATION\",\n  \"resourceId\" : \"6fe466cf-c588-433d-a5dc-2d23a3d4bcb0\",\n  \"startTimeUTC\" : 946685500000,\n  \"cancelTimeUTC\" : 0,\n  \"message\" : \"There is a problem somewhere nearby.\",\n  \"severity\" : \"NONE\",\n  \"managedExternally\" : true\n}"
string
eventType
Required

Represents the type of an Event.
All values are valid for the field eventType in the Event object.
When used in the creation of a SymptomDefinition the following restrictions are
applicable for the Conditions that are defined as part of a Symptom Definition.

Possible values are : CHANGE, NOTIFICATION, RESOURCE_DOWN, SYSTEM_DEGRADATION, AVAILABILITY_DOWN, AVAILABILITY_EXCEPTION, AVAILABILITY_NOT_COLLECTING, HARD_THRESHOLD, DIAGNOSTIC,
string As uuid As uuid
resourceId
Required

The id of the resource for the event

integer As int64 As int64
startTimeUTC
Optional
Constraints: minimum: 946684800000

The start time for the event in UTC.
This time must be after >= 946684800000L, or January 1, 2000. Default is 946684800000L.
Value is ignored for Change events.

integer As int64 As int64
cancelTimeUTC
Optional

Indicates that an event has been cancelled. For an externally managed event a new event with
the same message value must be sent with a cancelTime in order to cancel the
event.

string
message
Required

Event message, the message identifies the event in the system.

string
severity
Optional

The Criticality level

Possible values are : UNKNOWN, NONE, INFORMATION, WARNING, IMMEDIATE, CRITICAL, AUTO,
string
key
Optional

The StatKey for the condition of the HardThreshold event

string
htType
Optional

The type of Metric Event or Metric Event Condition

Possible values are : EQUAL, NOT_EQUAL, ABOVE, BELOW,
string
diagnosticSubType
Optional

The subtype of Diagnostic Event

Possible values are : HEALTH, LOG, HISTORY, SNAPSHOT, WORKLOAD, TROUBLESHOOT, UNKNOWN,
string
notificationSubType
Optional

The subtype of Notification Event

Possible values are : LOG, UNKNOWN,
number As double As double
value
Optional

The current value (not the expected value) of the metric for the HardThreshold event

boolean
keyIndicator
Optional

Whether the HardThreshold event is a key performance indicator
True indicates it is a KPI. False otherwise.

boolean
managedExternally
Optional

If set to true, this event shall persist across collection cycles until another event is pushed
to change the status.
If set to false, this event will be cancelled during the next collection cycle if it is not pushed again

Authentication
This operation uses the following authentication methods.
Responses
200

The Event is added successfully

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"eventType:"string","message:"string","resourceId:"string"}' https://{api_host}/suite-api/api/events/adapterkinds/{adapterKind}
On This Page
Events Operations
POST
Push Event
POST
Push Events
POST
Push Events By Adapter Kind Key
POST
Push Event By Adapter Kind Key