Class IssueLinks

Index

Constructors

constructor

Methods

deleteIssueLink getIssueLink linkIssues

Constructors

constructor

new IssueLinks(client: Client): Version3.IssueLinks
Parameters
- client: Client
Returns Version3.IssueLinks
- Defined in src/version3/issueLinks.ts:8

Methods

deleteIssueLink

deleteIssueLink<T = void>(
parameters: Version3Parameters.DeleteIssueLink,
callback: Callback<T>,
): Promise<void>
Deletes an issue link.

This operation can be accessed anonymously.

Permissions required:
- Browse project project permission for all the projects containing the issues in the link.
- Link issues project permission for at least one of the projects containing issues in the link.
- If issue-level security is configured, permission to view both of the issues.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteIssueLink
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueLinks.ts:125
deleteIssueLink<T = void>(
parameters: Version3Parameters.DeleteIssueLink,
callback?: undefined,
): Promise<T>
Deletes an issue link.

This operation can be accessed anonymously.

Permissions required:
- Browse project project permission for all the projects containing the issues in the link.
- Link issues project permission for at least one of the projects containing issues in the link.
- If issue-level security is configured, permission to view both of the issues.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteIssueLink
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueLinks.ts:140

getIssueLink

getIssueLink<T = Version3Models.IssueLink>(
parameters: Version3Parameters.GetIssueLink,
callback: Callback<T>,
): Promise<void>
Returns an issue link.

This operation can be accessed anonymously.

Permissions required:
- Browse project project permission for all the projects containing the linked issues.
- If issue-level security is configured, permission to view both of the issues.
Type Parameters
- T = Version3Models.IssueLink
Parameters
- parameters: Version3Parameters.GetIssueLink
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueLinks.ts:85
getIssueLink<T = Version3Models.IssueLink>(
parameters: Version3Parameters.GetIssueLink,
callback?: undefined,
): Promise<T>
Returns an issue link.

This operation can be accessed anonymously.

Permissions required:
- Browse project project permission for all the projects containing the linked issues.
- If issue-level security is configured, permission to view both of the issues.
Type Parameters
- T = Version3Models.IssueLink
Parameters
- parameters: Version3Parameters.GetIssueLink
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueLinks.ts:98

linkIssues

linkIssues<T = void>(
parameters: Version3Parameters.LinkIssues,
callback: Callback<T>,
): Promise<void>
Creates a link between two issues. Use this operation to indicate a relationship between two issues and optionally add a comment to the from (outward) issue. To use this resource the site must have Issue Linking enabled.

This resource returns nothing on the creation of an issue link. To obtain the ID of the issue link, use https://your-domain.atlassian.net/rest/api/3/issue/[linked issue key]?fields=issuelinks.

If the link request duplicates a link, the response indicates that the issue link was created. If the request included a comment, the comment is added.

This operation can be accessed anonymously.

Permissions required:
- Browse project project permission for all the projects containing the issues to be linked,
- Link issues project permission on the project containing the from (outward) issue,
- If issue-level security is configured, issue-level security permission to view the issue.
- If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.LinkIssues
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueLinks.ts:33
linkIssues<T = void>(
parameters: Version3Parameters.LinkIssues,
callback?: undefined,
): Promise<T>
Creates a link between two issues. Use this operation to indicate a relationship between two issues and optionally add a comment to the from (outward) issue. To use this resource the site must have Issue Linking enabled.

This resource returns nothing on the creation of an issue link. To obtain the ID of the issue link, use https://your-domain.atlassian.net/rest/api/3/issue/[linked issue key]?fields=issuelinks.

If the link request duplicates a link, the response indicates that the issue link was created. If the request included a comment, the comment is added.

This operation can be accessed anonymously.

Permissions required:
- Browse project project permission for all the projects containing the issues to be linked,
- Link issues project permission on the project containing the from (outward) issue,
- If issue-level security is configured, issue-level security permission to view the issue.
- If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.LinkIssues
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueLinks.ts:57

Class IssueLinks

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.IssueLinks

Methods

deleteIssueLink

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getIssueLink

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

linkIssues

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page