GET /events/actions/{action_name}
Use this method to return information about a specific event action.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/events/actions/{action_name}
where {action_name} is the name of the action to be retrieved. To obtain the action name, use the GET /events/actions method.
Query parameters
None
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 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 | Description | ||
|---|---|---|---|---|
| eventFilter | Object | Information about the event filter | ||
| fields | Array of objects | Fields to filter on and the associated REGEX string to filter. The event field must match one of the supported fields in the event class (see Filtering events). | ||
| field | String | Fields to filter on This field must match one of the supported fields in the event class. For more information about filtering events, see Filtering events. | ||
| value | String | Associated REGEX string to filter | ||
| filtertype | String | The type of filter. This can be one of the following values.
| ||
| name | String | Name used to identify the event action Note This name must be unique. | ||
| persistent | String | Indicates whether this event action entry should be saved across restarts of the XClarity Administrator | ||
| port | Integer | Port to use for this event action The default port is 8080. | ||
| uri | String | The action or function to call when an incoming event is found to match the filter. The action must be a REST API supporting a POST call to the URI with the JSON object form of the event in the body. | ||
The following example is returned if the request is successful.
{
"eventFilter": {
"fields": [{
"field": "eventID",
"value": "FQXHMDM0001I|FQXHMDI0002I|FQXHMDI0001I|FQXHMDI0003A|FQXHMDI0003G|FQXHMDI0004A|
FQXHMDI0101I|FQXHMDI0102I|FQXHMDI0103G|FQXHMDI0104G |FQXHMDI0024I|0EA04001|
0EA04002|0EA04003|0EA04004|0E004001|0E004002|0E004003|0E004004|0E004005|0E004006|
0E004007|0E004008|0E004009|0E004009||0E00400B|0E00400C|0E00400D|0E00400E|00284001|
00284002|806F012B210100FF"
}],
"filterType": "FIELDREGEXOR"
},
"persistent": "false",
"name": "updates_event_handler",
"port": "808",
"uri": "/stgupdates/inventory/events"
}
Give documentation feedback