Class: IssueLinkTypeClient

IssueLinkTypeClient(jiraClient)

new IssueLinkTypeClient(jiraClient)

Used to access Jira REST endpoints in '/rest/api/2/issueLinkType'

Parameters:
Name Type Description
jiraClient JiraClient
Source:

Methods

createIssueLinkType(opts, callbackopt) → {Promise}

Create a new issue link type.

Parameters:
Name Type Attributes Description
opts

The request options sent to the Jira API

Properties
Name Type Description
linkType

See https://docs.atlassian.com/jira/REST/latest/#d2e2018
callback <optional>

Called when the IssueLink type has been created.
Source:
Returns:

Resolved when the IssueLink type has been created.

Type
Promise

deleteIssueLinkType(opts, callbackopt) → {Promise}

Delete the specified issue link type.

Parameters:
Name Type Attributes Description
opts

The request options sent to the Jira API

Properties
Name Type Description
issueLinkTypeId

The id of the IssueLink type to delete.
callback <optional>

Called when the IssueLink type has been delete
Source:
Returns:

Resolved when the IssueLink type has been delete

Type
Promise

editIssueLinkType(opts, callbackopt) → {Promise}

Update the specified issue link type.

Parameters:
Name Type Attributes Description
opts

The request options sent to the Jira API

Properties
Name Type Description
issueLinkTypeId

The id of the IssueLink type to retrieve.
linkType

See https://docs.atlassian.com/jira/REST/latest/#d2e2071
callback <optional>

Called when the IssueLink type has been updated.
Source:
Returns:

Resolved when the IssueLink type has been updated.

Type
Promise

getAvailableTypes(opts, callbackopt) → {Promise}

Get a list of available issue link types, if issue linking is enabled. Each issue link type has an id, a name and a label for the outward and inward link relationship.

Parameters:
Name Type Attributes Description
opts

The request options for the API. Ignored in this function.
callback <optional>

Called when the available IssueLink types are retrieved.
Source:
Returns:

Resolved when the available IssueLink types are retrieved.

Type
Promise

getIssueLinkType(opts, callbackopt) → {Promise}

Gets for a given issue link type id all information about this issue link type.

Parameters:
Name Type Attributes Description
opts

The request options sent to the Jira API

Properties
Name Type Description
issueLinkTypeId

The id of the IssueLink type to retrieve.
callback <optional>

Called when the IssueLink type has been retrieved
Source:
Returns:

Resolved when the IssueLink type has been retrieved

Type
Promise