Problems API - GET all comments

Lists all comments on 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}/comments SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/problems/{problemId}/comments

Authentication

To execute this request, you need the Access problem and event feed, metrics, and topology (DataExport) 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 problem whose comments you're inquiring.	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.	query	optional
pageSize	integer	The number of results per result page.	query	optional

Parameter

Type

Description

Required

problemId

string

The ID of the problem whose comments you're inquiring.

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.

query

optional

pageSize

integer

The number of results per result page.

query

optional

Response format

Response parameters JSON model

The CommentsList object

A list of comments.

Element	Type	Description
comments	CommentDto[]
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 CommentDto object

Element	Type	Description
createdAtTimestamp	integer
authorName	string
context	string
id	string
content	string

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