Internal
Create a new instance of the service.
Adds a worklog to an issue.
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
This operation can be accessed anonymously.
Permissions required:
Optional
adjustDefines how to update the issue's time estimate, the options are:
new
Sets the estimate to a specific value, defined in newEstimate
.leave
Leaves the estimate unchanged.manual
Reduces the estimate by amount specified in reduceBy
.auto
Reduces the estimate by the value of timeSpent
in the worklog.Optional
expand?: stringUse expand to include additional information about work logs in
the response. This parameter accepts properties
, which returns worklog
properties.
The ID or key the issue.
Optional
newThe value to set as the issue's remaining time estimate, as days (#d), hours
(#h), or minutes (#m or #). For example, 2d. Required when
adjustEstimate
is new
.
Optional
notifyWhether users watching the issue are notified by email.
Optional
overrideWhether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with Administer Jira global permission can use this flag.
Optional
reduceThe amount to reduce the issue's remaining estimate by, as days (#d), hours
(#h), or minutes (#m). For example, 2d. Required when adjustEstimate
is
manual
.
Returned if the request is successful.
Deletes a list of worklogs from an issue. This is an experimental API with limitations:
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
Permissions required:
Optional
adjustDefines how to update the issue's time estimate, the options are:
leave
Leaves the estimate unchanged.auto
Reduces the estimate by the aggregate value of timeSpent
across
all worklogs being deleted.The ID or key of the issue.
Optional
overrideWhether the work log entries should be removed to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with admin permission can use this flag.
A JSON object containing a list of worklog IDs.
DELETE /rest/api/3/issue/{issueIdOrKey}/worklog
@scopes-current write:jira-work
@scopes-beta delete:issue-worklog:jira, delete:issue-worklog.property:jira, write:issue.time-tracking:jira, read:group:jira, read:issue-worklog:jira, read:project-role:jira, read:user:jira, read:issue-worklog.property:jira
Moves a list of worklogs from one issue to another. This is an experimental API with several limitations:
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
Permissions required:
Optional
adjustDefines how to update the issues' time estimate, the options are:
leave
Leaves the estimate unchanged.auto
Reduces the estimate by the aggregate value of timeSpent
across
all worklogs being moved in the source issue, and increases it in the
destination issue.Optional
overrideWhether the work log entry should be moved to and from the issues even if the issues are not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with admin permission can use this flag.
A JSON object containing a list of worklog IDs and the ID or key of the destination issue.
POST /rest/api/3/issue/{issueIdOrKey}/worklog/move
@scopes-current write:jira-work
@scopes-beta read:issue-worklog:jira, write:issue-worklog:jira, delete:issue-worklog:jira, read:issue-worklog.property:jira, write:issue-worklog.property:jira, delete:issue-worklog.property:jira, write:issue.time-tracking:jira, read:group:jira, read:project-role:jira, read:user:jira
Deletes a worklog from an issue.
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
This operation can be accessed anonymously.
Permissions required:
Optional
adjustDefines how to update the issue's time estimate, the options are:
new
Sets the estimate to a specific value, defined in newEstimate
.leave
Leaves the estimate unchanged.manual
Increases the estimate by amount specified in increaseBy
.auto
Reduces the estimate by the value of timeSpent
in the worklog.The ID of the worklog.
Optional
increaseThe amount to increase the issue's remaining estimate by, as days (#d), hours
(#h), or minutes (#m or #). For example, 2d. Required when
adjustEstimate
is manual
.
The ID or key of the issue.
Optional
newThe value to set as the issue's remaining time estimate, as days (#d), hours
(#h), or minutes (#m or #). For example, 2d. Required when
adjustEstimate
is new
.
Optional
notifyWhether users watching the issue are notified by email.
Optional
overrideWhether the work log entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with admin permission can use this flag.
Returns a list of IDs and delete timestamps for worklogs deleted after a date and time.
This resource is paginated, with a limit of 1000 worklogs per page. Each page
lists worklogs from oldest to youngest. If the number of items in the date
range exceeds 1000, until
indicates the timestamp of the youngest item on the
page. Also, nextPage
provides the URL for the next page of worklogs. The
lastPage
parameter is set to true on the last page of worklogs.
This resource does not return worklogs deleted during the minute preceding the request.
Permissions required: Permission to access Jira.
Optional
since?: numberThe date and time, as a UNIX timestamp in milliseconds, after which deleted worklogs are returned.
Returned if the request is successful.
example:
{
"lastPage": true,
"nextPage": "https://your-domain.atlassian.net/api/~ver~/worklog/deleted?since=1438013693136",
"self": "https://your-domain.atlassian.net/api/~ver~/worklog/deleted?since=1438013671562",
"since": 1438013671562,
"until": 1438013693136,
"values": [
{
"properties": [],
"updatedTime": 1438013671562,
"worklogId": 103
},
{
"properties": [],
"updatedTime": 1438013672165,
"worklogId": 104
},
{
"properties": [],
"updatedTime": 1438013693136,
"worklogId": 105
}
]
}
Returns a list of IDs and update timestamps for worklogs updated after a date and time.
This resource is paginated, with a limit of 1000 worklogs per page. Each page
lists worklogs from oldest to youngest. If the number of items in the date
range exceeds 1000, until
indicates the timestamp of the youngest item on the
page. Also, nextPage
provides the URL for the next page of worklogs. The
lastPage
parameter is set to true on the last page of worklogs.
This resource does not return worklogs updated during the minute preceding the request.
Permissions required: Permission to access Jira, however, worklogs are only returned where either of the following is true:
Optional
expand?: stringUse expand to include additional information about worklogs in
the response. This parameter accepts properties
that returns the properties
of each worklog.
Optional
since?: numberThe date and time, as a UNIX timestamp in milliseconds, after which updated worklogs are returned.
Returned if the request is successful.
example:
{
"lastPage": true,
"nextPage": "https://your-domain.atlassian.net/api/~ver~/worklog/updated?since=1438013693136",
"self": "https://your-domain.atlassian.net/api/~ver~/worklog/updated?since=1438013671562",
"since": 1438013671562,
"until": 1438013693136,
"values": [
{
"properties": [],
"updatedTime": 1438013671562,
"worklogId": 103
},
{
"properties": [],
"updatedTime": 1438013672165,
"worklogId": 104
},
{
"properties": [],
"updatedTime": 1438013693136,
"worklogId": 105
}
]
}
Returns worklogs for an issue (ordered by created time), starting from the oldest worklog or from the worklog started on or after a date and time.
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
This operation can be accessed anonymously.
Permissions required: Workloads are only returned where the user has:
Optional
expand?: stringUse expand to include additional information about worklogs in
the response. This parameter acceptsproperties
, which returns worklog
properties.
The ID or key of the issue.
Optional
maxThe maximum number of items to return per page.
Optional
startThe index of the first item to return in a page of results (page offset).
Optional
startedThe worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned.
Optional
startedThe worklog start date and time, as a UNIX timestamp in milliseconds, before which worklogs are returned.
Returned if the request is successful
example:
{
"maxResults": 1,
"startAt": 0,
"total": 1,
"worklogs": [
{
"author": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"comment": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "I did some work here."
}
]
}
]
},
"id": "100028",
"issueId": "10002",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
"started": "2021-01-17T12:34:00.000+0000",
"timeSpent": "3h 20m",
"timeSpentSeconds": 12000,
"updateAuthor": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"updated": "2021-01-18T23:45:00.000+0000",
"visibility": {
"identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
"type": "group",
"value": "jira-developers"
}
}
]
}
Returns a worklog.
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
This operation can be accessed anonymously.
Permissions required:
Optional
expand?: stringUse expand to include additional information about work logs in the response. This parameter accepts
properties
, which returns worklog properties.
The ID of the worklog.
The ID or key of the issue.
Returned if the request is successful.
example:
{
"author": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"comment": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "I did some work here."
}
]
}
]
},
"id": "100028",
"issueId": "10002",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
"started": "2021-01-17T12:34:00.000+0000",
"timeSpent": "3h 20m",
"timeSpentSeconds": 12000,
"updateAuthor": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"updated": "2021-01-18T23:45:00.000+0000",
"visibility": {
"identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
"type": "group",
"value": "jira-developers"
}
}
Returns worklog details for a list of worklog IDs.
The returned list of worklogs is limited to 1000 items.
Permissions required: Permission to access Jira, however, worklogs are only returned where either of the following is true:
Optional
expand?: stringUse expand to include additional information about worklogs in
the response. This parameter accepts properties
that returns the properties
of each worklog.
A JSON object containing a list of worklog IDs.
Returned if the request is successful.
example:
[
{
"author": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"comment": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "I did some work here."
}
]
}
]
},
"id": "100028",
"issueId": "10002",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
"started": "2021-01-17T12:34:00.000+0000",
"timeSpent": "3h 20m",
"timeSpentSeconds": 12000,
"updateAuthor": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"updated": "2021-01-18T23:45:00.000+0000",
"visibility": {
"identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
"type": "group",
"value": "jira-developers"
}
}
]
Updates a worklog.
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
This operation can be accessed anonymously.
Permissions required:
Optional
adjustDefines how to update the issue's time estimate, the options are:
new
Sets the estimate to a specific value, defined in newEstimate
.leave
Leaves the estimate unchanged.auto
Updates the estimate by the difference between the original and
updated value of timeSpent
or timeSpentSeconds
.Optional
expand?: stringUse expand to include additional information about worklogs in
the response. This parameter accepts properties
, which returns worklog
properties.
The ID of the worklog.
The ID or key the issue.
Optional
newThe value to set as the issue's remaining time estimate, as days (#d), hours
(#h), or minutes (#m or #). For example, 2d. Required when
adjustEstimate
is new
.
Optional
notifyWhether users watching the issue are notified by email.
Optional
overrideWhether the worklog should be added to the issue even if the issue is not editable. For example, because the issue is closed. Connect and Forge app users with Administer Jira global permission can use this flag.
Returned if the request is successful
example:
{
"author": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"comment": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "I did some work here."
}
]
}
]
},
"id": "100028",
"issueId": "10002",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
"started": "2021-01-17T12:34:00.000+0000",
"timeSpent": "3h 20m",
"timeSpentSeconds": 12000,
"updateAuthor": {
"accountId": "5b10a2844c20165700ede21g",
"active": false,
"displayName": "Mia Krystof",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
},
"updated": "2021-01-18T23:45:00.000+0000",
"visibility": {
"identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
"type": "group",
"value": "jira-developers"
}
}
PUT /rest/api/3/issue/{issueIdOrKey}/worklog/{id}
@scopes-current write:jira-work
@scopes-beta read:comment:jira, read:group:jira, read:issue-worklog:jira, read:issue-worklog.property:jira, read:project-role:jira, read:user:jira, write:comment:jira, write:issue-worklog:jira, write:issue-worklog.property:jira, read:avatar:jira
Protected
Static
initialize
This resource represents issue worklogs. Use it to:
See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs