643 matches
60 actions
Confluence
60 actions
Productivity/Confluence
Returns all comments for an issue.
This operation can be accessed anonymously.
required: Comments are included in the response where the user has:
{
"type": "object",
"properties": {
"expand": {
"type": "string"
},
"issueIdOrKey": {
"type": "string"
},
"maxResults": {
"type": "integer",
"format": "int32"
},
"orderBy": {
"type": "string",
"enum": [
"created",
"-created",
"+created"
]
},
"startAt": {
"type": "integer",
"format": "int64"
}
},
"required": [
"issueIdOrKey"
],
"additionalProperties": false
}{
"type": "object",
"description": "A page of comments.",
"properties": {
"comments": {
"type": "array",
"description": "The list of comments.",
"items": {
"type": "object",
"description": "A comment.",
"properties": {
"author": {
"description": "The ID of the user who created the comment.",
"type": "object"
},
"body": {
"description": "The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/).",
"type": "object"
},
"created": {
"type": "string",
"format": "date-time",
"description": "The date and time at which the comment was created."
},
"id": {
"type": "string",
"description": "The ID of the comment."
},
"jsdAuthorCanSeeRequest": {
"type": "boolean",
"description": "Whether the comment was added from an email sent by a person who is not part of the issue. See [Allow external emails to be added as comments on issues](https://support.atlassian.com/jira-service-management-cloud/docs/allow-external-emails-to-be-added-as-comments-on-issues/)for information on setting up this feature."
},
"jsdPublic": {
"type": "boolean",
"description": "Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation."
},
"properties": {
"type": "array",
"description": "A list of comment properties. Optional on create and update.",
"items": {
"type": "object",
"description": "An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).",
"properties": {
"key": {
"type": "string",
"description": "The key of the property. Required on create and update."
},
"value": {
"description": "The value of the property. Required on create and update.",
"type": "object"
}
},
"additionalProperties": false
}
},
"renderedBody": {
"type": "string",
"description": "The rendered version of the comment."
},
"self": {
"type": "string",
"description": "The URL of the comment."
},
"updateAuthor": {
"description": "The ID of the user who updated the comment last.",
"type": "object"
},
"updated": {
"type": "string",
"format": "date-time",
"description": "The date and time at which the comment was updated last."
},
"visibility": {
"description": "The group or role to which this comment is visible. Optional on create and update.",
"type": "object"
}
}
}
},
"maxResults": {
"type": "integer",
"format": "int32",
"description": "The maximum number of items that could be returned."
},
"startAt": {
"type": "integer",
"format": "int64",
"description": "The index of the first item returned."
},
"total": {
"type": "integer",
"format": "int64",
"description": "The number of items returned."
}
}
}