POST /rest/api/2/issue/{issueIdOrKey}/worklog
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:
- Browse projects and Work on issues project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Servers
- https://your-domain.atlassian.net
Path parameters
Name | Type | Required | Description |
---|---|---|---|
issueIdOrKey |
String | Yes |
The ID or key the issue. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
notifyUsers |
Boolean | No |
Whether users watching the issue are notified by email. Default value: true |
newEstimate |
String | No |
The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when |
expand |
String | No |
Use expand to include additional information about work logs in the response. This parameter accepts |
overrideEditableFlag |
Boolean | No |
Whether 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. Default value: false |
adjustEstimate |
String | No |
Defines how to update the issue's time estimate, the options are:
Possible values:
Default value: "auto" |
reduceBy |
String | No |
The amount to reduce the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m). For example, 2d. Required when |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
id |
String | No |
The ID of the worklog record. |
comment |
String | No |
A comment about the worklog. Optional when creating or updating a worklog. |
timeSpent |
String | No |
The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a worklog if |
created |
String | No |
The datetime on which the worklog was created. |
self |
String | No |
The URL of the worklog item. |
properties[] |
Array | No |
Details of properties for the worklog. Optional when creating or updating a worklog. |
properties[].key |
String | No |
The key of the property. Required on create and update. |
properties[].value |
No |
The value of the property. Required on create and update. |
|
updated |
String | No |
The datetime on which the worklog was last updated. |
started |
String | No |
The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog. |
timeSpentSeconds |
Integer | No |
The time in seconds spent working on the issue. Required when creating a worklog if |
issueId |
String | No |
The ID of the issue this worklog is for. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.