Add worklog

POST

/rest/api/3/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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/issue//worklog' \
--header 'Content-Type: application/json' \
--data-raw '{
    "comment": {
        "content": [
            {
                "content": [
                    {
                        "text": "I did some work here.",
                        "type": "text"
                    }
                ],
                "type": "paragraph"
            }
        ],
        "type": "doc",
        "version": 1
    },
    "started": "2021-01-17T12:34:00.000+0000",
    "timeSpentSeconds": 12000,
    "visibility": {
        "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
        "type": "group"
    }
}'

Response Example

201 - Example 1

{
    "author": {},
    "comment": null,
    "created": "2019-08-24T14:15:22Z",
    "id": "string",
    "issueId": "string",
    "properties": [
        {
            "key": "string",
            "value": null
        }
    ],
    "self": "http://example.com",
    "started": "2019-08-24T14:15:22Z",
    "timeSpent": "string",
    "timeSpentSeconds": 0,
    "updateAuthor": {},
    "updated": "2019-08-24T14:15:22Z",
    "visibility": {
        "identifier": "string",
        "type": "group",
        "value": "string"
    }
}

Request

Path Params

issueIdOrKey

string

required

The ID or key the issue.

Query Params

notifyUsers

string

optional

Whether users watching the issue are notified by email.

adjustEstimate

string

optional

Defines 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.

newEstimate

string

optional

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 adjustEstimate is new.

reduceBy

string

optional

The 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.

expand

string

optional

Use expand to include additional information about work logs in the response. This parameter accepts properties, which returns worklog properties.

overrideEditableFlag

string

optional

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.

Body Params application/json

Details of a worklog.

comment

optional

A comment about the worklog in Atlassian Document Format. Optional when creating or updating a worklog.

properties

array[object (EntityProperty) {2}]

optional

Details of properties for the worklog. Optional when creating or updating a worklog.

key

string

optional

The key of the property. Required on create and update.

value

optional

The value of the property. Required on create and update.

started

string <date-time>

optional

The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.

timeSpent

string

optional

The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a worklog if timeSpentSeconds isn't provided. Optional when updating a worklog. Cannot be provided if timeSpentSecond is provided.

timeSpentSeconds

integer <int64>

optional

The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided.

visibility

object

optional

Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog.

identifier

string | null

optional

The ID of the group or the name of the role that visibility of this item is restricted to.

type

enum<string>

optional

Whether visibility of this item is restricted to a group or role.

Allowed values:

grouprole

value

string

optional

The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier.

Additional properties

integer | number | string | boolean

optional

Additional properties

integer | number | string | boolean

optional

Examples

Responses

🟢201Returned if the request is successful.

application/json

Body

Details of a worklog.

author

object

read-onlyoptional

Details of the user who created the worklog.

comment

optional

A comment about the worklog in Atlassian Document Format. Optional when creating or updating a worklog.

created

string <date-time>

read-onlyoptional

The datetime on which the worklog was created.

string

read-onlyoptional

The ID of the worklog record.

issueId

string

read-onlyoptional

The ID of the issue this worklog is for.

properties

array[object (EntityProperty) {2}]

optional

Details of properties for the worklog. Optional when creating or updating a worklog.

key

string

optional

The key of the property. Required on create and update.

value

optional

The value of the property. Required on create and update.

self

string <uri>

read-onlyoptional

The URL of the worklog item.

started

string <date-time>

optional

The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.

timeSpent

string

optional

timeSpentSeconds

integer <int64>

optional

The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided.

updateAuthor

object

read-onlyoptional

Details of the user who last updated the worklog.

updated

string <date-time>

read-onlyoptional

The datetime on which the worklog was last updated.

visibility

object

optional

Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog.

identifier

string | null

optional

The ID of the group or the name of the role that visibility of this item is restricted to.

type

enum<string>

optional

Whether visibility of this item is restricted to a group or role.

Allowed values:

grouprole

value

string

optional

The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier.

Additional properties

integer | number | string | boolean

optional

Additional properties

integer | number | string | boolean

optional

🟠400Returned if: * `adjustEstimate` is set to `new` but `newEstimate` is not provided or is invalid. * `adjustEstimate` is set to `manual` but `reduceBy` is not provided or is invalid. * the user does not have permission to add the worklog. * the req

🟠401Returned if the authentication credentials are incorrect.

🟠404Returned if the issue is not found or the user does not have permission to view it.

Modified at 2023-07-13 03:27:27

Get issue worklogs

Get worklog