• Home
  • Dynatrace API
  • Environment
  • Problems v2
  • Comments
  • GET all comments

Problems API v2 - GET all comments

Lists all comments on the specified problem.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/problems/{problemId}/comments
Environment ActiveGatehttps://{your-activegate-domain}/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

ParameterTypeDescriptionInRequired
problemIdstring

The ID of the required problem.

pathrequired
nextPageKeystring

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.

queryoptional
pageSizeinteger

The amount of comments in a single response payload.

The maximal allowed page size is 500.

If not set, 10 is used.

queryoptional

Response

Response codes

CodeTypeDescription
200CommentsList

Success

Response body objects

The CommentsList object

A list of comments.

ElementTypeDescription
commentsComment[]

The result entries.

totalCountinteger

The total number of entries in the result.

nextPageKeystring

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.

pageSizeinteger

The number of entries per page.

The Comment object

The comment to a problem.

ElementTypeDescription
authorNamestring

The user who wrote the comment.

createdAtTimestampinteger

The timestamp of comment creation, in UTC milliseconds.

contextstring

The context of the comment.

idstring

The ID of the comment.

contentstring

The text of the comment.

Response body JSON model

json
{ "comments": [ { "authorName": "string", "createdAtTimestamp": 1, "context": "string", "id": "string", "content": "string" } ], "totalCount": 1, "nextPageKey": "AQAAABQBAAAABQ==", "pageSize": 1 }
Related topics
  • Davis® AI

    Get familiar with the capabilities of Davis AI.