Problems API v2 - GET all comments

Lists all comments on the specified problem.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/problems/{problemId}/comments
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/problems/{problemId}/comments

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
nextPageKey
string

The cursor for the next page of results. You can find it in the nextPageKey field of the previous response.

The first page is always returned if you don't specify the nextPageKey query parameter.

When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters except the optional fields parameter.

query
optional
pageSize
integer

The amount of comments in a single response payload.

The maximal allowed page size is 500.

If not set, 10 is used.

query
optional

Response

Response codes

Code
Type
Description
200

Success

4XX

Client side error.

5XX

Server side error.

Response body objects

The CommentsList object

A list of comments.

Element
Type
Description
comments

The result entries.

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.

pageSize
integer

The number of entries per page.

totalCount
integer

The total number of entries in the result.

The Comment object

The comment to a problem.

Element
Type
Description
authorName
string

The user who wrote the comment.

content
string

The text of the comment.

context
string

The context of the comment.

createdAtTimestamp
integer

The timestamp of comment creation, in UTC milliseconds.

id
string

The ID of the comment.

Response body JSON model

{
"comments": [
{
"authorName": "string",
"content": "string",
"context": "string",
"createdAtTimestamp": 1,
"id": "string"
}
],
"nextPageKey": "AQAAABQBAAAABQ==",
"pageSize": 1,
"totalCount": 1
}