Class IssueLinkTypesService

This resource represents issue link types. Use it to get, create, update, and delete link issue types as well as get lists of all link issue types.

To use it, the site must have issue linking enabled.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-link-types

Hierarchy

CommonHttpService
- IssueLinkTypesService

Index

Constructors

constructor

Methods

createIssueLinkType deleteIssueLinkType getIssueLinkType getIssueLinkTypes updateIssueLinkType initialize

Constructors

constructor

new IssueLinkTypesService(getClientInstance): IssueLinkTypesService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns IssueLinkTypesService
Inherited from CommonHttpService.constructor

Methods

createIssueLinkType

createIssueLinkType(params): Promise<IssueLinkType>
Creates an issue link type. Use this operation to create descriptions of the reasons why issues are linked. The issue link type consists of a name and descriptions for a link's inward and outward relationships.

To use this operation, the site must have issue linking enabled.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueLinkType: IssueLinkType;
  }
  - issueLinkType: IssueLinkType
    Example
Returns Promise<IssueLinkType>
Returned if the request is successful.

example:
```
{
  "id": "1000",
  "inward": "Duplicated by",
  "name": "Duplicate",
  "outward": "Duplicates",
  "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000"
}
```
Path
POST /rest/api/3/issueLinkType @scopes-current manage:jira-configuration @scopes-beta write:issue-link-type:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-link-types#api-rest-api-3-issuelinktype-post

deleteIssueLinkType

deleteIssueLinkType(params): Promise<void>
Deletes an issue link type.

To use this operation, the site must have issue linking enabled.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueLinkTypeId: string;
  }
  - issueLinkTypeId: string
    The ID of the issue link type.
Returns Promise<void>
Path
DELETE /rest/api/3/issueLinkType/{issueLinkTypeId} @scopes-current manage:jira-configuration @scopes-beta delete:issue-link-type:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-link-types#api-rest-api-3-issuelinktype-issuelinktypeid-delete

getIssueLinkType

getIssueLinkType(params): Promise<IssueLinkType>
Returns an issue link type.

To use this operation, the site must have issue linking enabled.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for a project in the site.
Parameters
- params: {
  issueLinkTypeId: string;
  }
  - issueLinkTypeId: string
    The ID of the issue link type.
Returns Promise<IssueLinkType>
Returned if the request is successful.

example:
```
{
  "id": "1000",
  "inward": "Duplicated by",
  "name": "Duplicate",
  "outward": "Duplicates",
  "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000"
}
```
Path
GET /rest/api/3/issueLinkType/{issueLinkTypeId} @scopes-current read:jira-work @scopes-beta read:issue-link-type:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-link-types#api-rest-api-3-issuelinktype-issuelinktypeid-get

getIssueLinkTypes

getIssueLinkTypes(): Promise<IssueLinkTypes>
Returns a list of all issue link types.

To use this operation, the site must have issue linking enabled.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for a project in the site.

Returns Promise<IssueLinkTypes>
Returned if the request is successful.

example:
```
{
  "issueLinkTypes": [
    {
      "id": "1000",
      "inward": "Duplicated by",
      "name": "Duplicate",
      "outward": "Duplicates",
      "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000"
    },
    {
      "id": "1010",
      "inward": "Blocked by",
      "name": "Blocks",
      "outward": "Blocks",
      "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1010"
    }
  ]
}
```
Path
GET /rest/api/3/issueLinkType @scopes-current read:jira-work @scopes-beta read:issue-link-type:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-link-types#api-rest-api-3-issuelinktype-get

updateIssueLinkType

updateIssueLinkType(params): Promise<IssueLinkType>
Updates an issue link type.

To use this operation, the site must have issue linking enabled.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueLinkType: IssueLinkType;
  issueLinkTypeId: string;
  }
  - issueLinkType: IssueLinkType
    Example
  - issueLinkTypeId: string
    The ID of the issue link type.
Returns Promise<IssueLinkType>
Returned if the request is successful.

example:
```
{
  "id": "1000",
  "inward": "Duplicated by",
  "name": "Duplicate",
  "outward": "Duplicates",
  "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000"
}
```
Path
PUT /rest/api/3/issueLinkType/{issueLinkTypeId} @scopes-current manage:jira-configuration @scopes-beta read:issue-link-type:jira, write:issue-link-type:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-link-types#api-rest-api-3-issuelinktype-issuelinktypeid-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class IssueLinkTypesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns IssueLinkTypesService

Methods

createIssueLinkType

Parameters

issueLinkType: IssueLinkType

Example

Returns Promise<IssueLinkType>

Path

See

deleteIssueLinkType

Parameters

issueLinkTypeId: string

Returns Promise<void>

Path

See

getIssueLinkType

Parameters

issueLinkTypeId: string

Returns Promise<IssueLinkType>

Path

See

getIssueLinkTypes

Returns Promise<IssueLinkTypes>

Path

See

updateIssueLinkType

Parameters

issueLinkType: IssueLinkType

Example

issueLinkTypeId: string

Returns Promise<IssueLinkType>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Protected` `Static`initialize