Issues

Comments

Download API definition:

POST https://sampleHostName/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 ProjectWise Forms Comment (Forms_CommentAccess) permission for the project, 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 issues:modify.

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


Request parameters

Name
In
Required?
Description
id
template
Yes

The ID of the issue to get

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope issues:modify

Accept
No

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

Request body

comment-create

Name
Type
Required?
Description
No data.

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

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

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

Response 429 Too many requests

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

json

Response headers

Name
Description
retry-after

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