Summary
Retrieve notification replay messages.
Description
Retrieve notification replay messages on a given event stream.
Route
No Northbound API Available
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| eventStream |
string |
yes |
Name of an event stream to retrive notification replay messages. |
| startTime |
string |
yes |
The start time of the replay, in ISO String format e.g. '2020-06-10T22:58:48.655Z' |
| stopTime |
string |
yes |
The stop time of the replay, in ISO String format e.g. '2020-06-10T22:58:48.655Z' |
| options |
object |
yes |
Options for filtering notification replay. |
Copied to Clipboard
{
"eventStream": "ncs-events",
"startTime": "2020-06-10T22:58:48.655Z",
"stopTime": "2020-06-10T22:58:48.655Z",
"options": {
"xpathFilter": {
"xpath": "/ex:event[ex:eventClass='fault' and (ex:severity='minor' or ex:severity='major' or ex:severity='critical')]",
"xmlNamespaces": [
{
"prefix": "ex",
"uri": "http://example.com/event/1.0"
},
{
"prefix": "ex",
"uri": "http://example.com/event/1.0"
},
{
"prefix": "ex",
"uri": "urn:corp:list"
}
]
}
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"eventStream": {
"type": "string",
"examples": [
"ncs-events"
]
},
"startTime": {
"type": "string",
"examples": [
"2020-06-10T22:58:48.655Z"
]
},
"stopTime": {
"type": "string",
"examples": [
"2020-06-10T22:58:48.655Z"
]
},
"options": {
"type": "object",
"properties": {
"xpathFilter": {
"type": "object",
"description": "xpath filter for notification replay",
"properties": {
"xpath": {
"type": "string",
"description": "xpath filter for notification replay",
"examples": [
"/ex:event[ex:eventClass='fault' and (ex:severity='minor' or ex:severity='major' or ex:severity='critical')]"
]
},
"xmlNamespaces": {
"type": "array",
"description": "Array of xmlns for the xpath filter",
"items": {
"type": "object",
"description": "XML namespace",
"properties": {
"prefix": {
"type": "string",
"description": "XML namespace prefix",
"examples": [
"ex"
]
},
"uri": {
"type": "string",
"description": "XML namespace URI",
"examples": [
"http://example.com/event/1.0",
"urn:corp:list"
]
}
}
}
}
}
}
}
}
},
"required": [
"eventStream",
"startTime",
"stopTime",
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
array |
Notification replay messages |
Copied to Clipboard
{
"description": "Notification replay messages",
"type": "array"
}
