Atlassian: Issue comments schemas
9 Atlassian schemas with complete fields and constraints.
← Issue comments operations · All schemas
Add comment — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A comment. Additional keys: allowed |
author | Model | Optional | Expand Add comment — request body — body author The ID of the user who created the comment. Read only: true |
body | JSON | Optional | The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). |
created | string | Optional | The date and time at which the comment was created. Format: date-time Read only: true |
id | string | Optional | The ID of the comment. Read only: true |
jsdAuthorCanSeeRequest | boolean | Optional | 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. Read only: true |
jsdPublic | boolean | Optional | 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. Read only: true |
properties | array | Optional | A list of comment properties. Optional on create and update. |
properties[] | Model | Each item | Expand Edit issue — request body — body properties item |
renderedBody | string | Optional | The rendered version of the comment. Read only: true |
self | string | Optional | The URL of the comment. Read only: true |
updateAuthor | Model | Optional | Expand Add comment — request body — body author The ID of the user who updated the comment last. Read only: true |
updated | string | Optional | The date and time at which the comment was updated last. Format: date-time Read only: true |
visibility | Model | Optional | Expand Add comment — request body — body visibility The group or role to which this comment is visible. Optional on create and update. |
Referenced models: Edit issue — request body — body properties item, Add comment — request body — body author, Add comment — request body — body visibility
Add comment — request body — body author
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. Additional keys: not allowed |
accountId | string | Optional | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Maximum length: 128 |
accountType | string | Optional | The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) Read only: true |
active | boolean | Optional | Whether the user is active. Read only: true |
avatarUrls | Model | Optional | Expand Assign issue — request body — body avatar Urls The avatars of the user. Read only: true |
displayName | string | Optional | The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. Read only: true |
emailAddress | string | Optional | The email address of the user. Depending on the user’s privacy settings, this may be returned as null. Read only: true |
key | string | Optional | This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Read only: true |
name | string | Optional | This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Read only: true |
self | string | Optional | The URL of the user. Read only: true |
timeZone | string | Optional | The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. Read only: true |
Referenced models: Assign issue — request body — body avatar Urls
Add comment — request body — body visibility
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The group or role to which this item is visible. Additional keys: allowed |
identifier | JSON | Optional | |
identifier (anyOf 1) | string | Alternative | The ID of the group or the name of the role that visibility of this item is restricted to. |
identifier (anyOf 2) | null | Alternative | |
type | string | Optional | Whether visibility of this item is restricted to a group or role. One of: group, role |
value | string | Optional | The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use `identifier`. |
Add comment — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A comment. Additional keys: allowed |
author | JSON | Optional | |
author (anyOf 1) | Model | Alternative | Expand Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone The ID of the user who created the comment. Read only: true |
author (anyOf 2) | null | Alternative | |
body | JSON | Optional | |
body (anyOf 1) | JSON | Alternative | The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). |
body (anyOf 2) | null | Alternative | |
created | JSON | Optional | |
created (anyOf 1) | JSON | Alternative | |
created (anyOf 1) (anyOf 1) | string | Alternative | The date and time at which the comment was created. Read only: true |
created (anyOf 1) (anyOf 2) | integer | Alternative | |
created (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the comment. Read only: true |
id (anyOf 2) | null | Alternative | |
jsdAuthorCanSeeRequest | JSON | Optional | |
jsdAuthorCanSeeRequest (anyOf 1) | boolean | Alternative | 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. Read only: true |
jsdAuthorCanSeeRequest (anyOf 2) | null | Alternative | |
jsdPublic | JSON | Optional | |
jsdPublic (anyOf 1) | boolean | Alternative | 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. Read only: true |
jsdPublic (anyOf 2) | null | Alternative | |
properties | JSON | Optional | |
properties (anyOf 1) | array | Alternative | A list of comment properties. Optional on create and update. |
properties (anyOf 1)[] | Model | Each item | Expand Get user property — response body |
properties (anyOf 2) | null | Alternative | |
renderedBody | JSON | Optional | |
renderedBody (anyOf 1) | string | Alternative | The rendered version of the comment. Read only: true |
renderedBody (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the comment. Read only: true |
self (anyOf 2) | null | Alternative | |
updateAuthor | JSON | Optional | |
updateAuthor (anyOf 1) | Model | Alternative | Expand Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone The ID of the user who updated the comment last. Read only: true |
updateAuthor (anyOf 2) | null | Alternative | |
updated | JSON | Optional | |
updated (anyOf 1) | JSON | Alternative | |
updated (anyOf 1) (anyOf 1) | string | Alternative | The date and time at which the comment was updated last. Read only: true |
updated (anyOf 1) (anyOf 2) | integer | Alternative | |
updated (anyOf 2) | null | Alternative | |
visibility | JSON | Optional | |
visibility (anyOf 1) | Model | Alternative | Expand Add comment — response body — visibility The group or role to which this item is visible The group or role to which this comment is visible. Optional on create and update. |
visibility (anyOf 2) | null | Alternative |
Referenced models: Get user property — response body, Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone, Add comment — response body — visibility The group or role to which this item is visible
Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. |
accountId | JSON | Optional | |
accountId (anyOf 1) | string | Alternative | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Maximum length: 128 |
accountId (anyOf 2) | null | Alternative | |
accountType | JSON | Optional | |
accountType (anyOf 1) | string | Alternative | The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) Read only: true |
accountType (anyOf 2) | null | Alternative | |
active | JSON | Optional | |
active (anyOf 1) | boolean | Alternative | Whether the user is active. Read only: true |
active (anyOf 2) | null | Alternative | |
avatarUrls | JSON | Optional | |
avatarUrls (anyOf 1) | Model | Alternative | Expand Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48 The avatars of the user. Read only: true |
avatarUrls (anyOf 2) | null | Alternative | |
displayName | JSON | Optional | |
displayName (anyOf 1) | string | Alternative | The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. Read only: true |
displayName (anyOf 2) | null | Alternative | |
emailAddress | JSON | Optional | |
emailAddress (anyOf 1) | string | Alternative | The email address of the user. Depending on the user’s privacy settings, this may be returned as null. Read only: true |
emailAddress (anyOf 2) | null | Alternative | |
key | JSON | Optional | |
key (anyOf 1) | string | Alternative | This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Read only: true |
key (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Read only: true |
name (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the user. Read only: true |
self (anyOf 2) | null | Alternative | |
timeZone | JSON | Optional | |
timeZone (anyOf 1) | string | Alternative | The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. Read only: true |
timeZone (anyOf 2) | null | Alternative |
Referenced models: Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48
Add comment — response body — visibility The group or role to which this item is visible
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The group or role to which this item is visible. Additional keys: allowed |
identifier | JSON | Optional | |
identifier (anyOf 1) | JSON | Alternative | |
identifier (anyOf 1) (anyOf 1) | string | Alternative | The ID of the group or the name of the role that visibility of this item is restricted to. |
identifier (anyOf 1) (anyOf 2) | null | Alternative | |
identifier (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | Whether visibility of this item is restricted to a group or role. Known values: group, role |
type (anyOf 2) | null | Alternative | |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use `identifier`. |
value (anyOf 2) | null | Alternative |
Get comments by I Ds — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
ids | array | Required within parent | The list of comment IDs. A maximum of 1000 IDs can be specified. Unique items: true |
ids[] | integer | Each item | Format: int64 |
Get comments by I Ds — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Add comment — response body |
values (anyOf 2) | null | Alternative |
Referenced models: Add comment — response body
Get comments — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of comments. Additional keys: allowed |
comments | JSON | Optional | |
comments (anyOf 1) | array | Alternative | The list of comments. Read only: true |
comments (anyOf 1)[] | Model | Each item | Expand Add comment — response body |
comments (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative |
Referenced models: Add comment — response body