Problems API v2 - GET problems details
Lists all details of the specified problem.
The request produces an application/json
payload.
GET | ManagedDynatrace for Government | 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 an access token with problems.read
scope.
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):
To add properties, specify them as a comma-separated list (for example, | 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 | Type | Description |
---|---|---|
200 | Problem | Success |
Response body objects
The Problem
object
The properties of a problem.
Element | Type | Description |
---|---|---|
displayId | string | The display ID of the problem. |
affectedEntities | Entity | A list of all entities that are affected by the problem. |
problemFilters | Alerting | A list of alerting profiles that match the problem. |
linkedProblemInfo | Linked | The properties of the linked problem. |
evidenceDetails | Evidence | The evidence details of a problem. |
recentComments | Comments | A list of comments. |
impactAnalysis | Impact | A list of all impacts of the problem. |
rootCauseEntity | Entity | A short representation of a monitored entity. |
impactedEntities | Entity | A list of all entities that are impacted by the problem. |
managementZones | Management | A list of all management zones that the problem belongs to. |
severityLevel | string | The severity of the problem. |
entityTags | M | A list of all entity tags of the problem. |
problemId | string | The ID of the problem. |
impactLevel | string | The impact level of the problem. It shows what is affected by the problem. |
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 |
title | string | The name of the problem, displayed in the UI. |
The EntityStub
object
A short representation of a monitored entity.
Element | Type | Description |
---|---|---|
entityId | Entity | 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 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 LinkedProblem
object
The properties of the linked problem.
Element | Type | Description |
---|---|---|
displayId | string | The display ID of the problem. |
problemId | string | The ID of the problem. |
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.
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 |
---|---|---|
evidenceType | string | Defines the actual set of fields depending on the value. See one of the following objects:
|
displayName | string | The display name of the evidence. |
entity | Entity | A short representation of a monitored entity. |
groupingEntity | Entity | A short representation of a monitored entity. |
rootCauseRelevant | boolean | The evidence is ( |
startTime | integer | The start time of the evidence, in UTC milliseconds. |
The CommentsList
object
A list of comments.
Element | Type | Description |
---|---|---|
comments | Comment[] | The result entries. |
totalCount | integer | The total number of entries in the result. |
pageSize | integer | The number of entries per page. |
nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of 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 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.
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 | Defines the actual set of fields depending on the value. See one of the following objects:
|
impactedEntity | Entity | A short representation of a monitored entity. |
estimatedAffectedUsers | integer | The estimated number of affected users. |
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 |
Response body JSON model
{
"displayId": "string",
"affectedEntities": [
{
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
}
],
"problemFilters": [
{
"name": "string",
"id": "string"
}
],
"linkedProblemInfo": {
"displayId": "string",
"problemId": "string"
},
"evidenceDetails": {
"totalCount": 1,
"details": [
{
"evidenceType": "AVAILABILITY_EVIDENCE",
"displayName": "string",
"entity": {},
"groupingEntity": {},
"rootCauseRelevant": true,
"startTime": 1
}
]
},
"recentComments": {
"comments": [
{
"createdAtTimestamp": 1,
"authorName": "string",
"context": "string",
"id": "string",
"content": "string"
}
],
"totalCount": 1,
"pageSize": 1,
"nextPageKey": "AQAAABQBAAAABQ=="
},
"impactAnalysis": {
"impacts": [
{
"impactType": "APPLICATION",
"impactedEntity": {},
"estimatedAffectedUsers": 1
}
]
},
"rootCauseEntity": {},
"impactedEntities": [
{}
],
"managementZones": [
{
"name": "string",
"id": "string"
}
],
"severityLevel": "AVAILABILITY",
"entityTags": [
{
"stringRepresentation": "string",
"value": "string",
"key": "string",
"context": "string"
}
],
"problemId": "string",
"impactLevel": "APPLICATION",
"status": "CLOSED",
"startTime": 1,
"endTime": 1,
"title": "string"
}