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

ParametersJSON model

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

EventEvidenceMetadata

ParametersJSON model

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.
eventType	string	The type of the event.
data	Event	Configuration of an event.
endTime	integer	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.

Element	Type	Description
suppressProblem	boolean	The problem detection status during a maintenance: `false`: Problem detection works as usual. `true`: Problem detection is disabled.
frequentEvent	boolean	If `true`, the event happens frequently. A frequent event doesn't raise a problem.
underMaintenance	boolean	If `true`, the event happened while the monitored system was under maintenance.
suppressAlert	boolean	The alerting status during a maintenance: `false`: Alerting works as usual. `true`: Alerting is disabled.
managementZones	ManagementZone[]	A list of all management zones that the event belongs to.
entityId	EntityStub	A short representation of a monitored entity.
eventId	string	The ID of the event.
entityTags	METag[]	A list of tags of the related entity.
eventType	string	The type of the event.
status	string	The status of the event. The element can hold these values `CLOSED` `OPEN`
startTime	integer	The timestamp when the event was raised, in UTC milliseconds.
endTime	integer	The timestamp when the event was closed, in UTC milliseconds. Has the value of `null` if the event is still active.
title	string	The title of the event.
correlationId	string	The correlation ID of the event.
properties	EventProperty[]	A list of event properties.

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 `EntityStub` object

A short representation of a monitored entity.

Element	Type	Description
entityId	EntityId	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.

Element

Type

Description

entityId

EntityId

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 `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 `CONTEXTLESS` value.

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

MaintenanceWindowEvidenceMetadata

ParametersJSON model

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

MetricEvidenceMetadata

ParametersJSON model

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 `null` indicates that the evidence is still open.
unit	string	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

ParametersJSON model

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

ApplicationImpactDto

ParametersJSON model

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

Element	Type	Description
impactType	string	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`
impactedEntity	EntityStub	A short representation of a monitored entity.
estimatedAffectedUsers	integer	The estimated number of affected users.

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

impactedEntity

EntityStub

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	EntityId	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.

Element

Type

Description

entityId

EntityId

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

CustomApplicationImpactDto

ParametersJSON model

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

Element	Type	Description
impactType	string	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`
impactedEntity	EntityStub	A short representation of a monitored entity.
estimatedAffectedUsers	integer	The estimated number of affected users.

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

impactedEntity

EntityStub

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	EntityId	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.

Element

Type

Description

entityId

EntityId

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

MobileImpactDto

ParametersJSON model

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

Element	Type	Description
impactType	string	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`
impactedEntity	EntityStub	A short representation of a monitored entity.
estimatedAffectedUsers	integer	The estimated number of affected users.

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

impactedEntity

EntityStub

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	EntityId	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.

Element

Type

Description

entityId

EntityId

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

ServiceImpactDto

ParametersJSON model

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
}

Problems API v2 - JSON models

Variations of the Evidence object

AVAILABILITY_EVIDENCE

The AvailabilityEvidence object

EVENT

The EventEvidence object

The Event object

The ManagementZone object

The EntityStub object

The EntityId object

The METag object

The EventProperty object

MAINTENANCE_WINDOW

The MaintenanceWindowEvidence object

METRIC

The MetricEvidence object

TRANSACTIONAL

The TransactionalEvidence object

Variations of the Impact object

APPLICATION

The ApplicationImpact object

The EntityStub object

The EntityId object

CUSTOM_APPLICATION

The CustomApplicationImpact object

The EntityStub object

The EntityId object

MOBILE

The MobileImpact object

The EntityStub object

The EntityId object

SERVICE

The ServiceImpact object

Variations of the `Evidence` object

The `AvailabilityEvidence` object

The `EventEvidence` object

The `Event` object

The `ManagementZone` object

The `EntityStub` object

The `EntityId` object

The `METag` object

The `EventProperty` object

The `MaintenanceWindowEvidence` object

The `MetricEvidence` object

The `TransactionalEvidence` object

Variations of the `Impact` object

The `ApplicationImpact` object

The `EntityStub` object

The `EntityId` object

The `CustomApplicationImpact` object

The `EntityStub` object

The `EntityId` object

The `MobileImpact` object

The `EntityStub` object

The `EntityId` object

The `ServiceImpact` object