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 AvailabilityEvidence 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 display name of the evidence. |
optional |
| entity | EntityStub | optional | |
| groupingEntity | EntityStub | optional | |
| rootCauseRelevant | boolean |
The evidence is ( |
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 short representation of a monitored entity.
| 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 |
{
"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 EventEvidence 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 display name of the evidence. |
optional |
| entity | EntityStub | optional | |
| groupingEntity | EntityStub | optional | |
| rootCauseRelevant | boolean |
The evidence is ( |
optional |
| startTime | integer |
The start time of the evidence, in UTC milliseconds. |
optional |
| eventId | string |
The ID of the event. |
optional |
| eventType | string |
The type of the event. |
optional |
The EntityStub object
A short representation of a monitored entity.
| 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 |
{
"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 MaintenanceWindowEvidence 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 display name of the evidence. |
optional |
| entity | EntityStub | optional | |
| groupingEntity | EntityStub | optional | |
| rootCauseRelevant | boolean |
The evidence is ( |
optional |
| startTime | integer |
The start time of the evidence, in UTC milliseconds. |
optional |
| maintenanceWindowConfigId | string |
The ID of the related maintenance window. |
optional |
| endTime | integer |
The end time of the evidence, in UTC milliseconds. |
optional |
The EntityStub object
A short representation of a monitored entity.
| 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 |
{
"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 MetricEvidence 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 display name of the evidence. |
optional |
| entity | EntityStub | optional | |
| groupingEntity | EntityStub | optional | |
| rootCauseRelevant | boolean |
The evidence is ( |
optional |
| startTime | integer |
The start time of the evidence, in UTC milliseconds. |
optional |
| valueAfterChangePoint | number |
The metric's value after the problem start. |
optional |
| valueBeforeChangePoint | number |
The metric's value before the problem start. |
optional |
| metricId | string |
The ID of the metric. |
optional |
| unit | string |
The unit of the metric.
|
optional |
| endTime | integer |
The end time of the evidence, in UTC milliseconds. The value |
optional |
The EntityStub object
A short representation of a monitored entity.
| 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 |
{
"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 TransactionalEvidence 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 display name of the evidence. |
optional |
| entity | EntityStub | optional | |
| groupingEntity | EntityStub | optional | |
| rootCauseRelevant | boolean |
The evidence is ( |
optional |
| startTime | integer |
The start time of the evidence, in UTC milliseconds. |
optional |
| valueAfterChangePoint | number |
The metric's value after the problem start. |
optional |
| valueBeforeChangePoint | number |
The metric's value before the problem start. |
optional |
| unit | string |
The unit of the metric. |
optional |
| endTime | integer |
The end time of the evidence, in UTC milliseconds |
optional |
The EntityStub object
A short representation of a monitored entity.
| 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 |
{
"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
}
Variations of the Impact object
The Impact object is the base for impacts of a problem. The actual set of fields depends on the type of the impact.
APPLICATION
The ApplicationImpact object
The impact analysis of the problem on other entities/users.
| Element | Type | Description | Required |
|---|---|---|---|
| impactType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
optional |
| impactedEntity | EntityStub | optional | |
| estimatedAffectedUsers | integer |
The estimated number of affected users. |
optional |
The EntityStub object
A short representation of a monitored entity.
| 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 |
{
"impactType": "APPLICATION",
"impactedEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"estimatedAffectedUsers": 5
}
CUSTOM_APPLICATION
The CustomApplicationImpact object
The impact analysis of the problem on other entities/users.
| Element | Type | Description | Required |
|---|---|---|---|
| impactType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
optional |
| impactedEntity | EntityStub | optional | |
| estimatedAffectedUsers | integer |
The estimated number of affected users. |
optional |
The EntityStub object
A short representation of a monitored entity.
| 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 |
{
"impactType": "CUSTOM_APPLICATION",
"impactedEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"estimatedAffectedUsers": 5
}
MOBILE
The MobileImpact object
The impact analysis of the problem on other entities/users.
| Element | Type | Description | Required |
|---|---|---|---|
| impactType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
optional |
| impactedEntity | EntityStub | optional | |
| estimatedAffectedUsers | integer |
The estimated number of affected users. |
optional |
The EntityStub object
A short representation of a monitored entity.
| 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 |
{
"impactType": "MOBILE",
"impactedEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"estimatedAffectedUsers": 5
}
SERVICE
The ServiceImpact object
The impact analysis of the problem on other entities/users.
| Element | Type | Description | Required |
|---|---|---|---|
| impactType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
optional |
| impactedEntity | EntityStub | optional | |
| estimatedAffectedUsers | integer |
The estimated number of affected users. |
optional |
| numberOfPotentiallyAffectedServiceCalls | integer |
The number of potentially impacted services. |
optional |
The EntityStub object
A short representation of a monitored entity.
| 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 |
{
"impactType": "SERVICE",
"impactedEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"estimatedAffectedUsers": 5,
"numberOfPotentiallyAffectedServiceCalls": 50
}