Skip to content

Function: updateIssueLinkType() ​

ts
function updateIssueLinkType(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  id?: string;
  inward?: string;
  name?: string;
  outward?: string;
  self?: string;
}>;

Defined in: src/cloud/api/issueLinkTypes.ts:94

Updates an issue link type.

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

Permissions required:Administer Jira global permission.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ id?: string; inward?: string; issueLinkTypeId: string; name?: string; outward?: string; self?: string; }-
parameters.id?stringThe ID of the issue link type and is used as follows: - In the issueLink resource it is the type of issue link. Required on create when name isn't provided. Otherwise, read only. - In the issueLinkType resource it is read only.
parameters.inward?stringThe description of the issue link type inward link and is used as follows: - In the issueLink resource it is read only. - In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.
parameters.issueLinkTypeId?stringThe ID of the issue link type.
parameters.name?stringThe name of the issue link type and is used as follows: - In the issueLink resource it is the type of issue link. Required on create when id isn't provided. Otherwise, read only. - In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.
parameters.outward?stringThe description of the issue link type outward link and is used as follows: - In the issueLink resource it is read only. - In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.
parameters.self?stringThe URL of the issue link type. Read only.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; id?: string; inward?: string; name?: string; outward?: string; self?: string; }>