Skip to content

Function: partiallyUpdateEpic() ​

ts
function partiallyUpdateEpic(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  color?: {
   [key: string]: unknown;
     key?: string;
  };
  done?: boolean;
  id?: number;
  key?: string;
  name?: string;
  self?: string;
  summary?: string;
}>;

Defined in: src/agile/api/epic.ts:89

Performs a partial update of the epic. A partial update means that fields not present in the request JSON will not be updated. Valid values for color are color_1 to color_9. Note: This operation does not work for epics in next-gen projects.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ color?: { key?: | string & object | "color_1" | "color_2" | "color_3" | "color_4" | "color_5" | "color_6" | "color_7" | "color_8" | "color_9" | "color_10" | "color_11" | "color_12" | "color_13" | "color_14"; }; done?: boolean; epicIdOrKey: string; name?: string; summary?: string; }-
parameters.color?{ key?: | string & object | "color_1" | "color_2" | "color_3" | "color_4" | "color_5" | "color_6" | "color_7" | "color_8" | "color_9" | "color_10" | "color_11" | "color_12" | "color_13" | "color_14"; }-
parameters.color.key?| string & object | "color_1" | "color_2" | "color_3" | "color_4" | "color_5" | "color_6" | "color_7" | "color_8" | "color_9" | "color_10" | "color_11" | "color_12" | "color_13" | "color_14"-
parameters.done?boolean-
parameters.epicIdOrKey?stringThe id or key of the epic to update.
parameters.name?string-
parameters.summary?string-
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; color?: { [key: string]: unknown; key?: string; }; done?: boolean; id?: number; key?: string; name?: string; self?: string; summary?: string; }>