Problems API - GET problems details

Lists all details of the specified problem.

The request produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/problems/{problemId}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems/{problemId}

Authentication

To execute this request, you need the Read problems (problems.read) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
problemId string

The ID of the required problem.

path required
fields string

A list of additional problem properties you can add to the response.

The following properties are available (all other properties are always included and you can't remove them from the response):

  • evidenceDetails: The details of the root cause.
  • impactAnalysis: The impact analysis of the problem on other entities/users.
  • recentComments: A list of the most recent comments to the problem.

To add properties, specify them as a comma-separated list (for example, evidenceDetails,impactAnalysis).

query optional

Response

Some JSON models vary depending on the type of the model. To find all the possible variations, refer to JSON models.

Response codes

Code Description
200

Success

Response body

The Problem object

The properties of a problem.

Element Type Description
problemId string

The ID of the problem.

affectedEntities EntityStub[]

A list of all entities that are affected by the problem.

rootCauseEntity EntityStub
problemFilters AlertingProfileStub[]

A list of alerting profiles that match the problem.

evidenceDetails EvidenceDetails
recentComments CommentsList
impactAnalysis ImpactAnalysis
linkedProblemInfo LinkedProblem
entityTags METag[]

A list of all entity tags of the problem.

impactLevel string

The impact level of the problem. It shows what is affected by the problem.

impactedEntities EntityStub[]

A list of all entities that are impacted by the problem.

displayId string

The display ID of the problem.

severityLevel string

The severity of the problem.

managementZones ManagementZone[]

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

status string

The status of the problem.

startTime integer

The start timestamp of the problem, in UTC milliseconds.

endTime integer

The end timestamp of the problem, in UTC milliseconds.

Has -1 value, if the problem is still open.

title string

The name of the problem, displayed in the UI.

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

The LinkedProblem object

The properties of the linked problem.

Element Type Description
problemId string

The ID of the problem.

displayId string

The display ID of the problem.

The ImpactAnalysis object

A list of all impacts of the problem.

Element Type Description
impacts Impact[]

A list of all impacts of the problem.

The Impact object

The impact analysis of the problem on other entities/users.

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
impactedEntity EntityStub
estimatedAffectedUsers integer

The estimated number of affected users.

The CommentsList object

A list of comments.

Element Type Description
comments Comment[]

The result entries.

pageSize integer

The number of entries per page.

nextPageKey string

The cursor for the next page of results. Has the value of null on the last page.

Use it in the nextPageKey query parameter to obtain subsequent pages of the result.

totalCount integer

The total number of entries in the result.

The Comment object

The comment to a problem.

Element Type Description
createdAtTimestamp integer

The timestamp of comment creation, in UTC milliseconds.

authorName string

The user who wrote the comment.

context string

The context of the comment.

id string

The ID of the comment.

content string

The text of the comment.

The EvidenceDetails object

The evidence details of a problem.

Element Type Description
totalCount integer

The total number of evidence of a problem.

details Evidence[]

A list of all evidence.

The Evidence object

An evidence of a root cause.

Element Type Description
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
displayName string

The display name of the evidence.

entity EntityStub
groupingEntity EntityStub
rootCauseRelevant boolean

The evidence is (true) or is not (false) a part of the root cause.

startTime integer

The start time of the evidence, in UTC milliseconds.

The AlertingProfileStub object

Short representation of the alerting profile.

Element Type Description
name string

The name of the alerting profile.

id string

The ID of the alerting profile.

The EntityStub object

A short representation of a monitored entity.

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