Get Symptom Definition By Key
Get Symptom Definition specified by id
Request
URI
GET
https://{api_host}/suite-api/api/symptomdefinitions/{id}
COPY
Path Parameters
string
id
Required
The id of the Symptom Definition
Responses
200
The Symptom Definition
Returns
symptom-definition
of type(s)
application/json
{
"id": "string",
"name": "string",
"adapterKindKey": "string",
"resourceKindKey": "string",
"waitCycles": 0,
"cancelCycles": 0,
"realtimeMonitoringEnabled": false,
"state": {
"severity": "string",
"condition": {}
}
}
string
id
Optional
The identifier for the SymptomDefinition. Must be null during create.
string
name
Required
The name of the SymptomDefinition
string
adapterKindKey
Required
The adapter kind identifier for the SymptomDefinition
string
resourceKindKey
Required
The resource kind identifier for the SymptomDefinition
integer As int32
As int32
waitCycles
Optional
Constraints:
minimum: 1
The number of consecutive cycles to wait when a symptom state is true before a symptom is triggered
integer As int32
As int32
cancelCycles
Optional
Constraints:
minimum: 1
The number of consecutive cycles to wait when a symptom state is false before a symptom is cancelled
boolean
realtimeMonitoringEnabled
Optional
Indicates whether real-time monitoring is enabled for the symptom or not. (This field is only visible in SaaS)
object
state
Required
The SymptomState is a product of the severity and a condition. A symptom definition may have one SymptomState per severity level.
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/symptomdefinitions/{id}