symptom-query

symptom-query
symptom-query

Query for Symptoms using various criteria. Composition of filtering criteria controlled via the compositeOperator property. Pagination of the Symptoms that are returned can be controlled via the PageInfo object. Sorting of the Symptoms is specified via the SymptomField object and the SortOrder object controls the order in which the Symptoms are sorted. If a sort field is not specified but pagination is requested the Symptoms will be sorted by the alarmId property.

JSON Example 
{
    "activeOnly": false,
    "alarmCriticality": [
        "string"
    ],
    "alarmType": [
        0
    ],
    "cancelTimeRange": {
        "endTime": 0,
        "startTime": 0
    },
    "compositeOperator": "string",
    "includeAlarmInfo": false,
    "includeChildrenResources": false,
    "resource-query": {
        "adapterInstanceId": [
            "string"
        ],
        "adapterKind": [
            "string"
        ],
        "collectorId": [
            0
        ],
        "collectorName": [
            "string"
        ],
        "credentialId": [
            "string"
        ],
        "includeRelated": "string",
        "maintenanceScheduleId": [
            "string"
        ],
        "name": [
            "string"
        ],
        "parentId": [
            "string"
        ],
        "propertyConditions": {
            "conditions": [
                {
                    "doubleValue": "number",
                    "key": "string",
                    "operator": "string",
                    "stringValue": "string"
                }
            ],
            "conjunctionOperator": "string"
        },
        "propertyName": "string",
        "propertyValue": "string",
        "recentlyAdded": 0,
        "regex": [
            "string"
        ],
        "resourceHealth": [
            "string"
        ],
        "resourceId": [
            "string"
        ],
        "resourceKind": [
            "string"
        ],
        "resourceState": [
            "string"
        ],
        "resourceStatus": [
            "string"
        ],
        "resourceTag": [
            {
                "category": "string",
                "name": "string"
            }
        ],
        "statConditions": {
            "conditions": [
                {
                    "doubleValue": "number",
                    "key": "string",
                    "operator": "string",
                    "stringValue": "string"
                }
            ],
            "conjunctionOperator": "string"
        },
        "statKey": "string",
        "statKeyInclusive": false,
        "statKeyLowerBound": "number",
        "statKeyUpperBound": "number"
    },
    "startTimeRange": {
        "endTime": 0,
        "startTime": 0
    },
    "statKey": [
        "string"
    ],
    "symptomDefinitionId": [
        "string"
    ],
    "symptomId": [
        "string"
    ]
}
boolean
activeOnly
Optional

Include Symptoms that are currently Active. By default, only active Symptoms are included in the result

array of string
alarmCriticality
Optional

Return Symptoms that have the specified list of Symptom Criticalities

Possible values are : UNKNOWN, NONE, INFORMATION, WARNING, IMMEDIATE, CRITICAL, AUTO,
array of integer
alarmType
Optional

Return Symptoms that have the specified list of Symptom Types

time-range
cancelTimeRange
Optional

cancelTimeRange

string
compositeOperator
Optional

Indicates the composition of the filtering criteria.
Either all of the filtering criteria apply together (AND operation) or any of the filtering criteria could be applied (OR operation) NOTE: OR is currently not supported.

Possible values are : AND, OR,
boolean
includeAlarmInfo
Optional

Boolean that controls the retrieval of alarm information of the symptom

boolean
includeChildrenResources
Optional

Whether to include Symptoms of all the children of resources identified by resourceIds

resource-query
resource-query
Optional

Object used to lookup resources with various filtering criteria

time-range
startTimeRange
Optional

startTimeRange

array of string
statKey
Optional

Return Symptoms that have been generated because of violations on the Stat Keys specified

array of string
symptomDefinitionId
Optional

Return Symptoms that have the specified list of Symptom Definitions

array of string
symptomId
Optional

Return Symptoms that have the specified list of Symptom identifiers
Parameter To