Skip to content

Function: linkIssues() ​

ts
function linkIssues(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/server/api/issueLinks.ts:8

Creates an issue link between two issues.

Parameters ​

ParameterType
clientClient
parameters{ comment?: { author?: { active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; body?: string; created?: string; id?: string; properties?: object[]; renderedBody?: string; self?: string; updateAuthor?: { active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; updated?: string; visibility?: { type?: "role" | "group" | string & object; value?: string; }; }; inwardIssue?: { fields?: { issuetype?: { avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }; priority?: { description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusColor?: string; }; status?: { description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusCategory?: { colorName?: string; id?: number; key?: string; name?: string; self?: string; }; statusColor?: string; }; summary?: string; }; id?: string; key?: string; self?: string; }; outwardIssue?: { fields?: { issuetype?: { avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }; priority?: { description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusColor?: string; }; status?: { description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusCategory?: { colorName?: string; id?: number; key?: string; name?: string; self?: string; }; statusColor?: string; }; summary?: string; }; id?: string; key?: string; self?: string; }; type?: { id?: string; inward?: string; name?: string; outward?: string; self?: string; }; }
parameters.comment?{ author?: { active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; body?: string; created?: string; id?: string; properties?: object[]; renderedBody?: string; self?: string; updateAuthor?: { active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; updated?: string; visibility?: { type?: "role" | "group" | string & object; value?: string; }; }
parameters.comment.author?{ active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }
parameters.comment.author.active?boolean
parameters.comment.author.avatarUrls?Record<string, string>
parameters.comment.author.displayName?string
parameters.comment.author.emailAddress?string
parameters.comment.author.key?string
parameters.comment.author.name?string
parameters.comment.author.self?string
parameters.comment.author.timeZone?string
parameters.comment.body?string
parameters.comment.created?string
parameters.comment.id?string
parameters.comment.properties?object[]
parameters.comment.renderedBody?string
parameters.comment.self?string
parameters.comment.updateAuthor?{ active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }
parameters.comment.updateAuthor.active?boolean
parameters.comment.updateAuthor.avatarUrls?Record<string, string>
parameters.comment.updateAuthor.displayName?string
parameters.comment.updateAuthor.emailAddress?string
parameters.comment.updateAuthor.key?string
parameters.comment.updateAuthor.name?string
parameters.comment.updateAuthor.self?string
parameters.comment.updateAuthor.timeZone?string
parameters.comment.updated?string
parameters.comment.visibility?{ type?: "role" | "group" | string & object; value?: string; }
parameters.comment.visibility.type?"role" | "group" | string & object
parameters.comment.visibility.value?string
parameters.inwardIssue?{ fields?: { issuetype?: { avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }; priority?: { description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusColor?: string; }; status?: { description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusCategory?: { colorName?: string; id?: number; key?: string; name?: string; self?: string; }; statusColor?: string; }; summary?: string; }; id?: string; key?: string; self?: string; }
parameters.inwardIssue.fields?{ issuetype?: { avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }; priority?: { description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusColor?: string; }; status?: { description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusCategory?: { colorName?: string; id?: number; key?: string; name?: string; self?: string; }; statusColor?: string; }; summary?: string; }
parameters.inwardIssue.fields.issuetype?{ avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }
parameters.inwardIssue.fields.issuetype.avatarId?number
parameters.inwardIssue.fields.issuetype.description?string
parameters.inwardIssue.fields.issuetype.iconUrl?string
parameters.inwardIssue.fields.issuetype.id?string
parameters.inwardIssue.fields.issuetype.name?string
parameters.inwardIssue.fields.issuetype.self?string
parameters.inwardIssue.fields.issuetype.subtask?boolean
parameters.inwardIssue.fields.priority?{ description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusColor?: string; }
parameters.inwardIssue.fields.priority.description?string
parameters.inwardIssue.fields.priority.iconUrl?string
parameters.inwardIssue.fields.priority.id?string
parameters.inwardIssue.fields.priority.name?string
parameters.inwardIssue.fields.priority.self?string
parameters.inwardIssue.fields.priority.statusColor?string
parameters.inwardIssue.fields.status?{ description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusCategory?: { colorName?: string; id?: number; key?: string; name?: string; self?: string; }; statusColor?: string; }
parameters.inwardIssue.fields.status.description?string
parameters.inwardIssue.fields.status.iconUrl?string
parameters.inwardIssue.fields.status.id?string
parameters.inwardIssue.fields.status.name?string
parameters.inwardIssue.fields.status.self?string
parameters.inwardIssue.fields.status.statusCategory?{ colorName?: string; id?: number; key?: string; name?: string; self?: string; }
parameters.inwardIssue.fields.status.statusCategory.colorName?string
parameters.inwardIssue.fields.status.statusCategory.id?number
parameters.inwardIssue.fields.status.statusCategory.key?string
parameters.inwardIssue.fields.status.statusCategory.name?string
parameters.inwardIssue.fields.status.statusCategory.self?string
parameters.inwardIssue.fields.status.statusColor?string
parameters.inwardIssue.fields.summary?string
parameters.inwardIssue.id?string
parameters.inwardIssue.key?string
parameters.inwardIssue.self?string
parameters.outwardIssue?{ fields?: { issuetype?: { avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }; priority?: { description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusColor?: string; }; status?: { description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusCategory?: { colorName?: string; id?: number; key?: string; name?: string; self?: string; }; statusColor?: string; }; summary?: string; }; id?: string; key?: string; self?: string; }
parameters.outwardIssue.fields?{ issuetype?: { avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }; priority?: { description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusColor?: string; }; status?: { description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusCategory?: { colorName?: string; id?: number; key?: string; name?: string; self?: string; }; statusColor?: string; }; summary?: string; }
parameters.outwardIssue.fields.issuetype?{ avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }
parameters.outwardIssue.fields.issuetype.avatarId?number
parameters.outwardIssue.fields.issuetype.description?string
parameters.outwardIssue.fields.issuetype.iconUrl?string
parameters.outwardIssue.fields.issuetype.id?string
parameters.outwardIssue.fields.issuetype.name?string
parameters.outwardIssue.fields.issuetype.self?string
parameters.outwardIssue.fields.issuetype.subtask?boolean
parameters.outwardIssue.fields.priority?{ description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusColor?: string; }
parameters.outwardIssue.fields.priority.description?string
parameters.outwardIssue.fields.priority.iconUrl?string
parameters.outwardIssue.fields.priority.id?string
parameters.outwardIssue.fields.priority.name?string
parameters.outwardIssue.fields.priority.self?string
parameters.outwardIssue.fields.priority.statusColor?string
parameters.outwardIssue.fields.status?{ description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusCategory?: { colorName?: string; id?: number; key?: string; name?: string; self?: string; }; statusColor?: string; }
parameters.outwardIssue.fields.status.description?string
parameters.outwardIssue.fields.status.iconUrl?string
parameters.outwardIssue.fields.status.id?string
parameters.outwardIssue.fields.status.name?string
parameters.outwardIssue.fields.status.self?string
parameters.outwardIssue.fields.status.statusCategory?{ colorName?: string; id?: number; key?: string; name?: string; self?: string; }
parameters.outwardIssue.fields.status.statusCategory.colorName?string
parameters.outwardIssue.fields.status.statusCategory.id?number
parameters.outwardIssue.fields.status.statusCategory.key?string
parameters.outwardIssue.fields.status.statusCategory.name?string
parameters.outwardIssue.fields.status.statusCategory.self?string
parameters.outwardIssue.fields.status.statusColor?string
parameters.outwardIssue.fields.summary?string
parameters.outwardIssue.id?string
parameters.outwardIssue.key?string
parameters.outwardIssue.self?string
parameters.type?{ id?: string; inward?: string; name?: string; outward?: string; self?: string; }
parameters.type.id?string
parameters.type.inward?string
parameters.type.name?string
parameters.type.outward?string
parameters.type.self?string
options?RequestOptions

Returns ​

Promise<void>