Function: editIssue()

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

Defined in: src/server/api/issues.ts:434

Edits an issue from a JSON representation. The issue can either be updated by setting explicit the field value(s) or by using an operation to change the field value.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ fields?: Record<string, any>; historyMetadata?: { activityDescription?: string; activityDescriptionKey?: string; actor?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; cause?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; description?: string; descriptionKey?: string; emailDescription?: string; emailDescriptionKey?: string; extraData?: Record<string, string>; generator?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; type?: string; }; issueIdOrKey: string; notifyUsers?: string; properties?: object[]; transition?: { description?: string; fields?: Record<string, { allowedValues?: Record<string, any>[]; autoCompleteUrl?: string; defaultValue?: Record<string, any>; fieldId?: string; hasDefaultValue?: boolean; name?: string; operations?: string[]; required?: boolean; schema?: { custom?: string; customId?: number; items?: string; system?: string; type?: string; }; }>; id?: string; name?: string; opsbarSequence?: number; to?: { description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusCategory?: { colorName?: string; id?: number; key?: string; name?: string; self?: string; }; statusColor?: string; }; }; update?: Record<string, object[]>; }	-
parameters.fields?	Record<string, any>	-
parameters.historyMetadata?	{ activityDescription?: string; activityDescriptionKey?: string; actor?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; cause?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; description?: string; descriptionKey?: string; emailDescription?: string; emailDescriptionKey?: string; extraData?: Record<string, string>; generator?: { avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }; type?: string; }	-
parameters.historyMetadata.activityDescription?	string	-
parameters.historyMetadata.activityDescriptionKey?	string	-
parameters.historyMetadata.actor?	{ avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }	-
parameters.historyMetadata.actor.avatarUrl?	string	-
parameters.historyMetadata.actor.displayName?	string	-
parameters.historyMetadata.actor.displayNameKey?	string	-
parameters.historyMetadata.actor.id?	string	-
parameters.historyMetadata.actor.type?	string	-
parameters.historyMetadata.actor.url?	string	-
parameters.historyMetadata.cause?	{ avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }	-
parameters.historyMetadata.cause.avatarUrl?	string	-
parameters.historyMetadata.cause.displayName?	string	-
parameters.historyMetadata.cause.displayNameKey?	string	-
parameters.historyMetadata.cause.id?	string	-
parameters.historyMetadata.cause.type?	string	-
parameters.historyMetadata.cause.url?	string	-
parameters.historyMetadata.description?	string	-
parameters.historyMetadata.descriptionKey?	string	-
parameters.historyMetadata.emailDescription?	string	-
parameters.historyMetadata.emailDescriptionKey?	string	-
parameters.historyMetadata.extraData?	Record<string, string>	-
parameters.historyMetadata.generator?	{ avatarUrl?: string; displayName?: string; displayNameKey?: string; id?: string; type?: string; url?: string; }	-
parameters.historyMetadata.generator.avatarUrl?	string	-
parameters.historyMetadata.generator.displayName?	string	-
parameters.historyMetadata.generator.displayNameKey?	string	-
parameters.historyMetadata.generator.id?	string	-
parameters.historyMetadata.generator.type?	string	-
parameters.historyMetadata.generator.url?	string	-
parameters.historyMetadata.type?	string	-
parameters.issueIdOrKey?	string	Issue id or key
parameters.notifyUsers?	string	Send the email with notification that the issue was updated to users that watch it. Admin or project admin permissions are required to disable the notification.
parameters.properties?	object[]	-
parameters.transition?	{ description?: string; fields?: Record<string, { allowedValues?: Record<string, any>[]; autoCompleteUrl?: string; defaultValue?: Record<string, any>; fieldId?: string; hasDefaultValue?: boolean; name?: string; operations?: string[]; required?: boolean; schema?: { custom?: string; customId?: number; items?: string; system?: string; type?: string; }; }>; id?: string; name?: string; opsbarSequence?: number; to?: { description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusCategory?: { colorName?: string; id?: number; key?: string; name?: string; self?: string; }; statusColor?: string; }; }	-
parameters.transition.description?	string	-
parameters.transition.fields?	Record<string, { allowedValues?: Record<string, any>[]; autoCompleteUrl?: string; defaultValue?: Record<string, any>; fieldId?: string; hasDefaultValue?: boolean; name?: string; operations?: string[]; required?: boolean; schema?: { custom?: string; customId?: number; items?: string; system?: string; type?: string; }; }>	-
parameters.transition.id?	string	-
parameters.transition.name?	string	-
parameters.transition.opsbarSequence?	number	-
parameters.transition.to?	{ description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusCategory?: { colorName?: string; id?: number; key?: string; name?: string; self?: string; }; statusColor?: string; }	-
parameters.transition.to.description?	string	-
parameters.transition.to.iconUrl?	string	-
parameters.transition.to.id?	string	-
parameters.transition.to.name?	string	-
parameters.transition.to.self?	string	-
parameters.transition.to.statusCategory?	{ colorName?: string; id?: number; key?: string; name?: string; self?: string; }	-
parameters.transition.to.statusCategory.colorName?	string	-
parameters.transition.to.statusCategory.id?	number	-
parameters.transition.to.statusCategory.key?	string	-
parameters.transition.to.statusCategory.name?	string	-
parameters.transition.to.statusCategory.self?	string	-
parameters.transition.to.statusColor?	string	-
parameters.update?	Record<string, object[]>	-
options?	RequestOptions	-

Returns

Promise<void>