{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Issue Worklogs API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Issue Worklogs", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get Issue Worklogs", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/worklog", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue." }, { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "startedAfter", "value": "", "type": "query", "description": "The worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned." }, { "name": "startedBefore", "value": "", "type": "query", "description": "The worklog start date and time, as a UNIX timestamp in milliseconds, before which worklogs are returned." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts`properties`, which returns worklog properties." } ] }, "docs": "Returns worklogs for an issue, 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](https://confluence.atlassian.com/x/qoXKM).

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** Workloads are only returned where the user has:

* *Browse projects* [project permiss" }, { "info": { "name": "Atlassian Add Worklog", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/worklog", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key the issue." }, { "name": "notifyUsers", "value": "", "type": "query", "description": "Whether users watching the issue are notified by email." }, { "name": "adjustEstimate", "value": "", "type": "query", "description": "Defines how to update the issue's time estimate, the options are:\n\n * `new` Sets the estimate to a specific value, defined in `newEstimate`.\n * `leave` Leaves the estimate unchanged.\n * `manual` Reduces the estimate by amount specified in `reduceBy`.\n * `auto` Reduces the estimate by the value of `timeSpent` in the worklog." }, { "name": "newEstimate", "value": "", "type": "query", "description": "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`." }, { "name": "reduceBy", "value": "", "type": "query", "description": "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`." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts `properties`, which returns worklog properties." }, { "name": "overrideEditableFlag", "value": "", "type": "query", "description": "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](https://confluence.atlassian.com/x/x4dKLg) can use this flag." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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](https://confluence.atlassian.com/x/qoXKM).

This operation can be accessed anonymously.

**[Permissions](#permissions) required:**

* *Browse projects* and *Work on issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](h" }, { "info": { "name": "Atlassian Get Worklog", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/worklog/:id", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the worklog." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts\n\n`properties`, which returns worklog properties." } ] }, "docs": "Returns a worklog.

Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM).

This operation can be accessed anonymously.

**[Permissions](#permissions) required:**

* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.co" }, { "info": { "name": "Atlassian Update Worklog", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/worklog/:id", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key the issue." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the worklog." }, { "name": "notifyUsers", "value": "", "type": "query", "description": "Whether users watching the issue are notified by email." }, { "name": "adjustEstimate", "value": "", "type": "query", "description": "Defines how to update the issue's time estimate, the options are:\n\n * `new` Sets the estimate to a specific value, defined in `newEstimate`.\n * `leave` Leaves the estimate unchanged.\n * `auto` Updates the estimate by the difference between the original and updated value of `timeSpent` or `timeSpentSeconds`." }, { "name": "newEstimate", "value": "", "type": "query", "description": "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`." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts `properties`, which returns worklog properties." }, { "name": "overrideEditableFlag", "value": "", "type": "query", "description": "Whether 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](https://confluence.atlassian.com/x/x4dKLg) can use this flag." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a worklog.

Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM).

This operation can be accessed anonymously.

**[Permissions](#permissions) required:**

* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.co" }, { "info": { "name": "Atlassian Delete Worklog", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/worklog/:id", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the worklog." }, { "name": "notifyUsers", "value": "", "type": "query", "description": "Whether users watching the issue are notified by email." }, { "name": "adjustEstimate", "value": "", "type": "query", "description": "Defines how to update the issue's time estimate, the options are:\n\n * `new` Sets the estimate to a specific value, defined in `newEstimate`.\n * `leave` Leaves the estimate unchanged.\n * `manual` Increases the estimate by amount specified in `increaseBy`.\n * `auto` Reduces the estimate by the value of `timeSpent` in the worklog." }, { "name": "newEstimate", "value": "", "type": "query", "description": "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`." }, { "name": "increaseBy", "value": "", "type": "query", "description": "The 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`." }, { "name": "overrideEditableFlag", "value": "", "type": "query", "description": "Whether 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." } ] }, "docs": "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](https://confluence.atlassian.com/x/qoXKM).

This operation can be accessed anonymously.

**[Permissions](#permissions) required:**

* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluenc" }, { "info": { "name": "Atlassian Get Ids Of Deleted Worklogs", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/worklog/deleted", "params": [ { "name": "since", "value": "", "type": "query", "description": "The date and time, as a UNIX timestamp in milliseconds, after which deleted worklogs are returned." } ] }, "docs": "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 r" }, { "info": { "name": "Atlassian Get Worklogs", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/worklog/list", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts `properties` that returns the properties of each worklog." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns worklog details for a list of worklog IDs.

The returned list of worklogs is limited to 1000 items.

**[Permissions](#permissions) required:** Permission to access Jira, however, worklogs are only returned where either of the following is true:

* the worklog is set as *Viewable by All Users*.
* the user is a member of a project role or group with permission to view the worklog." }, { "info": { "name": "Atlassian Get Ids Of Updated Worklogs", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/worklog/updated", "params": [ { "name": "since", "value": "", "type": "query", "description": "The date and time, as a UNIX timestamp in milliseconds, after which updated worklogs are returned." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts `properties` that returns the properties of each worklog." } ] }, "docs": "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 r" } ] } ], "bundled": true }