Interface StorySearchResult

A Story in search results. This is typed differently from Story because the details=slim search argument will omit some fields.

Hierarchy

  • StorySearchResult

Properties

app_url: string

The Shortcut application url for the Story.

archived: boolean

True if the story has been archived or not.

blocked: boolean

A true/false boolean indicating if the Story is currently blocked.

blocker: boolean

A true/false boolean indicating if the Story is currently a blocker of another story.

branches?: Branch[]

An array of Git branches attached to the story.

comment_ids?: number[]

An array of IDs of Comments attached to the story.

comments?: StoryComment[]

An array of comments attached to the story.

commits?: Commit[]

An array of commits attached to the story.

completed: boolean

A true/false boolean indicating if the Story has been completed.

completed_at?: string

The time/date the Story was completed.

Format

date-time

completed_at_override?: string

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

Format

date-time

created_at: string

The time/date the Story was created.

Format

date-time

custom_fields?: StoryCustomField[]

An array of CustomField value assertions for the story.

cycle_time?: number

The cycle time (in seconds) of this story when complete.

Format

int64

deadline?: string

The due date of the story.

Format

date-time

description?: string

The description of the story.

entity_type: string

A string description of this resource.

epic_id?: number

The ID of the epic the story belongs to.

Format

int64

estimate?: number

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

Format

int64

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.

external_links: string[]

An array of external links (strings) associated with a Story

file_ids?: number[]

An array of IDs of Files attached to the story.

files?: UploadedFile[]

An array of files attached to the story.

follower_ids: string[]

An array of UUIDs for any Members listed as Followers.

global_id: string
group_id?: string

The ID of the group associated with the story.

Format

uuid

group_mention_ids: string[]

An array of Group IDs that have been mentioned in the Story description.

id: number

The unique ID of the Story.

Format

int64

iteration_id?: number

The ID of the iteration the story belongs to.

Format

int64

label_ids: number[]

An array of label ids attached to the story.

labels: LabelSlim[]

An array of labels attached to the story.

lead_time?: number

The lead time (in seconds) of this story when complete.

Format

int64

linked_file_ids?: number[]

An array of IDs of LinkedFiles attached to the story.

linked_files?: LinkedFile[]

An array of linked files attached to the story.

member_mention_ids: string[]

An array of Member IDs that have been mentioned in the Story description.

mention_ids: string[]

Deprecated: use member_mention_ids.

moved_at?: string

The time/date the Story was last changed workflow-state.

Format

date-time

name: string

The name of the story.

num_tasks_completed?: number

The number of tasks on the story which are complete.

Format

int64

owner_ids: string[]

An array of UUIDs of the owners of this story.

position: number

A number representing the position of the story in relation to every other story in the current project.

Format

int64

previous_iteration_ids: number[]

The IDs of the iteration the story belongs to.

project_id?: number

The ID of the project the story belongs to.

Format

int64

pull_requests?: PullRequest[]

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

requested_by_id: string

The ID of the Member that requested the story.

Format

uuid

started: boolean

A true/false boolean indicating if the Story has been started.

started_at?: string

The time/date the Story was started.

Format

date-time

started_at_override?: string

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

Format

date-time

stats: StoryStats

The stats object for Stories

story_links: TypedStoryLink[]

An array of story links attached to the Story.

story_template_id?: string

The ID of the story template used to create this story, or null if not created using a template.

Format

uuid

story_type: string

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

synced_item?: SyncedItem

The synced item for the story.

task_ids?: number[]

An array of IDs of Tasks attached to the story.

tasks?: Task[]

An array of tasks connected to the story.

unresolved_blocker_comments?: number[]

The IDs of any unresolved blocker comments on the Story.

updated_at?: string

The time/date the Story was updated.

Format

date-time

workflow_id: number

The ID of the workflow the story belongs to.

Format

int64

workflow_state_id: number

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

Format

int64

Generated using TypeDoc