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

Operations for Composite Conditions

Possible values are : AND, OR,
array of string
symptomId
Optional

Return Symptoms that have the specified list of Symptom identifiers

resource-query
resource-query
Optional

Object used to lookup resources with various filtering criteria

boolean
includeChildrenResources
Optional

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

boolean
activeOnly
Optional

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

boolean
includeAlarmInfo
Optional

Boolean that controls the retrieval of alarm information of the symptom

array of integer
alarmType
Optional

Return Symptoms that have the specified list of Symptom Types

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,
time-range
startTimeRange
Optional

Filter based on matching UTC cancel time

time-range
cancelTimeRange
Optional

Filter based on matching UTC cancel time

array of string
symptomDefinitionId
Optional

Return Symptoms that have the specified list of Symptom Definitions

array of string
statKey
Optional

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

Parameter To