Problems API v2 - 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.
The actual set of fields depends on the type of the evidence. Find the list of actual objects in the description of the evidenceType field or see Problems API v2 - JSON models.
Element | Type | Description |
---|---|---|
endTime | integer | The end time of the evidence, in UTC milliseconds. |
json{
"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.
The actual set of fields depends on the type of the evidence. Find the list of actual objects in the description of the evidenceType field or see Problems API v2 - JSON models.
Element | Type | Description |
---|---|---|
eventId | string | The ID of the event. |
endTime | integer | The end timestamp of the event, in UTC milliseconds. Has |
eventType | string | The type of the event. |
data | Event | Configuration of an event. |
The Event
object
Configuration of an event.
Element | Type | Description |
---|---|---|
suppressAlert | boolean | The alerting status during a maintenance:
|
suppressProblem | boolean | The problem detection status during a maintenance:
|
frequentEvent | boolean | If A frequent event doesn't raise a problem. |
underMaintenance | boolean | If |
entityId | Entity | A short representation of a monitored entity. |
managementZones | Management | A list of all management zones that the event belongs to. |
entityTags | M | A list of tags of the related entity. |
eventId | string | The ID of the event. |
endTime | integer | The timestamp when the event was closed, in UTC milliseconds. Has the value of |
title | string | The title of the event. |
correlationId | string | The correlation ID of the event. |
eventType | string | The type of the event. |
status | string | The status of the event. The element can hold these values
|
startTime | integer | The timestamp when the event was raised, in UTC milliseconds. |
properties | Event | A list of event properties. |
The EntityStub
object
A short representation of a monitored entity.
Element | Type | Description |
---|---|---|
entityId | Entity | A short representation of a monitored entity. |
name | string | The name of the entity. Not included in the response in case no entity with the relevant ID was found. |
The EntityId
object
A short representation of a monitored entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the entity. |
type | string | The type of the entity. |
The ManagementZone
object
A short representation of a management zone.
Element | Type | Description |
---|---|---|
name | string | The name of the management zone. |
id | string | The ID of the management zone. |
The METag
object
The tag of a monitored entity.
Element | Type | Description |
---|---|---|
stringRepresentation | string | The string representation of the tag. |
value | string | The value of the tag. |
key | string | The key of the tag. |
context | string | The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the |
The EventProperty
object
A property of an event.
Element | Type | Description |
---|---|---|
value | string | The value of the event property. |
key | string | The key of the event property. |
json{
"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.
The actual set of fields depends on the type of the evidence. Find the list of actual objects in the description of the evidenceType field or see Problems API v2 - JSON models.
Element | Type | Description |
---|---|---|
maintenanceWindowConfigId | string | The ID of the related maintenance window. |
endTime | integer | The end time of the evidence, in UTC milliseconds. |
json{
"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.
The actual set of fields depends on the type of the evidence. Find the list of actual objects in the description of the evidenceType field or see Problems API v2 - JSON models.
Element | Type | Description |
---|---|---|
valueBeforeChangePoint | number | The metric's value before the problem start. |
valueAfterChangePoint | number | The metric's value after the problem start. |
metricId | string | The ID of the metric. |
endTime | integer | The end time of the evidence, in UTC milliseconds. The value |
unit | string | The unit of the metric. The element can hold these values
|
json{
"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.
The actual set of fields depends on the type of the evidence. Find the list of actual objects in the description of the evidenceType field or see Problems API v2 - JSON models.
Element | Type | Description |
---|---|---|
valueBeforeChangePoint | number | The metric's value before the problem start. |
valueAfterChangePoint | number | The metric's value after the problem start. |
endTime | integer | The end time of the evidence, in UTC milliseconds |
unit | string | The unit of the metric. |
json{
"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.
The actual set of fields depends on the type of the impact. Find the list of actual objects in the description of the impactType field or see Problems API v2 - JSON models.
Element | Type | Description |
---|---|---|
impactType | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
impactedEntity | Entity | A short representation of a monitored entity. |
estimatedAffectedUsers | integer | The estimated number of affected users. |
The EntityStub
object
A short representation of a monitored entity.
Element | Type | Description |
---|---|---|
entityId | Entity | A short representation of a monitored entity. |
name | string | The name of the entity. Not included in the response in case no entity with the relevant ID was found. |
The EntityId
object
A short representation of a monitored entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the entity. |
type | string | The type of the entity. |
json{
"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.
The actual set of fields depends on the type of the impact. Find the list of actual objects in the description of the impactType field or see Problems API v2 - JSON models.
Element | Type | Description |
---|---|---|
impactType | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
impactedEntity | Entity | A short representation of a monitored entity. |
estimatedAffectedUsers | integer | The estimated number of affected users. |
The EntityStub
object
A short representation of a monitored entity.
Element | Type | Description |
---|---|---|
entityId | Entity | A short representation of a monitored entity. |
name | string | The name of the entity. Not included in the response in case no entity with the relevant ID was found. |
The EntityId
object
A short representation of a monitored entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the entity. |
type | string | The type of the entity. |
json{
"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.
The actual set of fields depends on the type of the impact. Find the list of actual objects in the description of the impactType field or see Problems API v2 - JSON models.
Element | Type | Description |
---|---|---|
impactType | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
impactedEntity | Entity | A short representation of a monitored entity. |
estimatedAffectedUsers | integer | The estimated number of affected users. |
The EntityStub
object
A short representation of a monitored entity.
Element | Type | Description |
---|---|---|
entityId | Entity | A short representation of a monitored entity. |
name | string | The name of the entity. Not included in the response in case no entity with the relevant ID was found. |
The EntityId
object
A short representation of a monitored entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the entity. |
type | string | The type of the entity. |
json{
"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.
The actual set of fields depends on the type of the impact. Find the list of actual objects in the description of the impactType field or see Problems API v2 - JSON models.
Element | Type | Description |
---|---|---|
numberOfPotentiallyAffectedServiceCalls | integer | The number of potentially impacted services. |
json{
"impactType": "SERVICE",
"impactedEntity": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"estimatedAffectedUsers": 5,
"numberOfPotentiallyAffectedServiceCalls": 50
}