Please enable JavaScript to view this site.

JIRA Cloud API Data Model JIRA Cloud Forums

Navigation: Schema: Core > Tables

IssueCommentsByIdOrKey

Catalog: JIRA

Schema: Core

Primary Keys: id

This is a read-only table function. The JIRA Cloud API may not support changing the data or the Invantive SQL driver for JIRA Cloud does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the JIRA Cloud API.

Select JIRA Cloud API URL: /issue/{issueIdOrKey}/comment?expand=renderedBody

Insert JIRA Cloud API URL: /issue/{issueIdOrKey}/comment?expand=renderedBody

Update JIRA Cloud API URL: /issue/{issueIdOrKey}/comment?expand=renderedBody

Delete JIRA Cloud API URL: /issue/{issueIdOrKey}/comment?expand=renderedBody

Field Selection Method: NotRequired

Base Path: comments[*]

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function IssueCommentsByIdOrKey. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

issueIdOrKey

string

☑

 

The ID or key to be retrieved.

 

Columns of Table Function

The columns of the table function IssueCommentsByIdOrKey are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

author_accountId

string

 

☐

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. An account ID with value unknown is returned when there is missing data for a user, which only happens for deleted users. We recommend you treat this value as an error case if you need to access more information about the user.

author_accountType

string

 

☐

The user account type. Can take the following values: atlassian regular Atlassian user account, app system account used for Connect applications and OAuth to represent external systems, customer Jira Service Desk account representing an external service desk

author_active

boolean

 

☐

Indicates whether the user is active.

author_displayName

string

 

☐

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

author_emailAddress

string

 

☐

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

author_key

string

 

☐

This property is no longer available and will be removed from the documentation soon

author_locale

string

 

☐

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

author_name

string

 

☐

This property is no longer available and will be removed from the documentation soon.

author_timeZone

string

 

☐

The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.

body

string

 

☐

The comment text in Atlassian Document Format.

created

datetime

 

☐

Creation date.

id

string

 

☐

The ID of the comment.

jsdPublic

boolean

 

☐

Indicates 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

renderedBody

string

 

☐

The rendered version of the comment.

self

string

 

☐

The URL of the comment.

updateAuthor_accountId

string

 

☐

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. An account ID with value unknown is returned when there is missing data for a user, which only happens for deleted users. We recommend you treat this value as an error case if you need to access more information about the user.

updateAuthor_accountType

string

 

☐

The user account type. Can take the following values: atlassian regular Atlassian user account, app system account used for Connect applications and OAuth to represent external systems, customer Jira Service Desk account representing an external service desk

updateAuthor_active

boolean

 

☐

Indicates whether the user is active.

updateAuthor_displayName

string

 

☐

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

updateAuthor_emailAddress

string

 

☐

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

updateAuthor_key

string

 

☐

This property is no longer available and will be removed from the documentation soon

updateAuthor_locale

string

 

☐

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

updateAuthor_name

string

 

☐

This property is no longer available and will be removed from the documentation soon.

updateAuthor_timeZone

string

 

☐

The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.

updated

datetime

 

☐

Update date.

 

19-12-2022 16:35 Version 22.1.113-BETA+3734

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.
  
Disclaimer