/event/list
- Vijayganesh Sivaprakasam
List events
Request
HTTP Method: POST
Content Type: application/json
Parameters
Property | Type | Description |
|---|---|---|
| integer(int64) | configuration ID to list events for (optional) (non-negative) |
{
"params": {
"configuration_id": 1
}
}Response
HTTP Status: 200
Content Type: application/json
Response
Property | Type | Description |
|---|---|---|
| object of type | error response |
| object of type | event/list response |
| boolean | response with error or not |
error_response
Property | Type | Description |
|---|---|---|
| string | error message |
event_list_response
Property | Type | Description |
|---|---|---|
| array of event | list of events |
event
Property | Type | Description |
|---|---|---|
| integer(int64) | configuration ID (non-negative) |
| string | configuration name |
| string | event body |
| string(date-time) | event created time in UTC |
| string | event ID |
| string | event group |
| string | event issued by component |
| boolean | whether this event is superseded by a more-recent event for the same configuration |
| string | event title |
| string | event type (possible values: 'Success', 'Error', 'Warning' and 'Info') |
{
"error": {
"message": "string"
},
"result": {
"events": [
{
"body": "string",
"configuration_id": 1,
"configuration_name": "string",
"created": "2024-07-31T13:57:42.000123456Z",
"event_id": "string",
"group": "string",
"issued_by": "string",
"superseded": false,
"title": "string",
"type": "Success"
}
]
},
"successful": true
}HTTP Status: 400
Content Type: application/json
Response
Property | Type | Description |
|---|---|---|
| object of type | error response |
| boolean | always false |
error_response
Property | Type | Description |
|---|---|---|
| string | error message |
{
"error": {
"message": "string"
},
"successful": false
}