Jira Connector
Documentation
Version: 11
Documentation
Endpoint

Read Comments

Name

get_comments

Description

No description available

Related Tables

Comments

Parameters

Parameter Label Required Options Description
Key Issue Key(s) or Ids - Comma Separated (PRJA-10,PRJA-13) NO Use comma separated IDs or Keys for Issues. 1000 ids max or JIRA internal limit for Payload.
SearchBy Search by NO
Option Value
None
Project Key(s) Project
JQL Expression JQL
Issue Id(s) or Key(s) Key
Project Project NO Specify a project to search issues for
JQL JQL NO
Option Value
Search Ids (IN) key IN(10001, 10002, 10003)
Search Keys (IN) key IN(CS-1, CS-2, CS-3)
Search Projects (IN) project IN(PROJ1, PROJ2, PROJ3)
Search Status (EQUAL) status='Done'
Search Date (Expression 1) created >=-5d
Search Date (Expression 2) created >=startOfMonth() AND created <=now()
Search Date (Expression 3) created >=startOfYear() AND created <=startOfDay()
Search Date (Static) created >= "2008-12-31"
Search Date (Static with time) created >= '2008/12/31 23:59'
Search Date (Issue Update Date) updated >=-5d
Search Project and Status (AND + IN) project=CS AND status NOT IN ('Done', 'Open', 'Closed')
Search Assignee and Created Date assignee is NOT EMPTY and created < -1d
Search Text (Contains - Fuzzy) Summary ~ 'some words' OR description ~ 'some words'
Search Text (Contains - Fuzzy Wildcard) Summary ~ 'some*' OR description ~ 'some*'
Search Text (Contains - Exact) Summary ~ '\"exact words\"' OR description ~ '\"exact words\"'
Search Text (Does Not Contain - Fuzzy) Summary !~ 'some words' OR description !~ 'some words'
Search Empty OR Null fixVersion is empty OR fixVersion is null
Search Is Not Empty OR Is Not Null fixVersion is not empty OR fixVersion is not null
Search WAS Operator (previous value) status WAS "Resolved" BY (jsmith,srogen) BEFORE "2019/02/02"
Search WAS IN Operator status WAS IN ("Resolved", "In Progress")
Search WAS NOT IN Operator status WAS NOT IN ("Resolved", "In Progress")
Search WAS + BY + DURING (date range) status WAS "Resolved" BY (jsmith,srogen) DURING("2019/02/02", "2020/02/02")
Search CHANGED operator assignee CHANGED
Search CHANGED operator (multiple) status CHANGED FROM "In Progress" TO "Open"
Use JQL to use an advanced mode of searching. Few links are https://www.atlassian.com/blog/jira/jql-the-most-flexible-way-to-search-jira-14 and als check https://wac-cdn.atlassian.com/dam/jcr:241d9c9b-475f-411f-90a2-97ca344442b3/atlassian-jql-cheat-sheet-2.pdf?cdnVersion=2169 [API reference]
CustomColumnsRegex CustomColumnsRegex NO Enter regular expression for custom columns which you like to output. Use Pipe to type multiple column names (must use key - internal names for columns e.g. customfield_10004). You can use Regex too (e.g. field_100\d+ ). This filter is only applied for those fields which has flag custom=true.

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
IssueId DT_WSTR nvarchar(20) 20 False
IssueKey DT_WSTR nvarchar(50) 50 False
Id DT_WSTR nvarchar(20) 20 False
Created DT_DBTIMESTAMP datetime False
Updated DT_DBTIMESTAMP datetime False
Self DT_WSTR nvarchar(150) 150 False
BodyType DT_WSTR nvarchar(50) 50 False
BodyContent DT_NTEXT nvarchar(MAX) False
BodyContentText DT_NTEXT nvarchar(MAX) False Join formatted text blocks using space separator (new lines will be lost)
BodyVersion DT_NUMERIC decimal(18,5) False
AuthorSelf DT_WSTR nvarchar(150) 150 False
AuthorAccountId DT_WSTR nvarchar(100) 100 False
AuthorEmailAddress DT_WSTR nvarchar(100) 100 False
AuthorAvatarUrls48x48 DT_WSTR nvarchar(500) 500 False
AuthorAvatarUrls24x24 DT_WSTR nvarchar(500) 500 False
AuthorAvatarUrls16x16 DT_WSTR nvarchar(500) 500 False
AuthorAvatarUrls32x32 DT_WSTR nvarchar(500) 500 False
AuthorDisplayName DT_WSTR nvarchar(100) 100 False
AuthorActive DT_BOOL bit False
AuthorTimeZone DT_WSTR nvarchar(100) 100 False
AuthorAccountType DT_WSTR nvarchar(50) 50 False
UpdateAuthorSelf DT_WSTR nvarchar(150) 150 False
UpdateAuthorAccountId DT_WSTR nvarchar(50) 50 False
UpdateAuthorEmailAddress DT_WSTR nvarchar(100) 100 False
UpdateAuthorAvatarUrls48x48 DT_WSTR nvarchar(500) 500 False
UpdateAuthorAvatarUrls24x24 DT_WSTR nvarchar(500) 500 False
UpdateAuthorAvatarUrls16x16 DT_WSTR nvarchar(500) 500 False
UpdateAuthorAvatarUrls32x32 DT_WSTR nvarchar(500) 500 False
UpdateAuthorDisplayName DT_WSTR nvarchar(100) 100 False
UpdateAuthorActive DT_BOOL bit False
UpdateAuthorTimeZone DT_WSTR nvarchar(44) 44 False
UpdateAuthorAccountType DT_WSTR nvarchar(36) 36 False
jsdPublic DT_BOOL bit False
If the column you are looking for is missing, consider customizing Jira Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Jira Connector in API Source component to read data or in API Destination component to read/write data:

Read from Comments table using API Destination

This Endpoint belongs to Comments table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Jira
Comments
Select, Lookup
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Read comments 

SELECT * FROM get_comments

List comments for all issues

List comments for all issues 

SELECT * FROM Comments

List comments for a specific issue Issue Key or Id

List comments for a specific issue 

SELECT * FROM Comments Where IssueId=10003 --OR WITH(Key='10003')

List comments for a specific issue by Key

List comments for a specific issue by key 

SELECT * FROM Comments WITH(Key='CS-1')

List comments for issues (search by JQL)

List all comments for issues returned from a JQL search expression (refer to previous example to learn about JQL - see Search issues using Advanced JQL query expression) 

SELECT * FROM Comments WITH (Jql='status IN (Done, Closed) AND created > -5d' )

get_comments endpoint belongs to Comments table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Read comments 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_comments';

EXEC (@MyQuery) AT [LS_TO_JIRA_IN_GATEWAY];

List comments for all issues

List comments for all issues 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Comments';

EXEC (@MyQuery) AT [LS_TO_JIRA_IN_GATEWAY];

List comments for a specific issue Issue Key or Id

List comments for a specific issue 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Comments Where IssueId=10003 --OR WITH(Key=''10003'')';

EXEC (@MyQuery) AT [LS_TO_JIRA_IN_GATEWAY];

List comments for a specific issue by Key

List comments for a specific issue by key 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Comments WITH(Key=''CS-1'')';

EXEC (@MyQuery) AT [LS_TO_JIRA_IN_GATEWAY];

List comments for issues (search by JQL)

List all comments for issues returned from a JQL search expression (refer to previous example to learn about JQL - see Search issues using Advanced JQL query expression) 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Comments WITH (Jql=''status IN (Done, Closed) AND created > -5d'' )';

EXEC (@MyQuery) AT [LS_TO_JIRA_IN_GATEWAY];

get_comments endpoint belongs to Comments table(s), and can therefore be used via those table(s).