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

array of string
alertNoteId
Optional

Filter based on Alert Note identifiers

array of string
alertNoteType
Optional

Filter based on alert note types

Possible values are : SYSTEM, USER, UNKNOWN,
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) Defaults to AND. Note: backend only supports AND currently

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

Filter based on note contents

time-range
creationTimeRange
Optional

creationTimeRange

array of string
userName
Optional

Filter based on user names

Parameter To