Interface ObjectiveSearchResult

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

Hierarchy

  • ObjectiveSearchResult

Properties

app_url: string

The Shortcut application url for the Milestone.

archived: boolean

A boolean indicating whether the Milestone has been archived or not.

categories: Category[]

An array of Categories attached to the Milestone.

completed: boolean

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

completed_at?: string

The time/date the Milestone was completed.

Format

date-time

completed_at_override?: string

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

Format

date-time

created_at: string

The time/date the Milestone was created.

Format

date-time

description?: string

The Milestone's description.

entity_type: string

A string description of this resource.

global_id: string
id: number

The unique ID of the Milestone.

Format

int64

key_result_ids: string[]

The IDs of the Key Results associated with the Objective.

name: string

The name of the Milestone.

position: number

A number representing the position of the Milestone in relation to every other Milestone within the Workspace.

Format

int64

started: boolean

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

started_at?: string

The time/date the Milestone was started.

Format

date-time

started_at_override?: string

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

Format

date-time

state: string

The workflow state that the Milestone is in.

A group of calculated values for this Milestone.

updated_at: string

The time/date the Milestone was updated.

Format

date-time

Generated using TypeDoc