Interface CreateStoryFromTemplateParams

Request parameters for creating a story from a story template. These parameters are merged with the values derived from the template.

interface CreateStoryFromTemplateParams {
    archived?: boolean;
    comments?: CreateStoryCommentParams[];
    completed_at_override?: string;
    created_at?: string;
    custom_fields?: CustomFieldValueParams[];
    custom_fields_add?: CustomFieldValueParams[];
    custom_fields_remove?: RemoveCustomFieldParams[];
    deadline?: string;
    description?: string;
    epic_id?: number;
    estimate?: number;
    external_id?: string;
    external_links?: string[];
    external_links_add?: string[];
    external_links_remove?: string[];
    file_ids?: number[];
    file_ids_add?: number[];
    file_ids_remove?: number[];
    follower_ids?: string[];
    follower_ids_add?: string[];
    follower_ids_remove?: string[];
    group_id?: string;
    iteration_id?: number;
    labels?: CreateLabelParams[];
    labels_add?: CreateLabelParams[];
    labels_remove?: RemoveLabelParams[];
    linked_file_ids?: number[];
    linked_file_ids_add?: number[];
    linked_file_ids_remove?: number[];
    move_to?: "last" | "first";
    name?: string;
    owner_ids?: string[];
    owner_ids_add?: string[];
    owner_ids_remove?: string[];
    project_id?: number;
    requested_by_id?: string;
    source_task_id?: number;
    started_at_override?: string;
    story_links?: CreateStoryLinkParams[];
    story_template_id: string;
    story_type?: "feature" | "chore" | "bug";
    tasks?: CreateTaskParams[];
    updated_at?: string;
    workflow_state_id?: number;
}

Properties

archived? comments? completed_at_override? created_at? custom_fields? custom_fields_add? custom_fields_remove? deadline? description? epic_id? estimate? external_id? external_links? external_links_add? external_links_remove? file_ids? file_ids_add? file_ids_remove? follower_ids? follower_ids_add? follower_ids_remove? group_id? iteration_id? labels? labels_add? labels_remove? linked_file_ids? linked_file_ids_add? linked_file_ids_remove? move_to? name? owner_ids? owner_ids_add? owner_ids_remove? project_id? requested_by_id? source_task_id? started_at_override? story_links? story_template_id story_type? tasks? updated_at? workflow_state_id?

Properties

Optionalarchived

archived?: boolean

Controls the story's archived state.

Optionalcomments

comments?: CreateStoryCommentParams[]

An array of comments to add to the story.

Optionalcompleted_at_override

completed_at_override?: string

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

Format

date-time

Optionalcreated_at

created_at?: string

The time/date the Story was created.

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.

Optionalcustom_fields_add

custom_fields_add?: CustomFieldValueParams[]

A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField. These will be added to any fields provided by the template. Cannot be used in conjunction with custom_fields.

Unique Items

true

Optionalcustom_fields_remove

custom_fields_remove?: RemoveCustomFieldParams[]

A map specifying a CustomField ID. These will be removed from any fields provided by the template. Cannot be used in conjunction with custom_fields.

Unique Items

true

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_id

external_id?: string

This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.

Optionalexternal_links

external_links?: string[]

An array of External Links associated with this story.

Optionalexternal_links_add

external_links_add?: string[]

An array of External Links associated with this story. These will be added to any links provided by the template. Cannot be used in conjunction with external_links.

Unique Items

true

Optionalexternal_links_remove

external_links_remove?: string[]

An array of External Links associated with this story. These will be removed from any links provided by the template. Cannot be used in conjunction with external_links.

Unique Items

true

Optionalfile_ids

file_ids?: number[]

An array of IDs of files attached to the story.

Unique Items

true

Optionalfile_ids_add

file_ids_add?: number[]

An array of IDs of files attached to the story in addition to files from the template. Cannot be used in conjunction with file_ids.

Unique Items

true

Optionalfile_ids_remove

file_ids_remove?: number[]

An array of IDs of files removed from files from the template. Cannot be used in conjunction with file_ids.

Unique Items

true

Optionalfollower_ids

follower_ids?: string[]

An array of UUIDs of the followers of this story.

Unique Items

true

Optionalfollower_ids_add

follower_ids_add?: string[]

The UUIDs of the new followers to be added in addition to followers from the template. Cannot be used in conjunction with follower_ids.

Unique Items

true

Optionalfollower_ids_remove

follower_ids_remove?: string[]

The UUIDs of the new followers to be removed from followers from the template. Cannot be used in conjunction with follower_ids.

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.

Optionallabels_add

labels_add?: CreateLabelParams[]

An array of labels attached to the story in addition to the labels provided by the template. Cannot be used in conjunction with labels.

Unique Items

true

Optionallabels_remove

labels_remove?: RemoveLabelParams[]

An array of labels to remove from the labels provided by the template. Cannot be used in conjunction with labels.

Unique Items

true

Optionallinked_file_ids

linked_file_ids?: number[]

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

Unique Items

true

Optionallinked_file_ids_add

linked_file_ids_add?: number[]

An array of IDs of linked files attached to the story in addition to files from the template. Cannot be used in conjunction with linked_files.

Unique Items

true

Optionallinked_file_ids_remove

linked_file_ids_remove?: number[]

An array of IDs of linked files removed from files from the template. Cannot be used in conjunction with linked_files.

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 name of the story. Must be provided if the template does not provide a name.

Min Length

1

Max Length

512

Optionalowner_ids

owner_ids?: string[]

An array of UUIDs of the owners of this story.

Unique Items

true

Optionalowner_ids_add

owner_ids_add?: string[]

The UUIDs of the new owners to be added in addition to owners from the template. Cannot be used in conjunction with owners.

Unique Items

true

Optionalowner_ids_remove

owner_ids_remove?: string[]

The UUIDs of the new owners to be removed from owners from the template. Cannot be used in conjunction with owners.

Unique Items

true

Optionalproject_id

project_id?: number

The ID of the project the story belongs to.

Format

int64

Optionalrequested_by_id

requested_by_id?: string

The ID of the member that requested the story.

Format

uuid

Optionalsource_task_id

source_task_id?: number

Given this story was converted from a task in another story, this is the original task ID that was converted to this story.

Format

int64

Optionalstarted_at_override

started_at_override?: string

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

Format

date-time

Optionalstory_links

story_links?: CreateStoryLinkParams[]

An array of story links attached to the story.

story_template_id

story_template_id: string

The id of the story template used to create this story.

Format

uuid

Optionalstory_type

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

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

Optionaltasks

tasks?: CreateTaskParams[]

An array of tasks connected to the story.

Optionalupdated_at

updated_at?: string

The time/date the Story was updated.

Format

date-time

Optionalworkflow_state_id

workflow_state_id?: number

The ID of the workflow state the story will be in.

Format

int64

Settings

Member Visibility

On This Page

Properties