Query Symptoms

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

Request

URI

POST

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

COPY

Query Parameters

integer

page

Optional

Constraints: default: 0

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

integer

pageSize

Optional

Constraints: default: 1000

Expected number of entries per page

Request Body

Query object of the symptom

symptom-query of type(s) application/json

Required

"{\n  \"compositeOperator\" : \"AND\",\n  \"symptomId\" : [ ],\n  \"resource-query\" : {\n    \"resourceId\" : [ \"5748438c-41d5-4397-a59b-efe973674653\" ],\n    \"statKeyInclusive\" : true\n  },\n  \"includeChildrenResources\" : false,\n  \"activeOnly\" : true,\n  \"includeAlarmInfo\" : false,\n  \"alarmType\" : [ ],\n  \"alarmCriticality\" : [ \"CRITICAL\", \"IMMEDIATE\", \"WARNING\", \"INFORMATION\" ],\n  \"symptomDefinitionId\" : [ ],\n  \"statKey\" : [ ]\n}"

string

compositeOperator

Optional

Operations for Composite Conditions

Possible values are : AND, OR,

array of string

symptomId

Optional

Return Symptoms that have the specified list of Symptom identifiers

object

resource-query

Optional

Object used to lookup resources with various filtering criteria

boolean

includeChildrenResources

Optional

Whether to include Symptoms of all the children of resources identified by resourceIds

boolean

activeOnly

Optional

Include Symptoms that are currently Active.
By default, only active Symptoms are included in the result

boolean

includeAlarmInfo

Optional

Boolean that controls the retrieval of alarm information of the symptom

array of integer

alarmType

Optional

Return Symptoms that have the specified list of Symptom Types

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,

object

startTimeRange

Optional

Filter based on matching UTC cancel time

object

cancelTimeRange

Optional

Filter based on matching UTC cancel time

array of string

symptomDefinitionId

Optional

Return Symptoms that have the specified list of Symptom Definitions

array of string

statKey

Optional

Return Symptoms that have been generated because of violations on the Stat Keys specified

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

List of all Symptoms that match the given query

Returns symptoms of type(s) application/json

"{\n  \"symptom\" : [ {\n    \"id\" : \"31eeaeec-82d5-4037-a59b-efed2e7c8e3a\",\n    \"resourceId\" : \"50000000-0000-0000-0000-000000000005\",\n    \"startTimeUTC\" : 1744470254963,\n    \"updateTimeUTC\" : 1744470254963,\n    \"cancelTimeUTC\" : 0,\n    \"kpi\" : false,\n    \"symptomCriticality\" : \"INFORMATION\",\n    \"symptomDefinitionId\" : \"SymptomDefinition-1\",\n    \"message\" : \"symptom message\",\n    \"faultDevices\" : [ ]\n  }, {\n    \"id\" : \"18589dea-9999-1234-abba-f1ee73004dac\",\n    \"resourceId\" : \"50000000-0000-0000-0000-000000000005\",\n    \"startTimeUTC\" : 1744470254963,\n    \"updateTimeUTC\" : 1744470254963,\n    \"cancelTimeUTC\" : 0,\n    \"kpi\" : false,\n    \"symptomCriticality\" : \"INFORMATION\",\n    \"symptomDefinitionId\" : \"SymptomDefinition-1\",\n    \"message\" : \"symptom message\",\n    \"faultDevices\" : [ ]\n  } ]\n}"

object

pageInfo

Optional

Represents page information for a paged result

array of object

links

Optional

Collection of links

array of object

symptom

Optional

List of Symptoms

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/suite-api/api/symptoms/query

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

200 Response Body

Symptoms Operations

GET

Get Symptom Definitions

PUT