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?: null | string;
    description?: string;
    epic_id?: null | number;
    estimate?: null | 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?: null | string;
    iteration_id?: null | 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[];
    parent_story_id?: null | number;
    project_id?: null | number;
    requested_by_id?: string;
    source_task_id?: null | number;
    started_at_override?: string;
    story_links?: CreateStoryLinkParams[];
    story_template_id: string;
    story_type?: "feature" | "chore" | "bug";
    sub_tasks?: (CreateSubTaskParams | LinkSubTaskParams)[];
    tasks?: CreateTaskParams[];
    updated_at?: string;
    workflow_state_id?: number;
}

Properties

`Optional`archived

archived?: boolean

Controls the story's archived state.

`Optional`comments

comments?: CreateStoryCommentParams[]

An array of comments to add to the story.

`Optional`completed_at_override

completed_at_override?: string

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

Format

date-time

`Optional`created_at

created_at?: string

The time/date the Story was created.

Format

date-time

`Optional`custom_fields

custom_fields?: CustomFieldValueParams[]

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

`Optional`custom_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

`Optional`custom_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

`Optional`deadline

deadline?: null | string

The due date of the story.

Format

date-time

`Optional`description

description?: string

The description of the story.

Max Length

100000

`Optional`epic_id

epic_id?: null | number

The ID of the epic the story belongs to.

Format

int64

`Optional`estimate

estimate?: null | number

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

Format

int64

`Optional`external_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.

Max Length

1024

`Optional`external_links

external_links?: string[]

An array of External Links associated with this story.

`Optional`external_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

`Optional`external_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

`Optional`file_ids

file_ids?: number[]

An array of IDs of files attached to the story.

Unique Items

true

`Optional`file_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

`Optional`file_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

`Optional`follower_ids

follower_ids?: string[]

An array of UUIDs of the followers of this story.

Unique Items

true

`Optional`follower_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

`Optional`follower_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

`Optional`group_id

group_id?: null | string

The id of the group to associate with this story.

Format

uuid

`Optional`iteration_id

iteration_id?: null | number

The ID of the iteration the story belongs to.

Format

int64

`Optional`labels

labels?: CreateLabelParams[]

An array of labels attached to the story.

`Optional`labels_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

`Optional`labels_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

`Optional`linked_file_ids

linked_file_ids?: number[]

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

Unique Items

true

`Optional`linked_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

`Optional`linked_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

`Optional`move_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.

`Optional`name

name?: string

The name of the story. Must be provided if the template does not provide a name.

Min Length

Max Length

512

`Optional`owner_ids

owner_ids?: string[]

An array of UUIDs of the owners of this story.

Unique Items

true

`Optional`owner_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

`Optional`owner_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

`Optional`parent_story_id

parent_story_id?: null | number

The id of the parent story to associate with this story.

Format

int64

`Optional`project_id

project_id?: null | number

The ID of the project the story belongs to.

Format

int64

`Optional`requested_by_id

requested_by_id?: string

The ID of the member that requested the story.

Format

uuid

`Optional`source_task_id

source_task_id?: null | 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

`Optional`started_at_override

started_at_override?: string

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

Format

date-time

`Optional`story_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

`Optional`story_type

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

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

`Optional`sub_tasks

sub_tasks?: (CreateSubTaskParams | LinkSubTaskParams)[]

A list of either params to create a new sub-task or link an existing story as a sub-task

`Optional`tasks

tasks?: CreateTaskParams[]

An array of tasks connected to the story.

`Optional`updated_at

updated_at?: string

The time/date the Story was updated.

Format

date-time

`Optional`workflow_state_id

workflow_state_id?: number

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

Format

int64

Interface CreateStoryFromTemplateParams

Index

Properties

Properties

Optionalarchived

Optionalcomments

Optionalcompleted_at_override

Format

Optionalcreated_at

Format

Optionalcustom_fields

Optionalcustom_fields_add

Unique Items

Optionalcustom_fields_remove

Unique Items

Optionaldeadline

Format

Optionaldescription

Max Length

Optionalepic_id

Format

Optionalestimate

Format

Optionalexternal_id

Max Length

Optionalexternal_links

Optionalexternal_links_add

Unique Items

Optionalexternal_links_remove

Unique Items

Optionalfile_ids

Unique Items

Optionalfile_ids_add

Unique Items

Optionalfile_ids_remove

Unique Items

Optionalfollower_ids

Unique Items

Optionalfollower_ids_add

Unique Items

Optionalfollower_ids_remove

Unique Items

Optionalgroup_id

Format

Optionaliteration_id

Format

Optionallabels

Optionallabels_add

Unique Items

Optionallabels_remove

Unique Items

Optionallinked_file_ids

Unique Items

Optionallinked_file_ids_add

Unique Items

Optionallinked_file_ids_remove

Unique Items

Optionalmove_to

Optionalname

Min Length

Max Length

Optionalowner_ids

Unique Items

Optionalowner_ids_add

Unique Items

Optionalowner_ids_remove

Unique Items

Optionalparent_story_id

Format

Optionalproject_id

Format

Optionalrequested_by_id

Format

Optionalsource_task_id

Format

Optionalstarted_at_override

Format

Optionalstory_links

story_template_id

Format

`Optional`archived

`Optional`comments

`Optional`completed_at_override

`Optional`created_at

`Optional`custom_fields

`Optional`custom_fields_add

`Optional`custom_fields_remove

`Optional`deadline

`Optional`description

`Optional`epic_id

`Optional`estimate

`Optional`external_id

`Optional`external_links

`Optional`external_links_add

`Optional`external_links_remove

`Optional`file_ids

`Optional`file_ids_add

`Optional`file_ids_remove

`Optional`follower_ids

`Optional`follower_ids_add

`Optional`follower_ids_remove

`Optional`group_id

`Optional`iteration_id

`Optional`labels

`Optional`labels_add

`Optional`labels_remove

`Optional`linked_file_ids

`Optional`linked_file_ids_add

`Optional`linked_file_ids_remove

`Optional`move_to

`Optional`name

`Optional`owner_ids

`Optional`owner_ids_add

`Optional`owner_ids_remove

`Optional`parent_story_id

`Optional`project_id

`Optional`requested_by_id

`Optional`source_task_id

`Optional`started_at_override

`Optional`story_links

`Optional`story_type

`Optional`sub_tasks

`Optional`tasks

`Optional`updated_at

`Optional`workflow_state_id