Worklogs

Provides full access to Jira worklogs. Supports creating, updating, deleting, and querying logged work hours on issues.

Table-Specific Information

SELECT

The connector uses the Jira API to process filters based on the IssueId, IssueKey, ProjectId, ProjectName, and Started columns. The connector processes all other filters client-side.

For example, the following queries are processed server-side:

SELECT * FROM Worklogs WHERE IssueId = 123;
SELECT * FROM Worklogs WHERE ProjectId = 10100;
SELECT * FROM Worklogs WHERE Started >= '2024-01-04' AND Started < '2024-02-03';

INSERT

Insert a worklog by specifying the following fields:

IssueId
Started
TimeSpentSeconds

INSERT INTO Worklogs (IssueId, Started, TimeSpentSeconds) VALUES (10003, '2017-03-20 20:00:00', 10000);

UPDATE

Update a worklog by specifying the Id and IssueId.

UPDATE Worklogs SET TimeSpentSeconds = 200000 WHERE Id = 10602 AND IssueId = 10003;

ADF Fields (REST_V3)

When the APIVersion connection property is set to REST_V3, the Comment_ADF column is available alongside Comment. Use Comment to insert or update a plain-text value, which the driver wraps into ADF format automatically. Use Comment_ADF to supply raw ADF JSON directly.

Insert a worklog with a plain-text comment (wrapped as ADF automatically):

INSERT INTO Worklogs (IssueId, Started, TimeSpentSeconds, Comment) VALUES (10003, '2024-01-15 09:00:00', 3600, 'Plain text comment');

Insert a worklog with a raw ADF JSON comment:

INSERT INTO Worklogs (IssueId, Started, TimeSpentSeconds, Comment_ADF) VALUES (10003, '2024-01-15 09:00:00', 3600, '{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"type":"text","text":"Raw ADF comment"}]}]}');

Update a worklog comment using plain text:

UPDATE Worklogs SET Comment = 'Updated comment' WHERE Id = 10602 AND IssueId = 10003;

Update a worklog comment using raw ADF JSON:

UPDATE Worklogs SET Comment_ADF = '{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"type":"text","text":"Updated ADF comment"}]}]}' WHERE Id = 10602 AND IssueId = 10003;

NOTE: Specifying both Comment and Comment_ADF in the same statement results in an error. Use one or the other.

DELETE

Delete a worklog by specifying the Id and IssueId.

DELETE FROM Worklogs WHERE Id = 10602 AND IssueId = 10003;

GETDELETED

This retrieves Ids of the deleted worklogs.

GETDELETED FROM Worklogs;

Columns


Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
Id [KEY]	String	True		=	Common	The unique identifier of the worklog entry used to distinguish it from all other worklogs in the system.
IssueId [KEY]	Integer	False	Issues.Id	=,!=,IN,NOT IN	Common	The internal numeric ID of the Jira issue associated with this worklog entry. This links the worklog to a specific issue.
IssueKey	String	False	Issues.Key	=,IN,NOT IN	Common	The human-readable key of the Jira issue (such as 'ABC-123') that this worklog entry pertains to.
ProjectId	Integer	True	Projects.Id	=,IS,IS NOT,IN,NOT IN	Common	The numeric ID of the project to which the issue belongs. This helps associate the worklog with a broader context.
ProjectName	String	True		=,IS,IS NOT,IN,NOT IN	Common	The name of the project that the associated issue and worklog entry belong to.
IssueCreatedDate	Datetime	True		=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The date and time when the issue associated with this worklog was originally created.
IssueUpdatedDate	Datetime	True		=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The date and time when the issue associated with this worklog was last updated.
AuthorDisplayName	String	True	Users.DisplayName	=,!=,IS,IS NOT,IN,NOT IN	Common	The display name of the user who initially created the worklog entry.
UpdateAuthorDisplayName	String	True	Users.DisplayName		Common	The display name of the user who most recently updated or modified the worklog entry.
Comment	String	False		=,LIKE	Common	The free-text comment or description added by the user to describe the work performed during this logged time.
Comment_ADF	String	False			Cloud	Raw Atlassian Document Format (ADF) JSON value of 'Comment'. Available only when the APIVersion connection property is set to REST_V3.
Created	Datetime	True			Common	The date and time when the worklog entry was created in Jira.
Updated	Datetime	True			Common	The date and time when the worklog entry was last modified.
VisibilityType	String	False			Common	The category of restriction that controls who can view this worklog entry, such as role-based or group-based visibility.
VisibilityValue	String	False			Common	The specific value used to enforce visibility restrictions, such as the name of the user role or group allowed to view the entry.
Started	Datetime	False		=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The exact date and time when the user began working, according to this logged work entry.
TimeSpent	String	False			Common	The total time spent on the issue, as logged in this worklog entry, formatted as a string (such as '3h 15m').
TimeSpentSeconds	Long	False			Common	The total time spent on the issue in seconds, useful for precise calculations and aggregations.
AuthorAccountId	String	True	Users.AccountId	=,!=,IS,IS NOT,IN,NOT IN	Cloud	The Atlassian account ID of the user who created the worklog, used for cross-product user identification.
UpdateAuthorAccountId	String	True	Users.AccountId		Cloud	The Atlassian account ID of the user who last updated the worklog, used for consistent tracking of changes.
AuthorAccountKey	String	True	Users.Key		Server	The legacy user key of the person who created the worklog entry. This field cannot be supported in newer Jira versions.
AuthorAccountName	String	True	Users.Name	=,!=,IS,IS NOT,IN,NOT IN	Server	The legacy username of the worklog creator. This value can be deprecated in favor of accountId.
UpdateAuthorAccountKey	String	True	Users.Key		Server	The legacy user key of the person who last updated the worklog entry. This value can be deprecated.
UpdateAuthorAccountName	String	True	Users.Name		Server	The legacy username of the user who last modified the worklog. This field cannot be supported in newer Jira versions.
ItemURL	String	True				A direct URL to view the specific worklog entry in the Jira UI, useful for navigation or reporting.

CData Python Connector for Jira