Liking cljdoc? Tell your friends :D

atlassian.jira.attachments

Jira Cloud Issue Attachments API endpoints.

All fns take a client (built with atlassian.jira.client/client) as their first argument. Path params follow as positional args. Query params and request body are passed via an optional trailing opts map.

Jira Cloud Issue Attachments API endpoints.

All fns take a `client` (built with `atlassian.jira.client/client`) as their
first argument. Path params follow as positional args. Query params and
request body are passed via an optional trailing `opts` map.
raw docstring

add-attachmentclj

(add-attachment client issue-id-or-key body)
(add-attachment client issue-id-or-key body opts)

Add attachment — adds one or more attachments to an issue. POST /rest/api/3/issue/{issueIdOrKey}/attachments

Path params: issue-id-or-key - The ID or key of the issue.

Body: multipart form data (file upload). Pass the raw body map appropriate for the HTTP client; schema-ref is not defined (binary/multipart upload).

Note: this endpoint requires a Content-Type of multipart/form-data.

Add attachment — adds one or more attachments to an issue.
POST /rest/api/3/issue/{issueIdOrKey}/attachments

Path params:
  issue-id-or-key  - The ID or key of the issue.

Body: multipart form data (file upload). Pass the raw body map appropriate
for the HTTP client; schema-ref is not defined (binary/multipart upload).

Note: this endpoint requires a Content-Type of multipart/form-data.
sourceraw docstring

expand-attachment-for-humansclj

(expand-attachment-for-humans client id)

Get all metadata for an expanded attachment — returns the metadata for the contents of an attachment, if it is an archive (e.g. a ZIP), in a human-readable format. GET /rest/api/3/attachment/{id}/expand/human

Path params: id - The ID of the attachment.

Get all metadata for an expanded attachment — returns the metadata for the
contents of an attachment, if it is an archive (e.g. a ZIP), in a human-readable
format.
GET /rest/api/3/attachment/{id}/expand/human

Path params:
  id  - The ID of the attachment.
sourceraw docstring

expand-attachment-for-machinesclj

(expand-attachment-for-machines client id)

Get contents metadata for an expanded attachment — returns the metadata for the contents of an attachment, if it is an archive (e.g. a ZIP), in a machine-readable format. GET /rest/api/3/attachment/{id}/expand/raw

Path params: id - The ID of the attachment.

Get contents metadata for an expanded attachment — returns the metadata for
the contents of an attachment, if it is an archive (e.g. a ZIP), in a
machine-readable format.
GET /rest/api/3/attachment/{id}/expand/raw

Path params:
  id  - The ID of the attachment.
sourceraw docstring

get-attachmentclj

(get-attachment client id)

Get attachment metadata — returns the metadata for an attachment. GET /rest/api/3/attachment/{id}

Path params: id - The ID of the attachment.

Get attachment metadata — returns the metadata for an attachment.
GET /rest/api/3/attachment/{id}

Path params:
  id  - The ID of the attachment.
sourceraw docstring

get-attachment-contentclj

(get-attachment-content client id)
(get-attachment-content client id opts)

Get attachment content — returns the contents of an attachment as binary data. GET /rest/api/3/attachment/content/{id}

Path params: id - The ID of the attachment.

Query opts (all optional): :redirect - boolean; whether to redirect for download (default true).

Get attachment content — returns the contents of an attachment as binary data.
GET /rest/api/3/attachment/content/{id}

Path params:
  id  - The ID of the attachment.

Query opts (all optional):
  :redirect  - boolean; whether to redirect for download (default true).
sourceraw docstring

get-attachment-metaclj

(get-attachment-meta client)

Get Jira attachment settings — returns the attachment settings, including whether attachments are enabled and the maximum attachment size allowed. GET /rest/api/3/attachment/meta

Get Jira attachment settings — returns the attachment settings, including
whether attachments are enabled and the maximum attachment size allowed.
GET /rest/api/3/attachment/meta
sourceraw docstring

get-attachment-thumbnailclj

(get-attachment-thumbnail client id)
(get-attachment-thumbnail client id opts)

Get attachment thumbnail — returns the thumbnail of an attachment. GET /rest/api/3/attachment/thumbnail/{id}

Path params: id - The ID of the attachment.

Query opts (all optional): :redirect - boolean; whether to redirect for download. :fallbackToDefault - boolean; whether to return a default thumbnail when not found. :width - integer; maximum width to scale the thumbnail to. :height - integer; maximum height to scale the thumbnail to.

Get attachment thumbnail — returns the thumbnail of an attachment.
GET /rest/api/3/attachment/thumbnail/{id}

Path params:
  id  - The ID of the attachment.

Query opts (all optional):
  :redirect         - boolean; whether to redirect for download.
  :fallbackToDefault - boolean; whether to return a default thumbnail when not found.
  :width            - integer; maximum width to scale the thumbnail to.
  :height           - integer; maximum height to scale the thumbnail to.
sourceraw docstring

remove-attachmentclj

(remove-attachment client id)

Delete attachment — deletes an attachment from an issue. DELETE /rest/api/3/attachment/{id}

Path params: id - The ID of the attachment.

Delete attachment — deletes an attachment from an issue.
DELETE /rest/api/3/attachment/{id}

Path params:
  id  - The ID of the attachment.
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