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.
Evidence objectThe Evidence object is the base for evidence of a problem. The actual set of fields depends on the type of the evidence.
AvailabilityEvidence objectThe availability evidence of the problem.
Indicates an entity that has been unavailable during the problem lifespan and that might be related to the root cause.
The end time of the evidence, in UTC milliseconds.
{"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}
EventEvidence objectThe event evidence of the problem.
An event that occurred during the problem lifespan that might be related to the root cause.
The end timestamp of the event, in UTC milliseconds.
Has -1 value, if the event is still active.
The ID of the event.
The type of the event.
Event objectConfiguration of an event.
The correlation ID of the event.
The timestamp when the event was closed, in UTC milliseconds.
Has the value of null if the event is still active.
The ID of the event.
The type of the event.
If true, the event happens frequently.
A frequent event doesn't raise a problem.
The timestamp when the event was raised, in UTC milliseconds.
The status of the event.
CLOSEDOPENThe alerting status during a maintenance:
false: Alerting works as usual.true: Alerting is disabled.The problem detection status during a maintenance:
false: Problem detection works as usual.true: Problem detection is disabled.The title of the event.
If true, the event happened while the monitored system was under maintenance.
EntityStub objectA short representation of a monitored entity.
The name of the entity.
Not included in the response in case no entity with the relevant ID was found.
EntityId objectA short representation of a monitored entity.
The ID of the entity.
The type of the entity.
METag objectThe tag of a monitored entity.
The origin of the tag, such as AWS or Cloud Foundry.
Custom tags use the CONTEXTLESS value.
The key of the tag.
The string representation of the tag.
The value of the tag.
ManagementZone objectA short representation of a management zone.
The ID of the management zone.
The name of the management zone.
EventProperty objectA property of an event.
The key of the event property.
The value of the event property.
{"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"}
MaintenanceWindowEvidence objectThe maintenance window evidence of the problem.
The maintenance window during which the problem occurred.
The end time of the evidence, in UTC milliseconds.
The ID of the related maintenance window.
{"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}
MetricEvidence objectThe metric evidence of the problem.
A change of metric behavior that indicates the problem and/or is its root cause.
The end time of the evidence, in UTC milliseconds.
The value null indicates that the evidence is still open.
The ID of the metric.
The unit of the metric.
AmpereBillionBitBitPerHourBitPerMinuteBitPerSecondByteBytePerHourBytePerMinuteBytePerSecondCoresCountDayDecibelMilliWattGibiByteGibiBytePerHourGibiBytePerMinuteGibiBytePerSecondGigaGigaByteGigaBytePerHourGigaBytePerMinuteGigaBytePerSecondHertzHourKibiByteKibiBytePerHourKibiBytePerMinuteKibiBytePerSecondKiloKiloByteKiloBytePerHourKiloBytePerMinuteKiloBytePerSecondKiloMetrePerHourMSUMebiByteMebiBytePerHourMebiBytePerMinuteMebiBytePerSecondMegaMegaByteMegaBytePerHourMegaBytePerMinuteMegaBytePerSecondMetrePerHourMetrePerSecondMicroSecondMilliCoresMilliSecondMilliSecondPerMinuteMillionMinuteMonthNanoSecondNanoSecondPerMinuteNotApplicablePerHourPerMinutePerSecondPercentPixelPromilleRatioSecondStateTrillionUnspecifiedVoltWattWeekYearThe metric's value after the problem start.
The metric's value before the problem start.
{"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}
TransactionalEvidence objectThe transactional evidence of the problem.
A behavior of a metric in an transaction that indicates the problem and/or is its root cause.
The end time of the evidence, in UTC milliseconds
The unit of the metric.
The metric's value after the problem start.
The metric's value before the problem start.
{"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}
Impact objectThe Impact object is the base for impacts of a problem. The actual set of fields depends on the type of the impact.
ApplicationImpact objectAnalysis of problem impact to an application.
The estimated number of affected users.
Defines the actual set of fields depending on the value. See one of the following objects:
SERVICE -> ServiceImpactAPPLICATION -> ApplicationImpactMOBILE -> MobileImpactCUSTOM_APPLICATION -> CustomApplicationImpactAPPLICATIONCUSTOM_APPLICATIONMOBILESERVICEEntityStub objectA short representation of a monitored entity.
The name of the entity.
Not included in the response in case no entity with the relevant ID was found.
EntityId objectA short representation of a monitored entity.
The ID of the entity.
The type of the entity.
{"impactType": "APPLICATION","impactedEntity": {"entityId": {"id": "string","type": "string"},"name": "string"},"estimatedAffectedUsers": 5}
CustomApplicationImpact objectAnalysis of problem impact to a custom application.
The estimated number of affected users.
Defines the actual set of fields depending on the value. See one of the following objects:
SERVICE -> ServiceImpactAPPLICATION -> ApplicationImpactMOBILE -> MobileImpactCUSTOM_APPLICATION -> CustomApplicationImpactAPPLICATIONCUSTOM_APPLICATIONMOBILESERVICEEntityStub objectA short representation of a monitored entity.
The name of the entity.
Not included in the response in case no entity with the relevant ID was found.
EntityId objectA short representation of a monitored entity.
The ID of the entity.
The type of the entity.
{"impactType": "CUSTOM_APPLICATION","impactedEntity": {"entityId": {"id": "string","type": "string"},"name": "string"},"estimatedAffectedUsers": 5}
MobileImpact objectAnalysis of problem impact to a mobile application.
The estimated number of affected users.
Defines the actual set of fields depending on the value. See one of the following objects:
SERVICE -> ServiceImpactAPPLICATION -> ApplicationImpactMOBILE -> MobileImpactCUSTOM_APPLICATION -> CustomApplicationImpactAPPLICATIONCUSTOM_APPLICATIONMOBILESERVICEEntityStub objectA short representation of a monitored entity.
The name of the entity.
Not included in the response in case no entity with the relevant ID was found.
EntityId objectA short representation of a monitored entity.
The ID of the entity.
The type of the entity.
{"impactType": "MOBILE","impactedEntity": {"entityId": {"id": "string","type": "string"},"name": "string"},"estimatedAffectedUsers": 5}
ServiceImpact objectAnalysis of problem impact to a service.
The number of potentially impacted services.
{"impactType": "SERVICE","impactedEntity": {"entityId": {"id": "string","type": "string"},"name": "string"},"estimatedAffectedUsers": 5,"numberOfPotentiallyAffectedServiceCalls": 50}