Add comment to issue - Issues

REST API Overview

Reference

Issues

Download API definition:

POST https://dev-api.bentley.com/issues/{id}/comments

Adds a new comment to the specified issue. Only the comment text is needed; the author and creation time will be automatically set by the server.

Permissions

To use this endpoint, the user is required to have the Forms Comment (Forms_CommentAccess) permission for the iTwin, or for the issue's associated form definition if form definition security is specified. (Having Create/Modify, Assign, Approve, or Full permission automatically grants the Comment permission as well.)

Authentication

Requires Authorization header with valid Bearer token for scope itwin-platform.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Request

Request parameters

Yes

The ID of the issue to get

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

Request body

Comment (create)

text

String

Yes

The text of the comment. If this includes a project member's email address preceeded by an @ sign, like @john.doe@example.com, then that user will receive an email notification.

Example

json

{
    "text": "Here's something noteworthy about this issue."
}

Response

Response 201 Created

Indicates that the comment was created successfully

Response 401 Unauthorized

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 404 Not Found

This response indicates that the issue the user attempted to add a comment to does not exist or is inaccessible to the user.

json

{
    "error": {
        "code": "IssueNotFound",
        "message": "Requested issue is not available.",
        "target": "id"
    }
}

Response 422 Unprocessable Entity

This response indicates that there is a problem with the format of the request body. Most likely causes: The body is not valid JSON, or the 'text' property is missing or not a string.

json

{
    "error": {
        "code": "InvalidCommentRequest",
        "message": "Cannot create comment.",
        "details": [{
            "code": "MissingRequiredProperty",
            "message": "Required property is missing. The request body must consist of a single object with 'text' property.",
            "target": "text"
        }]
    }
}

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

Comment (create)

text

String

The text of the comment. If this includes a project member's email address preceeded by an @ sign, like @john.doe@example.com, then that user will receive an email notification.

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

Detailed Error Response

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

error

DetailedError

Error Detailed information.