• Home
  • Dynatrace API
  • Environment
  • Problems v2
  • JSON models

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

AvailabilityEvidenceMetadata

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.

ElementTypeDescription
endTimeinteger

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

EventEvidenceMetadata

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.

ElementTypeDescription
eventIdstring

The ID of the event.

eventTypestring

The type of the event.

dataEvent

Configuration of an event.

endTimeinteger

The end timestamp of the event, in UTC milliseconds.

Has -1 value, if the event is still active.

The Event object

Configuration of an event.

ElementTypeDescription
suppressProblemboolean

The problem detection status during a maintenance:

  • false: Problem detection works as usual.
  • true: Problem detection is disabled.
frequentEventboolean

If true, the event happens frequently.

A frequent event doesn't raise a problem.

underMaintenanceboolean

If true, the event happened while the monitored system was under maintenance.

suppressAlertboolean

The alerting status during a maintenance:

  • false: Alerting works as usual.
  • true: Alerting is disabled.
managementZonesManagementZone[]

A list of all management zones that the event belongs to.

entityIdEntityStub

A short representation of a monitored entity.

eventIdstring

The ID of the event.

entityTagsMETag[]

A list of tags of the related entity.

eventTypestring

The type of the event.

statusstring

The status of the event.

The element can hold these values
  • CLOSED
  • OPEN
startTimeinteger

The timestamp when the event was raised, in UTC milliseconds.

endTimeinteger

The timestamp when the event was closed, in UTC milliseconds.

Has the value of null if the event is still active.

titlestring

The title of the event.

correlationIdstring

The correlation ID of the event.

propertiesEventProperty[]

A list of event properties.

The ManagementZone object

A short representation of a management zone.

ElementTypeDescription
namestring

The name of the management zone.

idstring

The ID of the management zone.

The EntityStub object

A short representation of a monitored entity.

ElementTypeDescription
entityIdEntityId

A short representation of a monitored entity.

namestring

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.

ElementTypeDescription
idstring

The ID of the entity.

typestring

The type of the entity.

The METag object

The tag of a monitored entity.

ElementTypeDescription
stringRepresentationstring

The string representation of the tag.

valuestring

The value of the tag.

keystring

The key of the tag.

contextstring

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

The EventProperty object

A property of an event.

ElementTypeDescription
valuestring

The value of the event property.

keystring

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

MaintenanceWindowEvidenceMetadata

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.

ElementTypeDescription
maintenanceWindowConfigIdstring

The ID of the related maintenance window.

endTimeinteger

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

MetricEvidenceMetadata

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.

ElementTypeDescription
valueBeforeChangePointnumber

The metric's value before the problem start.

valueAfterChangePointnumber

The metric's value after the problem start.

metricIdstring

The ID of the metric.

endTimeinteger

The end time of the evidence, in UTC milliseconds.

The value null indicates that the evidence is still open.

unitstring

The unit of the metric.

The element can hold these values
  • Billion
  • 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
  • KiloMetrePerHour
  • MSU
  • MebiByte
  • MebiBytePerHour
  • MebiBytePerMinute
  • MebiBytePerSecond
  • Mega
  • MegaByte
  • MegaBytePerHour
  • MegaBytePerMinute
  • MegaBytePerSecond
  • MetrePerHour
  • MetrePerSecond
  • MicroSecond
  • MilliCores
  • MilliSecond
  • MilliSecondPerMinute
  • Million
  • Minute
  • Month
  • NanoSecond
  • NanoSecondPerMinute
  • NotApplicable
  • PerHour
  • PerMinute
  • PerSecond
  • Percent
  • Pixel
  • Promille
  • Ratio
  • Second
  • State
  • Trillion
  • Unspecified
  • Week
  • Year
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

TransactionalEvidenceMetadata

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.

ElementTypeDescription
valueBeforeChangePointnumber

The metric's value before the problem start.

valueAfterChangePointnumber

The metric's value after the problem start.

endTimeinteger

The end time of the evidence, in UTC milliseconds

unitstring

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

ApplicationImpactDto

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.

ElementTypeDescription
impactTypestring

Defines the actual set of fields depending on the value. See one of the following objects:

  • SERVICE -> ServiceImpact
  • APPLICATION -> ApplicationImpact
  • MOBILE -> MobileImpact
  • CUSTOM_APPLICATION -> CustomApplicationImpact
The element can hold these values
  • APPLICATION
  • CUSTOM_APPLICATION
  • MOBILE
  • SERVICE
impactedEntityEntityStub

A short representation of a monitored entity.

estimatedAffectedUsersinteger

The estimated number of affected users.

The EntityStub object

A short representation of a monitored entity.

ElementTypeDescription
entityIdEntityId

A short representation of a monitored entity.

namestring

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.

ElementTypeDescription
idstring

The ID of the entity.

typestring

The type of the entity.

json
{ "impactType": "APPLICATION", "impactedEntity": { "entityId": { "id": "string", "type": "string" }, "name": "string" }, "estimatedAffectedUsers": 5 }

CUSTOM_APPLICATION

CustomApplicationImpactDto

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.

ElementTypeDescription
impactTypestring

Defines the actual set of fields depending on the value. See one of the following objects:

  • SERVICE -> ServiceImpact
  • APPLICATION -> ApplicationImpact
  • MOBILE -> MobileImpact
  • CUSTOM_APPLICATION -> CustomApplicationImpact
The element can hold these values
  • APPLICATION
  • CUSTOM_APPLICATION
  • MOBILE
  • SERVICE
impactedEntityEntityStub

A short representation of a monitored entity.

estimatedAffectedUsersinteger

The estimated number of affected users.

The EntityStub object

A short representation of a monitored entity.

ElementTypeDescription
entityIdEntityId

A short representation of a monitored entity.

namestring

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.

ElementTypeDescription
idstring

The ID of the entity.

typestring

The type of the entity.

json
{ "impactType": "CUSTOM_APPLICATION", "impactedEntity": { "entityId": { "id": "string", "type": "string" }, "name": "string" }, "estimatedAffectedUsers": 5 }

MOBILE

MobileImpactDto

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.

ElementTypeDescription
impactTypestring

Defines the actual set of fields depending on the value. See one of the following objects:

  • SERVICE -> ServiceImpact
  • APPLICATION -> ApplicationImpact
  • MOBILE -> MobileImpact
  • CUSTOM_APPLICATION -> CustomApplicationImpact
The element can hold these values
  • APPLICATION
  • CUSTOM_APPLICATION
  • MOBILE
  • SERVICE
impactedEntityEntityStub

A short representation of a monitored entity.

estimatedAffectedUsersinteger

The estimated number of affected users.

The EntityStub object

A short representation of a monitored entity.

ElementTypeDescription
entityIdEntityId

A short representation of a monitored entity.

namestring

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.

ElementTypeDescription
idstring

The ID of the entity.

typestring

The type of the entity.

json
{ "impactType": "MOBILE", "impactedEntity": { "entityId": { "id": "string", "type": "string" }, "name": "string" }, "estimatedAffectedUsers": 5 }

SERVICE

ServiceImpactDto

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.

ElementTypeDescription
numberOfPotentiallyAffectedServiceCallsinteger

The number of potentially impacted services.

json
{ "impactType": "SERVICE", "impactedEntity": { "entityId": { "id": "string", "type": "string" }, "name": "string" }, "estimatedAffectedUsers": 5, "numberOfPotentiallyAffectedServiceCalls": 50 }