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 `Evidence` 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	Required
evidenceType	string	Defines the actual set of fields depending on the value. See one of the following objects: `EVENT` -> EventEvidence `METRIC` -> MetricEvidence `TRANSACTIONAL` -> TransactionalEvidence `MAINTENANCE_WINDOW` -> MaintenanceWindowEvidence `AVAILABILITY_EVIDENCE` -> AvailabilityEvidence The element can hold these values `AVAILABILITY_EVIDENCE` `EVENT` `MAINTENANCE_WINDOW` `METRIC` `TRANSACTIONAL`	required
displayName	string	The display name of the evidence.	required
entity	EntityStub	A short representation of a monitored entity.	required
groupingEntity	EntityStub	A short representation of a monitored entity.	optional
rootCauseRelevant	boolean	The evidence is (`true`) or is not (`false`) a part of the root cause.	required
startTime	integer	The start time of the evidence, in UTC milliseconds.	required

The `EntityStub` object

A short representation of a monitored entity.

Element	Type	Description	Required
entityId	EntityId	A short representation of a monitored entity.	optional
name	string	The name of the entity. Not included in the response in case no entity with the relevant ID was found.	optional

Element

Type

Description

Required

entityId

EntityId

A short representation of a monitored entity.

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

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 `Evidence` 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	Required
evidenceType	string	Defines the actual set of fields depending on the value. See one of the following objects: `EVENT` -> EventEvidence `METRIC` -> MetricEvidence `TRANSACTIONAL` -> TransactionalEvidence `MAINTENANCE_WINDOW` -> MaintenanceWindowEvidence `AVAILABILITY_EVIDENCE` -> AvailabilityEvidence The element can hold these values `AVAILABILITY_EVIDENCE` `EVENT` `MAINTENANCE_WINDOW` `METRIC` `TRANSACTIONAL`	required
displayName	string	The display name of the evidence.	required
entity	EntityStub	A short representation of a monitored entity.	required
groupingEntity	EntityStub	A short representation of a monitored entity.	optional
rootCauseRelevant	boolean	The evidence is (`true`) or is not (`false`) a part of the root cause.	required
startTime	integer	The start time of the evidence, in UTC milliseconds.	required

The `EntityStub` object

A short representation of a monitored entity.

Element	Type	Description	Required
entityId	EntityId	A short representation of a monitored entity.	optional
name	string	The name of the entity. Not included in the response in case no entity with the relevant ID was found.	optional

Element

Type

Description

Required

entityId

EntityId

A short representation of a monitored entity.

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

The `Event` object

Configuration of an event.

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

The `METag` object

The tag of a monitored entity.

Element	Type	Description	Required
stringRepresentation	string	The string representation of the tag.	optional
value	string	The value of the tag.	optional
key	string	The key of the tag.	optional
context	string	The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the `CONTEXTLESS` value.	optional

The `ManagementZone` object

A short representation of a management zone.

Element	Type	Description	Required
name	string	The name of the management zone.	optional
id	string	The ID of the management zone.	optional

The `EventProperty` object

A property of an event.

Element	Type	Description	Required
value	string	The value of the event property.	optional
key	string	The key of the event property.	optional

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 `Evidence` 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	Required
evidenceType	string	Defines the actual set of fields depending on the value. See one of the following objects: `EVENT` -> EventEvidence `METRIC` -> MetricEvidence `TRANSACTIONAL` -> TransactionalEvidence `MAINTENANCE_WINDOW` -> MaintenanceWindowEvidence `AVAILABILITY_EVIDENCE` -> AvailabilityEvidence The element can hold these values `AVAILABILITY_EVIDENCE` `EVENT` `MAINTENANCE_WINDOW` `METRIC` `TRANSACTIONAL`	required
displayName	string	The display name of the evidence.	required
entity	EntityStub	A short representation of a monitored entity.	required
groupingEntity	EntityStub	A short representation of a monitored entity.	optional
rootCauseRelevant	boolean	The evidence is (`true`) or is not (`false`) a part of the root cause.	required
startTime	integer	The start time of the evidence, in UTC milliseconds.	required

The `EntityStub` object

A short representation of a monitored entity.

Element	Type	Description	Required
entityId	EntityId	A short representation of a monitored entity.	optional
name	string	The name of the entity. Not included in the response in case no entity with the relevant ID was found.	optional

Element

Type

Description

Required

entityId

EntityId

A short representation of a monitored entity.

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

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 `Evidence` 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	Required
evidenceType	string	Defines the actual set of fields depending on the value. See one of the following objects: `EVENT` -> EventEvidence `METRIC` -> MetricEvidence `TRANSACTIONAL` -> TransactionalEvidence `MAINTENANCE_WINDOW` -> MaintenanceWindowEvidence `AVAILABILITY_EVIDENCE` -> AvailabilityEvidence The element can hold these values `AVAILABILITY_EVIDENCE` `EVENT` `MAINTENANCE_WINDOW` `METRIC` `TRANSACTIONAL`	required
displayName	string	The display name of the evidence.	required
entity	EntityStub	A short representation of a monitored entity.	required
groupingEntity	EntityStub	A short representation of a monitored entity.	optional
rootCauseRelevant	boolean	The evidence is (`true`) or is not (`false`) a part of the root cause.	required
startTime	integer	The start time of the evidence, in UTC milliseconds.	required

The `EntityStub` object

A short representation of a monitored entity.

Element	Type	Description	Required
entityId	EntityId	A short representation of a monitored entity.	optional
name	string	The name of the entity. Not included in the response in case no entity with the relevant ID was found.	optional

Element

Type

Description

Required

entityId

EntityId

A short representation of a monitored entity.

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

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 `Evidence` 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	Required
evidenceType	string	Defines the actual set of fields depending on the value. See one of the following objects: `EVENT` -> EventEvidence `METRIC` -> MetricEvidence `TRANSACTIONAL` -> TransactionalEvidence `MAINTENANCE_WINDOW` -> MaintenanceWindowEvidence `AVAILABILITY_EVIDENCE` -> AvailabilityEvidence The element can hold these values `AVAILABILITY_EVIDENCE` `EVENT` `MAINTENANCE_WINDOW` `METRIC` `TRANSACTIONAL`	required
displayName	string	The display name of the evidence.	required
entity	EntityStub	A short representation of a monitored entity.	required
groupingEntity	EntityStub	A short representation of a monitored entity.	optional
rootCauseRelevant	boolean	The evidence is (`true`) or is not (`false`) a part of the root cause.	required
startTime	integer	The start time of the evidence, in UTC milliseconds.	required

The `EntityStub` object

A short representation of a monitored entity.

Element	Type	Description	Required
entityId	EntityId	A short representation of a monitored entity.	optional
name	string	The name of the entity. Not included in the response in case no entity with the relevant ID was found.	optional

Element

Type

Description

Required

entityId

EntityId

A short representation of a monitored entity.

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

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 `Impact` 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 Required

impactType

string

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

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

required

impactedEntity

EntityStub

A short representation of a monitored entity.

required

estimatedAffectedUsers

integer

The estimated number of affected users.

required

The `EntityStub` object

A short representation of a monitored entity.

Element	Type	Description	Required
entityId	EntityId	A short representation of a monitored entity.	optional
name	string	The name of the entity. Not included in the response in case no entity with the relevant ID was found.	optional

Element

Type

Description

Required

entityId

EntityId

A short representation of a monitored entity.

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

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

CUSTOM_APPLICATION

CustomApplicationImpactDto

ParametersJSON model

The `Impact` 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 Required

impactType

string

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

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

required

impactedEntity

EntityStub

A short representation of a monitored entity.

required

estimatedAffectedUsers

integer

The estimated number of affected users.

required

The `EntityStub` object

A short representation of a monitored entity.

Element	Type	Description	Required
entityId	EntityId	A short representation of a monitored entity.	optional
name	string	The name of the entity. Not included in the response in case no entity with the relevant ID was found.	optional

Element

Type

Description

Required

entityId

EntityId

A short representation of a monitored entity.

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

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

MOBILE

MobileImpactDto

ParametersJSON model

The `Impact` 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 Required

impactType

string

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

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

required

impactedEntity

EntityStub

A short representation of a monitored entity.

required

estimatedAffectedUsers

integer

The estimated number of affected users.

required

The `EntityStub` object

A short representation of a monitored entity.

Element	Type	Description	Required
entityId	EntityId	A short representation of a monitored entity.	optional
name	string	The name of the entity. Not included in the response in case no entity with the relevant ID was found.	optional

Element

Type

Description

Required

entityId

EntityId

A short representation of a monitored entity.

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

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

SERVICE

ServiceImpactDto

ParametersJSON model

The `Impact` 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 Required

impactType

string

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

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

required

impactedEntity

EntityStub

A short representation of a monitored entity.

required

estimatedAffectedUsers

integer

The estimated number of affected users.

required

The `EntityStub` object

A short representation of a monitored entity.

Element	Type	Description	Required
entityId	EntityId	A short representation of a monitored entity.	optional
name	string	The name of the entity. Not included in the response in case no entity with the relevant ID was found.	optional

Element

Type

Description

Required

entityId

EntityId

A short representation of a monitored entity.

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

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 Evidence object

The EntityStub object

The EntityId object

EVENT

The Evidence object

The EntityStub object

The EntityId object

The Event object

The METag object

The ManagementZone object

The EventProperty object

MAINTENANCE_WINDOW

The Evidence object

The EntityStub object

The EntityId object

METRIC

The Evidence object

The EntityStub object

The EntityId object

TRANSACTIONAL

The Evidence object

The EntityStub object

The EntityId object

Variations of the Impact object

APPLICATION

The Impact object

The EntityStub object

The EntityId object

CUSTOM_APPLICATION

The Impact object

The EntityStub object

The EntityId object

MOBILE

The Impact object

The EntityStub object

The EntityId object

SERVICE

The Impact object

The EntityStub object

The EntityId object

Variations of the `Evidence` object

The `Evidence` object

The `EntityStub` object

The `EntityId` object

The `Evidence` object

The `EntityStub` object

The `EntityId` object

The `Event` object

The `METag` object

The `ManagementZone` object

The `EventProperty` object

The `Evidence` object

The `EntityStub` object

The `EntityId` object

The `Evidence` object

The `EntityStub` object

The `EntityId` object

The `Evidence` object

The `EntityStub` object

The `EntityId` object

Variations of the `Impact` object

The `Impact` object

The `EntityStub` object

The `EntityId` object

The `Impact` object

The `EntityStub` object

The `EntityId` object

The `Impact` object

The `EntityStub` object

The `EntityId` object

The `Impact` object

The `EntityStub` object

The `EntityId` object