Get Symptoms Using GET

Optionally these Symptoms can be looked up for a specific set of Resources and/or can include Symptoms that are no longer active. The list of Symptoms returned is a collection that supports pagination.

Request

URI

GET

https://{api_host}/api/symptoms

COPY

Query Parameters

boolean

activeOnly

Optional

Boolean that determines whether the results should include inactive Symptoms

boolean

includeAlarmInfo

Optional

Boolean that controls the retrieval of alarm information of the symptom

integer

page

Optional

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

integer

pageSize

Optional

Expected number of entries per page

string of array

resourceId

Optional

Array of resource identifiers for which Symptoms need to be looked up

Authentication

This operation uses the following authentication methods.

vRealizeOpsToken

Responses

200

List of Symptoms in the system

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