Filters - Incident Filter Details - RESTful API

Summary:

Return details of, modify, or delete a specified incident filter. Note, from Entuity v21.0 upwards, you can manage incident filters within config sets (see Config Sets - Incident Filters). This 'Incident Filters' call will only apply to managing filters on servers that are not part of a config set.

URL:

http(s)://{server hostname}/api/incidentFilters/{filterId}

Methods summary

GET Method detail

PUT Method detail

DELETE Method detail

Methods summary

• GET Method - shows detailed information about the filter.
• PUT Method - modifies the parameters of the filter.
• DELETE Method - deletes the filter.

GET Method detail

Shows detailed information about the selected incident filter.

Response:

Examples:

INPUT
curl -u admin:admin https://localhost/api/incidentFilters/2?media=json

OUTPUT
{
  "name" : "A",
  "selectedNames" : [
    "AP Antenna Host Count Abnormality",
    "AP Not Associated With Controller"
  ],
  "systemFilter" : false,
  "passIP" : false
}

INPUT
curl -u admin:admin https://localhost/api/domainFilters/2?media=xml

OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<eventFilterInfo systemFilter="false" passIP="true" name="A">
  <selectedNames>
    <filterName>AvailMonitor High Latency</filterName>
    <filterName>AvailMonitor Application Problem</filterName>
  </selectedNames>
</eventFilterInfo>

PUT Method detail

Modifies the selected incident filter.

Request:

Examples:

INPUT
curl -u admin:admin https://localhost/api/incidentFilters/2?media=json -X PUT -H "content-type:application/json" -d \
'{
  "name" : "B",
  "selectedNames" : [
    "AP Antenna Host Count Abnormality",
    "AP Antenna Power Change Frequency High",
    "AP Not Associated With Controller"
  ],
  "systemFilter" : false,
  "passIP" : true
}'

OUTPUT
{
  "name" : "B",
  "selectedNames" : [
    "AP Antenna Host Count Abnormality",
    "AP Antenna Power Change Frequency High",
    "AP Not Associated With Controller"
  ],
  "systemFilter" : false,
  "passIP" : true
}

INPUT
curl -u admin:admin https://localhost/api/incidentFilters/2?media=xml-X PUT -H "content-type:application/xml" -d \
'<eventFilterInfo systemFilter="false" passIP="false" name="B">
  <selectedNames>
    <filterName>AP Antenna Host Count Abnormality</filterName>
    <filterName>AP Antenna Power Change Frequency High</filterName>
    <filterName>AP Not Associated With Controller</filterName>
  </selectedNames>
</eventFilterInfo>'

OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<eventFilterInfo systemFilter="false" passIP="false" name="B">
  <selectedNames>
    <filterName>AP Antenna Host Count Abnormality</filterName>
    <filterName>AP Antenna Power Change Frequency High</filterName>
    <filterName>AP Not Associated With Controller</filterName>
  </selectedNames>
</eventFilterInfo>

DELETE Method detail

Deletes the selected incident filter.

Request:

No additional parameters needed.

Response:

“OK” message if operation was successful, and an error description otherwise.

Examples:

INPUT
curl -u admin:admin https://localhost/api/incidentFilters/2?media=json -X DELETE "content-type:application/json"

OUTPUT
{
  "message" : "OK"
}

INPUT
curl -u admin:admin https://localhost/api/incidentFilters/2?media=xml -X DELETE

OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<statusInfo>
    <message>OK</message>
</statusInfo>