Get Symptoms
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}/suite-api/api/symptoms
COPY
Query Parameters
string of
array
resourceId
Optional
Array of resource identifiers for which Symptoms need to be looked up
boolean
activeOnly
Optional
Constraints:
default: true
Boolean that determines whether the results should include inactive Symptoms
boolean
includeAlarmInfo
Optional
Constraints:
default: false
Boolean that controls the retrieval of alarm information of the symptom
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
Responses
200
List of Symptoms in the system
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\" : 1744470256299,\n \"updateTimeUTC\" : 1744470256299,\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\" : 1744470256299,\n \"updateTimeUTC\" : 1744470256299,\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 -H 'Authorization: <value>' https://{api_host}/suite-api/api/symptoms