Query Symptoms Using POST

The list of Symptoms returned is a collection that supports pagination.

Request

URI

POST

https://{api_host}/api/symptoms/query

COPY

Query Parameters

integer

page

Optional

Page number from which data needs to be displayed (0-based)

integer

pageSize

Optional

Expected number of entries per page

Request Body

Query object of the symptom

symptom-query of type(s) application/json

Required

{
    "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

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

Authentication

This operation uses the following authentication methods.

vRealizeOpsToken

Responses

200

List of all Symptoms that match the given query

Returns symptoms of type(s) application/json

{
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "pageInfo": {
        "page": 0,
        "pageSize": 0,
        "sortBy": "string",
        "sortOrder": "string",
        "totalCount": 0
    },
    "symptom": [
        {
            "alarmInfo": "string",
            "cancelTimeUTC": 0,
            "extension": {
                "anyObjects": [
                    {}
                ]
            },
            "id": "string",
            "kpi": false,
            "links": [
                {
                    "description": "string",
                    "href": "string",
                    "name": "string",
                    "rel": "string"
                }
            ],
            "message": "string",
            "resourceId": "string",
            "startTimeUTC": 0,
            "statKey": "string",
            "symptomCriticality": "string",
            "symptomDefinitionId": "string",
            "updateTimeUTC": 0
        }
    ]
}

array of link

links

Optional

Collection of links

page-info

pageInfo

Optional

Represents page information for a paged result

array of symptom

symptom

Optional

List of Symptoms