Function partiallyUpdateEpic

partiallyUpdateEpic(
    client: Client,
    parameters: {
        color?: {
            key?:
                | string & {}
                | "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";
            [key: string]: unknown;
        };
        done?: boolean;
        epicIdOrKey: string;
        name?: string;
        summary?: string;
    },
    options?: RequestOptions,
): Promise<
    {
        color?: { key?: string; [key: string]: unknown };
        done?: boolean;
        id?: number;
        key?: string;
        name?: string;
        self?: string;
        summary?: string;
        [key: string]: unknown;
    },
>
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
- client: Client
- parameters: {
      color?: {
          key?:
              | string & {}
              | "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";
          [key: string]: unknown;
      };
      done?: boolean;
      epicIdOrKey: string;
      name?: string;
      summary?: string;
  }
  - Optionalcolor?: {
        key?:
            | string & {}
            | "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";
        [key: string]: unknown;
    }
  - Optionaldone?: boolean
  - epicIdOrKey: string
    
    The id or key of the epic to update.
  - Optionalname?: string
  - Optionalsummary?: string
- Optionaloptions: RequestOptions
Returns Promise<
    {
        color?: { key?: string; [key: string]: unknown };
        done?: boolean;
        id?: number;
        key?: string;
        name?: string;
        self?: string;
        summary?: string;
        [key: string]: unknown;
    },
>
- Defined in src/agile/api/epic.ts:89

Function partiallyUpdateEpic

Parameters

`Optional`done?: boolean

epicIdOrKey: string

`Optional`name?: string

`Optional`summary?: string

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

Settings

Function partiallyUpdateEpic

Parameters

Optionalcolor?: { key?: | string & {} | "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"; [key: string]: unknown;}

Optionaldone?: boolean

epicIdOrKey: string

Optionalname?: string

Optionalsummary?: string

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

Settings

`Optional`color?: {
key?:
| string & {}
| "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";
[key: string]: unknown;
}

`Optional`done?: boolean

`Optional`name?: string

`Optional`summary?: string

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