Interface UpdateStory

interface UpdateStory {
    after_id?: number;
    archived?: boolean;
    before_id?: number;
    branch_ids?: number[];
    commit_ids?: number[];
    completed_at_override?: string;
    custom_fields?: CustomFieldValueParams[];
    deadline?: string;
    description?: string;
    epic_id?: number;
    estimate?: number;
    external_links?: string[];
    file_ids?: number[];
    follower_ids?: string[];
    group_id?: string;
    iteration_id?: number;
    labels?: CreateLabelParams[];
    linked_file_ids?: number[];
    move_to?: "last" | "first";
    name?: string;
    owner_ids?: string[];
    project_id?: number;
    pull_request_ids?: number[];
    requested_by_id?: string;
    started_at_override?: string;
    story_type?: "feature" | "chore" | "bug";
    workflow_state_id?: number;
}

Properties

after_id? archived? before_id? branch_ids? commit_ids? completed_at_override? custom_fields? deadline? description? epic_id? estimate? external_links? file_ids? follower_ids? group_id? iteration_id? labels? linked_file_ids? move_to? name? owner_ids? project_id? pull_request_ids? requested_by_id? started_at_override? story_type? workflow_state_id?

Properties

Optionalafter_id

after_id?: number

The ID of the story we want to move this story after.

Format

int64

Optionalarchived

archived?: boolean

True if the story is archived, otherwise false.

Optionalbefore_id

before_id?: number

The ID of the story we want to move this story before.

Format

int64

Optionalbranch_ids

branch_ids?: number[]

An array of IDs of Branches attached to the story.

Unique Items

true

Optionalcommit_ids

commit_ids?: number[]

An array of IDs of Commits attached to the story.

Unique Items

true

Optionalcompleted_at_override

completed_at_override?: string

A manual override for the time/date the Story was completed.

Format

date-time

Optionalcustom_fields

custom_fields?: CustomFieldValueParams[]

A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.

Optionaldeadline

deadline?: string

The due date of the story.

Format

date-time

Optionaldescription

description?: string

The description of the story.

Max Length

100000

Optionalepic_id

epic_id?: number

The ID of the epic the story belongs to.

Format

int64

Optionalestimate

estimate?: number

The numeric point estimate of the story. Can also be null, which means unestimated.

Format

int64

Optionalexternal_links

external_links?: string[]

An array of External Links associated with this story.

Optionalfile_ids

file_ids?: number[]

An array of IDs of files attached to the story.

Unique Items

true

Optionalfollower_ids

follower_ids?: string[]

An array of UUIDs of the followers of this story.

Unique Items

true

Optionalgroup_id

group_id?: string

The ID of the group to associate with this story

Format

uuid

Optionaliteration_id

iteration_id?: number

The ID of the iteration the story belongs to.

Format

int64

Optionallabels

labels?: CreateLabelParams[]

An array of labels attached to the story.

Optionallinked_file_ids

linked_file_ids?: number[]

An array of IDs of linked files attached to the story.

Unique Items

true

Optionalmove_to

move_to?: "last" | "first"

One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state.

Optionalname

name?: string

The title of the story.

Min Length

1

Max Length

512

Optionalowner_ids

owner_ids?: string[]

An array of UUIDs of the owners of this story.

Unique Items

true

Optionalproject_id

project_id?: number

The ID of the project the story belongs to.

Format

int64

Optionalpull_request_ids

pull_request_ids?: number[]

An array of IDs of Pull/Merge Requests attached to the story.

Unique Items

true

Optionalrequested_by_id

requested_by_id?: string

The ID of the member that requested the story.

Format

uuid

Optionalstarted_at_override

started_at_override?: string

A manual override for the time/date the Story was started.

Format

date-time

Optionalstory_type

story_type?: "feature" | "chore" | "bug"

The type of story (feature, bug, chore).

Optionalworkflow_state_id

workflow_state_id?: number

The ID of the workflow state to put the story in.

Format

int64

Settings

Member Visibility

On This Page

Properties