Get Symptom Definitions Using GET

NOTE: When making an XML request, make sure the statKey field does not contain any key name with spaces.

Request

URI

GET

https://{api_host}/api/symptomdefinitions

COPY

Query Parameters

string

adapterKind

Optional

The adapter kind identifier of the symptom definitions to search for

string of array

Optional

The identifier(s) of the symptom definitions to search for. Exact match.

string

name

Optional

The substring of the symptom definition's name to search for. Case-insensitive.

integer

page

Optional

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

integer

pageSize

Optional

Expected number of entries per page

string

resourceKind

Optional

The resource kind identifier of the symptom definitions to search for

Authentication

This operation uses the following authentication methods.

vRealizeOpsToken

Responses

200

The list of Symptom Definitions

Returns symptom-definitions 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
    },
    "symptomDefinitions": [
        {
            "adapterKindKey": "string",
            "cancelCycles": 0,
            "id": "string",
            "name": "string",
            "realtimeMonitoringEnabled": false,
            "resourceKindKey": "string",
            "state": {
                "condition": {
                    "instanced": false,
                    "key": "string",
                    "operator": "string",
                    "settingValue": "string",
                    "targetKey": "string",
                    "thresholdType": "string"
                },
                "severity": "string"
            },
            "waitCycles": 0
        }
    ]
}

array of link

links

Optional

Collection of links

page-info

pageInfo

Optional

Represents page information for a paged result

array of symptom-definition

symptomDefinitions

Optional

The collection of symptom definitions