Problems API v2 - GET a comment

  • Reference
  • Published Oct 12, 2020

Gets the specified comment on a problem.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments/{commentId}
Environment and Cluster ActiveGate (default port 9999)https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/problems/{problemId}/comments/{commentId}

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
commentIdstring

The ID of the required comment.

pathRequired

Response

Response codes

CodeTypeDescription
200Comment

Success

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The Comment object

The comment to a problem.

ElementTypeDescription
authorNamestring

The user who wrote the comment.

contentstring

The text of the comment.

contextstring

The context of the comment.

createdAtTimestampinteger

The timestamp of comment creation, in UTC milliseconds.

idstring

The ID of the comment.

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
  "authorName": "string",
  "content": "string",
  "context": "string",
  "createdAtTimestamp": 1,
  "id": "string"
}
{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}