Versions Compared

Version Old Version 14 New Version Current
Changes made by

Parsa Shiva

Yoonjeong Bae

Saved on

Key

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

...

This operation allows you to retrieve a single share, or its activity, based on share uuid. This operation does not accept any additional options and returns JSON with Share data/Share activity data.

Example Call:

Code Block
GET https://jira.external-share.com/webapi/share/{ SHARE_UUID }
GET https://jira.external-share.com/webapi/share/{ SHARE_UUID }/activity
GET /rest/servicedeskapi/request/{issueIdOrKey}/approval

LIST OPERATION

This operation allows you to retrieve a sorted list of shares based on the options passed. You need to have an access to shared issues to be able to list shares. You can pass the following options as request parameters:

...

  • type - defines share type. Possible values: “ISSUE”, “BOARD”, “JQL”, “TIMELINE”.

  • issueId - required for ISSUE type shares.

  • projectId - required for BOARD, JQL and JQL TIMELINE type shares.

  • board - can be used to specify a specific board in the project.

...

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

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/

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

DELETE OPERATION

This operation allows you to delete a single share based on its share uuid. It does not accept any additional options. Upon successful execution, it returns no content (HTTP 204). If an error occurs, a JSON with the error message will be provided.

Example Call:

Code Block
DELETE https://jira.external-share.com/webapi/share/{ SHARE_UUID }

Expiration Expression

Expiration Expression field

 

 

unit

NANOS

1,000,000,000th part of the second unit

 

MICROS

1,000,000th part of the second unit

 

MILLIS

1000th part of the second unit

 

SECONDS

it is equal to the second in the SI system of units

 

MINUTES

it is equal to 60 seconds

 

HOURS

it is equal to 60 minutes

 

HALF_DAYS

it is equal to 12 hours

 

DAYS

it is equal to 24 Hours

 

WEEKS

it is equal to 7 days

 

MONTHS

estimated duration of a month is one twelfth of 365.2425 Days

 

YEARS

estimated duration of a year is 365.2425 Day

 

DECADES

it is equal to 10 years

 

CENTURIES

it is equal to 100 years

 

MILLENNIA

it is equal to 1000 years

amount

whole number

 

Example Call:

Code Block
languagejson
POST https://jira.external-share.com/webapi/share
{
	"issueId": "10001",
	"type": "ISSUE",
	"expiration": 1649700933954,
	"customFields": [{"id":"10020"}, {"id":"10021"}],
	"selectedUsersConfig": {
		"allowed": true,
		"allowedNotification": false, 
		"list": [{"email": "expl@expl2.com"}, {"email": "expl@expl.com"}]
	}
}

UPDATE OPERATION

This operation allows you to update an existing UUID link.

Example Call:

Code Block
PUT https://jes-qa.warsawdynamics.com/webapi/share/{YOUR-ISSUE-UUID}

DELETE OPERATION

This operation allows you to delete a single share based on its share uuid. It does not accept any additional options. Upon successful execution, it returns no content (HTTP 204). If an error occurs, a JSON with the error message will be provided.

Example Call:

Code Block
DELETE https://jira.external-share.com/webapi/share/{ SHARE_UUID }

An example rule: Automatically create an External Share link for every new issue.