Jira Cloud worklog, time-tracking, and worklog-property endpoint functions.
Covers:
Every function takes a client built by atlassian.jira.client/client as
its first argument. Required path params follow; an optional opts map (query
params) or a body map (request body) trail at the end per the contract.
Jira Cloud worklog, time-tracking, and worklog-property endpoint functions. Covers: - Issue worklogs (CRUD, bulk delete/move, list by ID) - Worklog change feeds (deleted/updated since) - Time tracking configuration - Worklog entity properties Every function takes a `client` built by `atlassian.jira.client/client` as its first argument. Required path params follow; an optional `opts` map (query params) or a `body` map (request body) trail at the end per the contract.
(add-worklog client issue-id-or-key body)(add-worklog client issue-id-or-key body opts)Add worklog to an issue. POST /rest/api/3/issue/{issueIdOrKey}/worklog Path params: issueIdOrKey — the issue ID or key. Body: Worklog — {:timeSpent "2h" :started "2024-01-15T09:00:00.000+0000" :comment <ADF-doc> (see atlassian.jira.adf/text->adf)} opts: notifyUsers, adjustEstimate, newEstimate, reduceBy, expand, overrideEditableFlag
Add worklog to an issue.
POST /rest/api/3/issue/{issueIdOrKey}/worklog
Path params: issueIdOrKey — the issue ID or key.
Body: Worklog — {:timeSpent "2h" :started "2024-01-15T09:00:00.000+0000"
:comment <ADF-doc> (see atlassian.jira.adf/text->adf)}
opts: notifyUsers, adjustEstimate, newEstimate, reduceBy, expand, overrideEditableFlag(bulk-delete-worklogs client issue-id-or-key body)(bulk-delete-worklogs client issue-id-or-key body opts)Bulk delete worklogs for an issue. DELETE /rest/api/3/issue/{issueIdOrKey}/worklog Path params: issueIdOrKey — the issue ID or key. Body: WorklogIdsRequestBean — {:ids [<worklog-id> ...]}
Bulk delete worklogs for an issue.
DELETE /rest/api/3/issue/{issueIdOrKey}/worklog
Path params: issueIdOrKey — the issue ID or key.
Body: WorklogIdsRequestBean — {:ids [<worklog-id> ...]}(bulk-move-worklogs client issue-id-or-key body)(bulk-move-worklogs client issue-id-or-key body opts)Bulk move worklogs to a different issue. POST /rest/api/3/issue/{issueIdOrKey}/worklog/move Path params: issueIdOrKey — source issue ID or key. Body: WorklogsMoveRequestBean — {:ids [<worklog-id> ...] :issueIdOrKey "DEST-123"} opts: adjustEstimate, overrideEditableFlag
Bulk move worklogs to a different issue.
POST /rest/api/3/issue/{issueIdOrKey}/worklog/move
Path params: issueIdOrKey — source issue ID or key.
Body: WorklogsMoveRequestBean — {:ids [<worklog-id> ...] :issueIdOrKey "DEST-123"}
opts: adjustEstimate, overrideEditableFlag(delete-worklog client issue-id-or-key id)(delete-worklog client issue-id-or-key id opts)Delete a worklog entry. DELETE /rest/api/3/issue/{issueIdOrKey}/worklog/{id} Path params: issueIdOrKey — the issue ID or key; id — the worklog ID. opts: notifyUsers, adjustEstimate, newEstimate, increaseBy, overrideEditableFlag
Delete a worklog entry.
DELETE /rest/api/3/issue/{issueIdOrKey}/worklog/{id}
Path params: issueIdOrKey — the issue ID or key; id — the worklog ID.
opts: notifyUsers, adjustEstimate, newEstimate, increaseBy, overrideEditableFlag(delete-worklog-property client issue-id-or-key worklog-id property-key)Delete a worklog property. DELETE /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey} Path params: issueIdOrKey — the issue ID or key; worklogId — the worklog ID; propertyKey — the property key.
Delete a worklog property.
DELETE /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}
Path params: issueIdOrKey — the issue ID or key; worklogId — the worklog ID;
propertyKey — the property key.(get-available-time-tracking-implementations client)Get all time tracking providers. GET /rest/api/3/configuration/timetracking/list
Get all time tracking providers. GET /rest/api/3/configuration/timetracking/list
(get-ids-of-worklogs-deleted-since client)(get-ids-of-worklogs-deleted-since client opts)Get IDs of deleted worklogs since a given UNIX timestamp (ms). GET /rest/api/3/worklog/deleted opts: since — UNIX timestamp in milliseconds
Get IDs of deleted worklogs since a given UNIX timestamp (ms). GET /rest/api/3/worklog/deleted opts: since — UNIX timestamp in milliseconds
(get-ids-of-worklogs-modified-since client)(get-ids-of-worklogs-modified-since client opts)Get IDs of updated worklogs since a given UNIX timestamp (ms). GET /rest/api/3/worklog/updated opts: since — UNIX timestamp in milliseconds; expand
Get IDs of updated worklogs since a given UNIX timestamp (ms). GET /rest/api/3/worklog/updated opts: since — UNIX timestamp in milliseconds; expand
(get-issue-worklog client issue-id-or-key)(get-issue-worklog client issue-id-or-key opts)Get issue worklogs. GET /rest/api/3/issue/{issueIdOrKey}/worklog Path params: issueIdOrKey — the issue ID or key. opts: startAt, maxResults, startedAfter, startedBefore, expand
Get issue worklogs.
GET /rest/api/3/issue/{issueIdOrKey}/worklog
Path params: issueIdOrKey — the issue ID or key.
opts: startAt, maxResults, startedAfter, startedBefore, expand(get-selected-time-tracking-implementation client)Get selected time tracking provider. GET /rest/api/3/configuration/timetracking
Get selected time tracking provider. GET /rest/api/3/configuration/timetracking
(get-shared-time-tracking-configuration client)Get time tracking settings. GET /rest/api/3/configuration/timetracking/options
Get time tracking settings. GET /rest/api/3/configuration/timetracking/options
(get-worklog client issue-id-or-key id)(get-worklog client issue-id-or-key id opts)Get a worklog entry. GET /rest/api/3/issue/{issueIdOrKey}/worklog/{id} Path params: issueIdOrKey — the issue ID or key; id — the worklog ID. opts: expand
Get a worklog entry.
GET /rest/api/3/issue/{issueIdOrKey}/worklog/{id}
Path params: issueIdOrKey — the issue ID or key; id — the worklog ID.
opts: expand(get-worklog-property client issue-id-or-key worklog-id property-key)Get a worklog property. GET /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey} Path params: issueIdOrKey — the issue ID or key; worklogId — the worklog ID; propertyKey — the property key.
Get a worklog property.
GET /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}
Path params: issueIdOrKey — the issue ID or key; worklogId — the worklog ID;
propertyKey — the property key.(get-worklog-property-keys client issue-id-or-key worklog-id)Get worklog property keys. GET /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties Path params: issueIdOrKey — the issue ID or key; worklogId — the worklog ID.
Get worklog property keys.
GET /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties
Path params: issueIdOrKey — the issue ID or key; worklogId — the worklog ID.(get-worklogs-for-ids client body)(get-worklogs-for-ids client body opts)Get worklogs by a list of IDs. POST /rest/api/3/worklog/list Body: WorklogIdsRequestBean — {:ids [<worklog-id> ...]} opts: expand
Get worklogs by a list of IDs.
POST /rest/api/3/worklog/list
Body: WorklogIdsRequestBean — {:ids [<worklog-id> ...]}
opts: expand(select-time-tracking-implementation client body)Select time tracking provider. PUT /rest/api/3/configuration/timetracking Body: TimeTrackingProvider — {:key "JIRA"} (name, url optional)
Select time tracking provider.
PUT /rest/api/3/configuration/timetracking
Body: TimeTrackingProvider — {:key "JIRA"} (name, url optional)(set-shared-time-tracking-configuration client body)Set time tracking settings. PUT /rest/api/3/configuration/timetracking/options Body: TimeTrackingConfiguration — {:defaultUnit "hour" :timeFormat "pretty" :workingDaysPerWeek 5.0 :workingHoursPerDay 8.0}
Set time tracking settings.
PUT /rest/api/3/configuration/timetracking/options
Body: TimeTrackingConfiguration — {:defaultUnit "hour"
:timeFormat "pretty"
:workingDaysPerWeek 5.0
:workingHoursPerDay 8.0}(set-worklog-property client issue-id-or-key worklog-id property-key body)Set a worklog property. Value is an arbitrary JSON-serialisable value. PUT /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey} Path params: issueIdOrKey — the issue ID or key; worklogId — the worklog ID; propertyKey — the property key (max 255 chars). Body: any JSON-serialisable value.
Set a worklog property. Value is an arbitrary JSON-serialisable value.
PUT /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}
Path params: issueIdOrKey — the issue ID or key; worklogId — the worklog ID;
propertyKey — the property key (max 255 chars).
Body: any JSON-serialisable value.(update-worklog client issue-id-or-key id body)(update-worklog client issue-id-or-key id body opts)Update a worklog entry. PUT /rest/api/3/issue/{issueIdOrKey}/worklog/{id} Path params: issueIdOrKey — the issue ID or key; id — the worklog ID. Body: Worklog — {:timeSpent "2h" :started "2024-01-15T09:00:00.000+0000" :comment <ADF-doc> (see atlassian.jira.adf/text->adf)} opts: notifyUsers, adjustEstimate, newEstimate, expand, overrideEditableFlag
Update a worklog entry.
PUT /rest/api/3/issue/{issueIdOrKey}/worklog/{id}
Path params: issueIdOrKey — the issue ID or key; id — the worklog ID.
Body: Worklog — {:timeSpent "2h" :started "2024-01-15T09:00:00.000+0000"
:comment <ADF-doc> (see atlassian.jira.adf/text->adf)}
opts: notifyUsers, adjustEstimate, newEstimate, expand, overrideEditableFlagcljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |