Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

An array of objects with Custom Field ids that will be available on the link. Example: [{"id":"10020"}, {"id":"10021"}] Refer to the Jira API documentation to retrieve Custom Fields ids: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/

Parameter Name

Description

Default

password

Sets password for share.

null

expiration

Expiration timestamp in epoch miliseconds.

null

showComments

All existing comments will be visible on the shared link.

true

allowAddComment

Anyone with access to the link can add comments.

false

showInternalComments

Anyone with access to the link can view internal comments.

false

allowAddInternalComment

Anyone with access to the link can addinternal comments.

false

showAttachments

All existing attachments will be visible on the shared link.

true

allowAddAttachment

Anyone with access to the link can add attachments.

false

allowAddPublicAttachment

Anyone with access to the link can create a public comment with an attachment.

false

showSubtasks

Information about subtasks will be visible on the link.

true

showLinkedIssues

Information about linked issues will be visible on the link.

true

shareSubtasksContent

Information about subtasks will be visible on the link as per share settings.

false

shareLinkedIssuesContent

Information about linked issues will be visible on the link as per share settings.

false

allowWorkflowTransition

Anyone with access to the link can change its status.

false

showWorklog

Anyone with access to the link can see the worklog.

false

showChangelog

Anyone with access to the link can see history items from the changelog.

false

customFields

fieldsConfig

List of fields added to share with its permissions. Possible values for fieldPermissions: “VIEW”, “VIEW_CONTENT”, “ADD”, ”EDIT”.

  • VIEW permission is available for all fields and decides whether the field should be shown on share

  • VIEW_CONTENT permission is available only for Linked Issues and Sub-tasks fields. Decides whether external user should be able to see the content of linked issues or sub-tasks shown on the share.

  • ADD permission is available for Comment and Attachment fields. Decides whether external user should be able to add new content on the share.

  • EDIT permission is available to all editable fields (Summary, Description, Priority, etc.). Decides whether external user should be able to edit appropriate fields.

Default: If a permission is omitted, it is treated as disabled (false).

Example JSON body:

Code Block
languagejson
"fieldsConfig": {
        "fieldConfigs": {
            "status": {
                "fieldPermissions": [
                    "VIEW"
                ]
            },
            "comment": {
                "fieldPermissions": [
                    "VIEW",
                    "ADD"
                ]
            },
            "customfield_10076": {
                "fieldPermissions": [
                    "VIEW"
                ]
            }
        }
    }

null

selectedUsersConfig

Pass this object to define list of users that can access the share. You can pass the following fields in this configuration:

  1. allowed - set to true if you want to allow access only to selected users.

  2. allowedNotification - if true, users will be notified via e-mail when added to the list

  3. list - list of e-mails that may access the share. Refer to example below to see how to correctly pass the e-mails.

Code Block
"selectedUsersConfig": {
		"allowed": true,
		"allowedNotification": false, 
		"list": [{"email": "expl@expl2.com"}, {"email": "expl@expl.com"}]
	}

null

expirationExpression

object with unit and amountfields. #Expiration Expression

null

jql

generated: "project = {projectKey} order by created DESC"

generated

board

Code Block
"board": {
    "id": "{boardId}"
}

null

...