Interface StoryContents

A container entity for the attributes this template should populate.

interface StoryContents {
    custom_fields?: CustomFieldValueParams[];
    deadline?: string;
    description?: string;
    entity_type?: string;
    epic_id?: number;
    estimate?: number;
    external_links?: string[];
    files?: UploadedFile[];
    follower_ids?: string[];
    group_id?: string;
    iteration_id?: number;
    label_ids?: number[];
    labels?: LabelSlim[];
    linked_files?: LinkedFile[];
    name?: string;
    owner_ids?: string[];
    project_id?: number;
    story_type?: string;
    tasks?: StoryContentsTask[];
    workflow_state_id?: number;
}

Properties

custom_fields? deadline? description? entity_type? epic_id? estimate? external_links? files? follower_ids? group_id? iteration_id? label_ids? labels? linked_files? name? owner_ids? project_id? story_type? tasks? workflow_state_id?

Properties

Optionalcustom_fields

custom_fields?: CustomFieldValueParams[]

An array of maps 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.

Optionalentity_type

entity_type?: string

A string description of this resource.

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 connected to the story.

Optionalfiles

files?: UploadedFile[]

An array of files attached to the story.

Optionalfollower_ids

follower_ids?: string[]

An array of UUIDs for any Members listed as Followers.

Optionalgroup_id

group_id?: string

The ID of the group to which the story is assigned.

Format

uuid

Optionaliteration_id

iteration_id?: number

The ID of the iteration the story belongs to.

Format

int64

Optionallabel_ids

label_ids?: number[]

An array of label ids attached to the story.

Optionallabels

labels?: LabelSlim[]

An array of labels attached to the story.

Optionallinked_files

linked_files?: LinkedFile[]

An array of linked files attached to the story.

Optionalname

name?: string

The name of the story.

Optionalowner_ids

owner_ids?: string[]

An array of UUIDs of the owners of this story.

Optionalproject_id

project_id?: number

The ID of the project the story belongs to.

Format

int64

Optionalstory_type

story_type?: string

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

Optionaltasks

tasks?: StoryContentsTask[]

An array of tasks connected to the story.

Optionalworkflow_state_id

workflow_state_id?: number

The ID of the workflow state the story is currently in.

Format

int64

Settings

Member Visibility

On This Page

Properties