GET /events/notifications/{pusher_type}/subscriptions/{subscription_ID}/filters/{filter_name}
Use this method to return information about a specific event filter that is associated with a specific subscription.
If you are logged in as a user with one of the following roles, information that is associated with all subscriptions is returned; otherwise, information associated with subscriptions for only the logged-in user is returned.
- lxc-admin
- lxc-supervisor
- lxc-security-admin
- lxc-sysmgr
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/events/notifications/{pusher_type}/subscriptions/{subscription_ID}/filters/{filter_name}
where
{pusher_type} is the type of push notification service. This can be one of the following values.
- AndroidPusher. Google device push service
- iOSPusher. Apple device push service
- WebSocketPusher. WebSocket servic
TipBecause the subscription ID is unique, specifying the type of push notification service is optional{subscription_ID} is the UID of the subscription to be retrieved. To obtain the subscription UID, use the GET /events/notifications/subscriptions method.
{filter_name} is the name of the event filter to be retrieved. To obtain the event filter name, use the GET /events/notifications/subscriptions/{subscription_id}/filters method.
Query parameters
None
Request body
None
Response codes
Code | Description | Comments |
---|---|---|
200 | OK | The request completed successfully. |
400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
401 | Unauthorized | The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body. |
500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
Attributes | Type | Definition | |||
---|---|---|---|---|---|
eventFilter | Array of objects | Information about the types of events to filter | |||
filter | Object | Information about each event filter | |||
categories | Array of strings | Event categories. This can be one of the following values.
| |||
componentIDs | Array of strings | List of component IDs. If empty, all components are accepted. | |||
sourceIDs | Array of strings | List of source IDs. If empty, all sources are accepted. | |||
typeSeverity | Array of objects | Event severity and type If both sourceIDs and componentsIDs are empty, all events that match the typeSeverity filter is forwarded. | |||
severity | String | Event severity. This can be one of the following values.
| |||
type | String | Event type. This can be one of the following values.
| |||
eventFilterDescription | String | Event filter description | |||
eventFilterName | String | Event filter name | |||
isDeletable | Boolean | Indicates whether the event filter can be deleted. | |||
isEditable | Boolean | Indicates whether this event filter can be modified | |||
isUsed | Boolean | Indicates whether this event filter is used by at least one subscription | |||
lockedPredefinedFilter | Boolean | Indicates whether this is a predefined event filter that is provided by default by XClarity Administrator | |||
matchEveryCoreEvent | Boolean | Indicates whether this event filter accepts all core events | |||
matchEverySystem | Boolean | Indicates whether this event filter must match every event from every managed device | |||
matchEverything | Boolean | Indicates whether this event filter matches all events | |||
name | String | User-defined name of the event filter. This must be unique for all filters. |
The following example is returned if the request is successful.
[{
eventFilter: {
filter: {
typeSeverity: [{
severity: "MAJOR",
type: "UNKNOWN"
},
................{
severity: "FATAL",
type: "SWITCH"
}],
sourceIDs: ["FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
"500C0FF286F98000"],
categories: ["WARRANTY",
"GENERAL"],
componentIDs: ["FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
"500C0FF286F98000"]
}
},
eventFilterDescription: "",
eventFilterName: "example2",
isDeletable: true,
isEditable: true,
isUsed: true,
matchEveryCoreEvent: false,
matchEverySystem: false,
matchEverything: false,
}]
Give documentation feedback