Liking cljdoc? Tell your friends :D

atlassian.jira.bulk

Jira Cloud bulk issue operations.

All functions delegate to atlassian.jira.client/request. Build a client with (atlassian.jira.client/client) and pass it as the first argument.

Write operations accept a body map and an optional opts map for query params. Read operations accept an optional opts map.

Jira Cloud bulk issue operations.

All functions delegate to `atlassian.jira.client/request`. Build a client
with `(atlassian.jira.client/client)` and pass it as the first argument.

Write operations accept a `body` map and an optional `opts` map for query
params. Read operations accept an optional `opts` map.
raw docstring

get-available-transitionsclj

(get-available-transitions client opts)

Get available transitions for a set of issues. GET /rest/api/3/bulk/issues/transition

Required query param: issueIdsOrKeys (comma-separated IDs or keys). Optional: endingBefore, startingAfter (pagination cursors). Pass all as keys in opts, e.g. {:issueIdsOrKeys "PROJ-1,PROJ-2"}.

Get available transitions for a set of issues.
GET /rest/api/3/bulk/issues/transition

Required query param: issueIdsOrKeys (comma-separated IDs or keys).
Optional: endingBefore, startingAfter (pagination cursors).
Pass all as keys in opts, e.g. {:issueIdsOrKeys "PROJ-1,PROJ-2"}.
sourceraw docstring

get-bulk-editable-fieldsclj

(get-bulk-editable-fields client opts)

Get bulk editable fields — returns fields that can be edited across the given issues. GET /rest/api/3/bulk/issues/fields

Required query param: issueIdsOrKeys (comma-separated IDs or keys). Optional: searchText, endingBefore, startingAfter (pagination cursors). Pass all as keys in opts, e.g. {:issueIdsOrKeys "PROJ-1,PROJ-2"}.

Get bulk editable fields — returns fields that can be edited across the given issues.
GET /rest/api/3/bulk/issues/fields

Required query param: issueIdsOrKeys (comma-separated IDs or keys).
Optional: searchText, endingBefore, startingAfter (pagination cursors).
Pass all as keys in opts, e.g. {:issueIdsOrKeys "PROJ-1,PROJ-2"}.
sourceraw docstring

get-bulk-operation-progressclj

(get-bulk-operation-progress client task-id)
(get-bulk-operation-progress client task-id opts)

Get bulk issue operation progress for a queued task. GET /rest/api/3/bulk/queue/{taskId}

Path params: task-id — the ID of the async bulk task.

Get bulk issue operation progress for a queued task.
GET /rest/api/3/bulk/queue/{taskId}

Path params:
  task-id — the ID of the async bulk task.
sourceraw docstring

submit-bulk-deleteclj

(submit-bulk-delete client body)
(submit-bulk-delete client body opts)

Bulk delete issues. POST /rest/api/3/bulk/issues/delete

Body: IssueBulkDeletePayload {:selectedIssueIdsOrKeys ["PROJ-1" "PROJ-2"] ; required :sendBulkNotification true} ; optional, default true

Bulk delete issues.
POST /rest/api/3/bulk/issues/delete

Body: IssueBulkDeletePayload
  {:selectedIssueIdsOrKeys ["PROJ-1" "PROJ-2"]  ; required
   :sendBulkNotification   true}                   ; optional, default true
sourceraw docstring

submit-bulk-editclj

(submit-bulk-edit client body)
(submit-bulk-edit client body opts)

Bulk edit issues. POST /rest/api/3/bulk/issues/fields

Body: IssueBulkEditPayload {:selectedIssueIdsOrKeys ["PROJ-1"] ; required :selectedActions ["summary"] ; field IDs to edit, required :editedFieldsInput {...} ; field values, required :sendBulkNotification true} ; optional, default true

Bulk edit issues.
POST /rest/api/3/bulk/issues/fields

Body: IssueBulkEditPayload
  {:selectedIssueIdsOrKeys ["PROJ-1"]  ; required
   :selectedActions        ["summary"] ; field IDs to edit, required
   :editedFieldsInput      {...}         ; field values, required
   :sendBulkNotification   true}         ; optional, default true
sourceraw docstring

submit-bulk-moveclj

(submit-bulk-move client body)
(submit-bulk-move client body opts)

Bulk move issues to a different project/issue-type. POST /rest/api/3/bulk/issues/move

Body: IssueBulkMovePayload {:targetToSourcesMapping {"<projectId>,<issueTypeId>" {...}} ; required :sendBulkNotification true} ; optional, default true

The mapping key format is "<destProjectIdOrKey>,<destIssueTypeId>" (append ",<parentIdOrKey>" when moving to a subtask type).

Bulk move issues to a different project/issue-type.
POST /rest/api/3/bulk/issues/move

Body: IssueBulkMovePayload
  {:targetToSourcesMapping {"<projectId>,<issueTypeId>" {...}}  ; required
   :sendBulkNotification   true}                                 ; optional, default true

The mapping key format is "<destProjectIdOrKey>,<destIssueTypeId>" (append
",<parentIdOrKey>" when moving to a subtask type).
sourceraw docstring

submit-bulk-transitionclj

(submit-bulk-transition client body)
(submit-bulk-transition client body opts)

Bulk transition issue statuses. POST /rest/api/3/bulk/issues/transition

Body: IssueBulkTransitionPayload {:bulkTransitionInputs [{:issueIdsOrKeys ["PROJ-1"] ; issues to transition :transitionId "31"}] ; target transition ID :sendBulkNotification true} ; optional, default true

Bulk transition issue statuses.
POST /rest/api/3/bulk/issues/transition

Body: IssueBulkTransitionPayload
  {:bulkTransitionInputs  [{:issueIdsOrKeys ["PROJ-1"]  ; issues to transition
                            :transitionId   "31"}]      ; target transition ID
   :sendBulkNotification  true}                          ; optional, default true
sourceraw docstring

submit-bulk-unwatchclj

(submit-bulk-unwatch client body)
(submit-bulk-unwatch client body opts)

Bulk unwatch issues. POST /rest/api/3/bulk/issues/unwatch

Body: IssueBulkWatchOrUnwatchPayload {:selectedIssueIdsOrKeys ["PROJ-1" "PROJ-2"]} ; required

Bulk unwatch issues.
POST /rest/api/3/bulk/issues/unwatch

Body: IssueBulkWatchOrUnwatchPayload
  {:selectedIssueIdsOrKeys ["PROJ-1" "PROJ-2"]}  ; required
sourceraw docstring

submit-bulk-watchclj

(submit-bulk-watch client body)
(submit-bulk-watch client body opts)

Bulk watch issues. POST /rest/api/3/bulk/issues/watch

Body: IssueBulkWatchOrUnwatchPayload {:selectedIssueIdsOrKeys ["PROJ-1" "PROJ-2"]} ; required

Bulk watch issues.
POST /rest/api/3/bulk/issues/watch

Body: IssueBulkWatchOrUnwatchPayload
  {:selectedIssueIdsOrKeys ["PROJ-1" "PROJ-2"]}  ; required
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close