alert-notes-query

alert-notes-query
alert-notes-query

Query for alert notes by various criteria.
Composition of filtering criteria controlled via the compositeOperator property.
For Pagination see PageInfo
For sorting see AlertNoteField and SortOrder enumerations.
If a sort field is not specified but pagination is requested the Alert notes will be
sorted by the alertNoteId field.

JSON Example
{
    "compositeOperator": "string",
    "alertNoteId": [
        "string"
    ],
    "alert-query": {
        "compositeOperator": "string",
        "alertId": [
            "string"
        ],
        "alertName": "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"
                }
            ]
        },
        "activeOnly": false,
        "alertTypeSubtype": [
            {
                "type": 0,
                "subtype": [
                    0
                ]
            }
        ],
        "alertCriticality": [
            "string"
        ],
        "alertStatus": [
            "string"
        ],
        "alertImpact": [
            "string"
        ],
        "alertDefinitionId": [
            "string"
        ],
        "alertControlState": [
            "string"
        ],
        "startTimeRange": {
            "startTime": 0,
            "endTime": 0
        },
        "updateTimeRange": {
            "startTime": 0,
            "endTime": 0
        },
        "cancelTimeRange": {
            "startTime": 0,
            "endTime": 0
        },
        "includeChildrenResources": false,
        "extractOwnerName": false,
        "userId": "string",
        "userName": "string",
        "resourceKind": "string",
        "groupingCondition": "string",
        "groupId": "string"
    },
    "creationTimeRange": {
        "startTime": 0,
        "endTime": 0
    },
    "userName": [
        "string"
    ],
    "alertNoteType": [
        "string"
    ],
    "content": [
        "string"
    ]
}
string
compositeOperator
Optional

Operations for Composite Conditions

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

Filter based on Alert Note identifiers

alert-query
alert-query
Required

Query for alerts by various criteria.
Composition of filtering criteria controlled via the compositeOperator property.
For Pagination see PageInfo
For sorting see AlertField and SortOrder enumerations.
If a sort field is not specified but pagination is requested the Alerts will be
sorted by the alertId field.

time-range
creationTimeRange
Optional

Filter based on matching UTC cancel time

array of string
userName
Optional

Filter based on user names

array of string
alertNoteType
Optional

Filter based on alert note types

Possible values are : SYSTEM, USER, UNKNOWN,
array of string
content
Optional

Filter based on note contents

Parameter To