Reference

Endpoint Read Worklogs

Name

get_worklogs

Description

No description available

Related Tables

Worklogs

Parameters

Parameter Required Options
Name: Fields

Label: Fields
Name: Key

Label: Issue Key(s) or Ids - Comma Separated (CBS-10,PRA-13)

Use comma separated IDs or Keys for Issues. 1000 ids max or JIRA internal limit for Payload.
Name: SearchBy

Label: Search by
Option Value
None
Project Key(s) Project
JQL Expression JQL
Issue Id(s) or Key(s) Key
Name: Project

Label: Project Key(s) - Comma Separated (CBS,BRK)

Specify a project to search issues for
Name: JQL

Label: JQL Expression (For Issue Search)

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
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 (Expression 4 - Site Timezone) created >= '2008-12-31 23:59'
Search Date (Issue Created After Date - Quote1) created >= '2008-12-31'
Search Date (Issue Created After Date - Quote2) created >= "2008-12-31"
Search Date (Issue Created After Date+Time - Site Timezone) created >= '2008-12-31 23:59'
Search Date (Issue Updated After Date+Time - Site Timezone) updated >= "2008-12-31 23:59"
Search Date (Issue Updated In Last 5 Days) updated >=-5d
Search Date (Issue Updated In Last 24 Hours) updated >=-24h
Search Date (Worklog Created or Updated After Date) worklogDate >= '2008-12-31'
Search Date (Worklog Created or Updated In Last 2 Days) worklogDate >= -2d
Search Date (Worklog Created or Updated After for Specified Projects) project IN (PROJ1, PROJ2) AND worklogDate >= '2008-12-31'
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"
Name: CustomColumnsRegex

Label: CustomColumnsRegex

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 Description
IssueId DT_WSTR nvarchar(20) 20
IssueKey DT_WSTR nvarchar(50) 50
Id DT_WSTR nvarchar(20) 20
Self DT_WSTR nvarchar(150) 150
StartAt DT_I4 int
MaxResults DT_I4 int
Total DT_I8 bigint
AuthorSelf DT_WSTR nvarchar(200) 200
AuthorAccountId DT_WSTR nvarchar(150) 150
AuthorEmailAddress DT_WSTR nvarchar(200) 200
AuthorDisplayName DT_WSTR nvarchar(200) 200
AuthorIsActive DT_BOOL bit
AuthorTimeZone DT_WSTR nvarchar(100) 100
AuthorAccountType DT_WSTR nvarchar(50) 50
CommentFormatted DT_NTEXT nvarchar(MAX)
Comment DT_NTEXT nvarchar(MAX) Join formatted text blocks using space separator (new lines will be lost)
UpdateAuthorSelf DT_WSTR nvarchar(500) 500
UpdateAuthorAccountId DT_WSTR nvarchar(200) 200
UpdateAuthorEmailAddress DT_WSTR nvarchar(200) 200
UpdateAuthorDisplayName DT_WSTR nvarchar(200) 200
UpdateAuthorActive DT_BOOL bit
UpdateAuthorTimeZone DT_WSTR nvarchar(80) 80
UpdateAuthorAccountType DT_WSTR nvarchar(50) 50
Created DT_DBTIMESTAMP datetime
Updated DT_DBTIMESTAMP datetime
Started DT_DBTIMESTAMP datetime
TimeSpent DT_WSTR nvarchar(50) 50
TimeSpentInSeconds DT_I8 bigint
AuthorAvatarUrls48x48 DT_WSTR nvarchar(500) 500
AuthorAvatarUrls24x24 DT_WSTR nvarchar(500) 500
AuthorAvatarUrls16x16 DT_WSTR nvarchar(500) 500
AuthorAvatarUrls32x32 DT_WSTR nvarchar(500) 500
UpdateAuthorAvatarUrls48x48 DT_WSTR nvarchar(500) 500
UpdateAuthorAvatarUrls24x24 DT_WSTR nvarchar(500) 500
UpdateAuthorAvatarUrls16x16 DT_WSTR nvarchar(500) 500
UpdateAuthorAvatarUrls32x32 DT_WSTR nvarchar(500) 500
If the column you are looking for is missing, consider customizing Jira Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length 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 or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Worklogs table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Jira
Read and write Jira data effortlessly. Track, manage, and automate issues, projects, worklogs, and comments — almost no coding required.
Jira
Worklogs
Optional Parameters
Fields id,key
Issue Key(s) or Ids - Comma Separated (CBS-10,PRA-13)
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Worklogs table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to read worklogs:

API Destination - Jira
Read and write Jira data effortlessly. Track, manage, and automate issues, projects, worklogs, and comments — almost no coding required.
Jira
Worklogs
Select, Lookup
Optional Parameters
Fields id,key
Issue Key(s) or Ids - Comma Separated (CBS-10,PRA-13)
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Read worklogs for issues by JQL

<p>Gets all worklogs for issues that match a JQL expression. The connector finds issues with the given JQL, then returns time entries for those issues. Use the same JQL syntax as in the “Read issues using JQL query” example.</p> 

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

Read worklogs

<p>Gets all worklog (time) entries from every issue. Use this when you need a single list of all time entries. To limit by issue or date, use the examples that filter by issue ID/Key, by JQL, or by modified-after date.</p> 

SELECT * FROM Worklogs

get_worklogs endpoint belongs to Worklogs 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 worklogs for issues by JQL

<p>Gets all worklogs for issues that match a JQL expression. The connector finds issues with the given JQL, then returns time entries for those issues. Use the same JQL syntax as in the “Read issues using JQL query” example.</p> 

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

EXEC (@MyQuery) AT [LS_TO_JIRA_IN_GATEWAY];

Read worklogs

<p>Gets all worklog (time) entries from every issue. Use this when you need a single list of all time entries. To limit by issue or date, use the examples that filter by issue ID/Key, by JQL, or by modified-after date.</p> 

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

EXEC (@MyQuery) AT [LS_TO_JIRA_IN_GATEWAY];

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