Interface SearchStories

Hierarchy

  • SearchStories

Properties

archived?: boolean

A true/false boolean indicating whether the Story is in archived state.

completed_at_end?: string

Stories should have been completed on or before this date.

Format

date-time

completed_at_start?: string

Stories should have been completed on or after this date.

Format

date-time

created_at_end?: string

Stories should have been created on or before this date.

Format

date-time

created_at_start?: string

Stories should have been created on or after this date.

Format

date-time

deadline_end?: string

Stories should have a deadline on or before this date.

Format

date-time

deadline_start?: string

Stories should have a deadline on or after this date.

Format

date-time

epic_id?: number

The Epic IDs that may be associated with the Stories.

Format

int64

epic_ids?: number[]

The Epic IDs that may be associated with the Stories.

Unique Items

true

estimate?: number

The number of estimate points associate with the Stories.

Format

int64

external_id?: string

An ID or URL that references an external resource. Useful during imports.

group_id?: string

The Group ID that is associated with the Stories

Format

uuid

group_ids?: string[]

The Group IDs that are associated with the Stories

Unique Items

true

includes_description?: boolean

Whether to include the story description in the response.

iteration_id?: number

The Iteration ID that may be associated with the Stories.

Format

int64

iteration_ids?: number[]

The Iteration IDs that may be associated with the Stories.

Unique Items

true

label_ids?: number[]

The Label IDs that may be associated with the Stories.

Unique Items

true

label_name?: string

The name of any associated Labels.

Min Length

1

owner_id?: string

An array of UUIDs for any Users who may be Owners of the Stories.

Format

uuid

owner_ids?: string[]

An array of UUIDs for any Users who may be Owners of the Stories.

Unique Items

true

project_id?: number

The IDs for the Projects the Stories may be assigned to.

Format

int64

project_ids?: number[]

The IDs for the Projects the Stories may be assigned to.

Unique Items

true

requested_by_id?: string

The UUID of any Users who may have requested the Stories.

Format

uuid

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

The type of Stories that you want returned.

updated_at_end?: string

Stories should have been updated on or before this date.

Format

date-time

updated_at_start?: string

Stories should have been updated on or after this date.

Format

date-time

workflow_state_id?: number

The unique IDs of the specific Workflow States that the Stories should be in.

Format

int64

workflow_state_types?: ("done" | "started" | "backlog" | "unstarted")[]

The type of Workflow State the Stories may be in.

Generated using TypeDoc