Retrieves the text and metadata for all comments that have been posted to the given issue. If the Prefer header was specified with the value "return=representation", the response will include the email address of each comment author, though this may incur additional processing time. If there is an extraordinarily large number of comments, only 50 distinct user email addresses will be retrieved and shown. Regardless of the Prefer header value, the "_links" object associated with each comment will provide a link to additional information about the comment author.
To use this endpoint, the user is required to have the ProjectWise Forms View (Forms_ViewAccess) permission for the project, or for the issue's associated definition if form definition security is specified. (Having any other ProjectWise Forms permission automatically grants the View permission as well.)
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
HeaderNotFound
{"error":{"code":"HeaderNotFound","message":"Header Authorization was not found in the request. Access denied."}}
Display name (i.e., given name and surname) of the user who posted this comment. (If the comment was posted using this API, it is inferred to be the authorized user making the request.)
createdDateTime
Date-time
Date and time the comment was posted.
workflowNoteFrom
String,null
Will only be set if the comment is a workflow transition note. This is the name of the status the issue was in before the transition.
workflowNoteTo
String,null
Will only be set if the comment is a workflow transition note. This is the name of the status the issue is in after the transition.
_links.author._href
String
A URL that can be used to retrieve more information about the comment author.
Display name (i.e., given name and surname) of the user who posted this comment. (If the comment was posted using this API, it is inferred to be the authorized user making the request.)
authorEmail
String
Email address of the user who wrote this comment.
createdDateTime
Date-time
Date and time the comment was posted.
workflowNoteFrom
String,null
Will only be set if the comment is a workflow transition note. This is the name of the status the issue was in before the transition.
workflowNoteTo
String,null
Will only be set if the comment is a workflow transition note. This is the name of the status the issue is in after the transition.
_links.author._href
String
A URL that can be used to retrieve more information about the comment author.
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.
TableSchema
Name
Type
Description
error.code
String
Short string indicating the general category of error that occurred, such as '{Resource}NotFound'.
error.message
String
Longer string explaining to developers why the error occurred.
error.target
String,null
If relevant, this is the name of the property, URL template parameter, or query parameter that caused the error.
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.