Problems API v2 - GET all comments

Lists all comments on the specified problem.

The request produces an application/json payload.

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

Authentication

To execute this request, you need 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	optional
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	required
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	required

Parameter

Type

Description

Required

problemId

string

The ID of the required problem.

path

optional

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

required

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

required

Response

Response codes

Code	Type	Description
200	CommentsList	Success

Response body objects

The `CommentsList` object

A list of comments.

Element	Type	Description	Required
comments	Comment[]	The result entries.	required
pageSize	integer	The number of entries per page.	optional
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.	optional
totalCount	integer	The total number of entries in the result.	required

The `Comment` object

The comment to a problem.

Element	Type	Description	Required
authorName	string	The user who wrote the comment.	optional
createdAtTimestamp	integer	The timestamp of comment creation, in UTC milliseconds.	required
context	string	The context of the comment.	optional
id	string	The ID of the comment.	optional
content	string	The text of the comment.	optional

Response body JSON model

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