Problems API - JSON models
Some JSON models of the Problems v2 API vary depending on the type of the model. The JSON models for each variation are listed below.
Variations of the Evidence object
The Evidence object is the base for evidence of a problem. The actual set of fields depends on the type of the evidence.
AVAILABILITY_EVIDENCE
The AvailabilityEvidenceMetadata object
An evidence of a root cause.
| Element | Type | Description | Required |
|---|---|---|---|
| evidenceType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| displayName | string |
The evidence friendly display name. |
optional |
| entity | EntityStub | optional | |
| groupingEntity | EntityStub | optional | |
| rootCauseRelevant | boolean |
Marks if the evidence is part of the root cause (true) or not (false). |
optional |
| startTime | integer |
The start time of the evidence, in UTC milliseconds. |
optional |
| endTime | integer |
The end time of the evidence, in UTC milliseconds. |
optional |
The EntityStub object
A stub representation of a monitored entity, containing its name.
| Element | Type | Description | Required |
|---|---|---|---|
| entityId | EntityId | optional | |
| name | string |
The name of the entity. Not included in the response in case no entity with the relevant ID was found. |
optional |
The EntityId object
A short representation of a monitored entity.
| Element | Type | Description | Required |
|---|---|---|---|
| id | string |
The ID of the entity. |
optional |
| type | string |
The type of the entity. |
optional |
Possible values
Possible values for the evidenceType element:
- AVAILABILITY_EVIDENCE
- EVENT
- MAINTENANCE_WINDOW
- METRIC
- TRANSACTIONAL
{
"evidenceType": "AVAILABILITY_EVIDENCE",
"displayName": "string",
"entity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"groupingEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"rootCauseRelevant": true,
"startTime": 1602500000000,
"endTime": 1602600000000
}
EVENT
The EventEvidenceMetadata object
An evidence of a root cause.
| Element | Type | Description | Required |
|---|---|---|---|
| evidenceType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| displayName | string |
The evidence friendly display name. |
optional |
| entity | EntityStub | optional | |
| groupingEntity | EntityStub | optional | |
| rootCauseRelevant | boolean |
Marks if the evidence is part of the root cause (true) or not (false). |
optional |
| startTime | integer |
The start time of the evidence, in UTC milliseconds. |
optional |
| eventType | string |
The type of the event. |
optional |
| eventId | string |
The event identifier. |
optional |
The EntityStub object
A stub representation of a monitored entity, containing its name.
| Element | Type | Description | Required |
|---|---|---|---|
| entityId | EntityId | optional | |
| name | string |
The name of the entity. Not included in the response in case no entity with the relevant ID was found. |
optional |
The EntityId object
A short representation of a monitored entity.
| Element | Type | Description | Required |
|---|---|---|---|
| id | string |
The ID of the entity. |
optional |
| type | string |
The type of the entity. |
optional |
Possible values
Possible values for the evidenceType element:
- AVAILABILITY_EVIDENCE
- EVENT
- MAINTENANCE_WINDOW
- METRIC
- TRANSACTIONAL
{
"evidenceType": "EVENT",
"displayName": "string",
"entity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"groupingEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"rootCauseRelevant": true,
"startTime": 1602511312869,
"eventId": "string",
"eventType": "string"
}
MAINTENANCE_WINDOW
The MaintenanceWindowEvidenceMetadata object
An evidence of a root cause.
| Element | Type | Description | Required |
|---|---|---|---|
| evidenceType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| displayName | string |
The evidence friendly display name. |
optional |
| entity | EntityStub | optional | |
| groupingEntity | EntityStub | optional | |
| rootCauseRelevant | boolean |
Marks if the evidence is part of the root cause (true) or not (false). |
optional |
| startTime | integer |
The start time of the evidence, in UTC milliseconds. |
optional |
| maintenanceWindowConfigId | string |
The ID of the maintenance window config. |
optional |
The EntityStub object
A stub representation of a monitored entity, containing its name.
| Element | Type | Description | Required |
|---|---|---|---|
| entityId | EntityId | optional | |
| name | string |
The name of the entity. Not included in the response in case no entity with the relevant ID was found. |
optional |
The EntityId object
A short representation of a monitored entity.
| Element | Type | Description | Required |
|---|---|---|---|
| id | string |
The ID of the entity. |
optional |
| type | string |
The type of the entity. |
optional |
Possible values
Possible values for the evidenceType element:
- AVAILABILITY_EVIDENCE
- EVENT
- MAINTENANCE_WINDOW
- METRIC
- TRANSACTIONAL
{
"evidenceType": "MAINTENANCE_WINDOW",
"displayName": "string",
"entity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"groupingEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"rootCauseRelevant": true,
"startTime": 1602500000000,
"maintenanceWindowConfigId": "string",
"endTime": 1602600000000
}
METRIC
The MetricEvidenceMetadata object
An evidence of a root cause.
| Element | Type | Description | Required |
|---|---|---|---|
| evidenceType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| displayName | string |
The evidence friendly display name. |
optional |
| entity | EntityStub | optional | |
| groupingEntity | EntityStub | optional | |
| rootCauseRelevant | boolean |
Marks if the evidence is part of the root cause (true) or not (false). |
optional |
| startTime | integer |
The start time of the evidence, in UTC milliseconds. |
optional |
| valueBeforeChangePoint | number |
The value before the metric's change point. |
optional |
| valueAfterChangePoint | number |
The value after the metric's change point. |
optional |
| metricId | string |
The ID of the metric. |
optional |
| endTime | integer |
The end time of the evidence, in UTC milliseconds. Null value indicates unknown end time |
optional |
| unit | string |
The unit of the metric. The unit element can hold these values. |
optional |
The EntityStub object
A stub representation of a monitored entity, containing its name.
| Element | Type | Description | Required |
|---|---|---|---|
| entityId | EntityId | optional | |
| name | string |
The name of the entity. Not included in the response in case no entity with the relevant ID was found. |
optional |
The EntityId object
A short representation of a monitored entity.
| Element | Type | Description | Required |
|---|---|---|---|
| id | string |
The ID of the entity. |
optional |
| type | string |
The type of the entity. |
optional |
Possible values
Possible values for the unit element:
- Bit
- BitPerHour
- BitPerMinute
- BitPerSecond
- Byte
- BytePerHour
- BytePerMinute
- BytePerSecond
- Cores
- Count
- Day
- DecibelMilliWatt
- GibiByte
- Giga
- GigaByte
- Hour
- KibiByte
- KibiBytePerHour
- KibiBytePerMinute
- KibiBytePerSecond
- Kilo
- KiloByte
- KiloBytePerHour
- KiloBytePerMinute
- KiloBytePerSecond
- MebiByte
- MebiBytePerHour
- MebiBytePerMinute
- MebiBytePerSecond
- Mega
- MegaByte
- MegaBytePerHour
- MegaBytePerMinute
- MegaBytePerSecond
- MicroSecond
- MilliCores
- MilliSecond
- MilliSecondPerMinute
- Minute
- Month
- NanoSecond
- NanoSecondPerMinute
- NotApplicable
- PerHour
- PerMinute
- PerSecond
- Percent
- Pixel
- Promille
- Ratio
- Second
- State
- Unspecified
- Week
- Year
Possible values for the evidenceType element:
- AVAILABILITY_EVIDENCE
- EVENT
- MAINTENANCE_WINDOW
- METRIC
- TRANSACTIONAL
{
"evidenceType": "METRIC",
"displayName": "string",
"entity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"groupingEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"rootCauseRelevant": true,
"startTime": 1602500000000,
"metricId": "string",
"valueBeforeChangePoint": 2,
"valueAfterChangePoint": 3,
"unit": "Count",
"endTime": 1602600000000
}
TRANSACTIONAL
The TransactionalEvidenceMetadata object
An evidence of a root cause.
| Element | Type | Description | Required |
|---|---|---|---|
| evidenceType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| displayName | string |
The evidence friendly display name. |
optional |
| entity | EntityStub | optional | |
| groupingEntity | EntityStub | optional | |
| rootCauseRelevant | boolean |
Marks if the evidence is part of the root cause (true) or not (false). |
optional |
| startTime | integer |
The start time of the evidence, in UTC milliseconds. |
optional |
| valueBeforeChangePoint | number |
The value before the metric's change point. |
optional |
| valueAfterChangePoint | number |
The value after the metric's change point. |
optional |
| endTime | integer |
The end time of the evidence, in UTC milliseconds |
optional |
| unit | string |
The unit of the metric. |
optional |
The EntityStub object
A stub representation of a monitored entity, containing its name.
| Element | Type | Description | Required |
|---|---|---|---|
| entityId | EntityId | optional | |
| name | string |
The name of the entity. Not included in the response in case no entity with the relevant ID was found. |
optional |
The EntityId object
A short representation of a monitored entity.
| Element | Type | Description | Required |
|---|---|---|---|
| id | string |
The ID of the entity. |
optional |
| type | string |
The type of the entity. |
optional |
Possible values
Possible values for the evidenceType element:
- AVAILABILITY_EVIDENCE
- EVENT
- MAINTENANCE_WINDOW
- METRIC
- TRANSACTIONAL
{
"evidenceType": "TRANSACTIONAL",
"displayName": "string",
"entity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"groupingEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"rootCauseRelevant": true,
"startTime": 1602500000000,
"valueBeforeChangePoint": 2,
"valueAfterChangePoint": 3,
"unit": "Count",
"endTime": 1602600000000
}