Create Symptom Definition

Create Symptom Definition
Create the Symptom Definition

The symptom definition identifier must be null and will be generated by the system.
A symptom definition contains a symptom state, there may only be one symptom state per symptom definition.

Request
URI
POST
https://{api_host}/suite-api/api/symptomdefinitions
COPY
Request Body

The Symptom Definition to create

symptom-definition of type(s) application/json
Required

Show optional properties

{
    "adapterKindKey": "string",
    "name": "string",
    "resourceKindKey": "string",
    "state": {
        "condition": {},
        "severity": "string"
    }
}
{
    "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",
            "value": "string",
            "valueType": "string"
        },
        "severity": "string"
    },
    "waitCycles": 0
}
string
adapterKindKey
Required

The adapter kind identifier for the SymptomDefinition

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

string
id
Optional

The identifier for the SymptomDefinition. Must be null during create.

string
name
Required

The name of the SymptomDefinition

boolean
realtimeMonitoringEnabled
Optional

Indicates whether real-time monitoring is enabled for the symptom or not. (This field is not applicable)

string
resourceKindKey
Required

The resource kind identifier for the SymptomDefinition

object
state
Required

The SymptomState is a product of the severity and a condition. A symptom definition may have one SymptomState per severity level.

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

Authentication
This operation uses the following authentication methods.
Responses
201

The created Symptom Definition

Returns symptom-definition of type(s) application/json 
"symptom-definition Object"
string
adapterKindKey
Required

The adapter kind identifier for the SymptomDefinition

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

string
id
Optional

The identifier for the SymptomDefinition. Must be null during create.

string
name
Required

The name of the SymptomDefinition

boolean
realtimeMonitoringEnabled
Optional

Indicates whether real-time monitoring is enabled for the symptom or not. (This field is not applicable)

string
resourceKindKey
Required

The resource kind identifier for the SymptomDefinition

object
state
Required

The SymptomState is a product of the severity and a condition. A symptom definition may have one SymptomState per severity level.

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


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"adapterKindKey":"string","name":"string","resourceKindKey":"string","state":"object"}' https://{api_host}/suite-api/api/symptomdefinitions
On This Page
Symptoms Operations
GET
Get Symptom Definitions
POST
Create Symptom Definition
PUT
Update Symptom Definition
DELETE
Delete Symptom Definition
GET
Get Symptom Definition By Key
GET
Get Symptoms
POST
Query Symptoms