@shortcut/client
    Preparing search index...

    Interface WorkflowState

    interface WorkflowState {
        color?: string | null;
        created_at?: string;
        description?: string;
        entity_type?: "workflow-state";
        id?: number;
        name?: string;
        num_stories?: number;
        num_story_templates?: number;
        position?: number;
        type?: string;
        updated_at?: string;
        verb?: string | null;
        workflow?: WorkflowSlim;
    }
    Index

    Properties

    color? created_at? description? entity_type? id? name? num_stories? num_story_templates? position? type? updated_at? verb? workflow?

    Properties

    color?: string | null

    The color of the Workflow State.

    created_at?: string

    The time/date the Workflow State was created.

    date-time

    description?: string

    The description of what sort of Stories belong in that Workflow State.

    entity_type?: "workflow-state"

    The type of this entity.

    id?: number

    The unique ID of the Workflow State.

    int64

    name?: string

    The name of the Workflow State.

    num_stories?: number

    The number of Stories currently in that Workflow State.

    int64

    Optionalnum_story_templates

    num_story_templates?: number

    The number of Story Templates associated with that Workflow State.

    int64

    position?: number

    The position that the Workflow State is in, starting with 0 at the left.

    int64

    type?: string

    The type of the Workflow State (backlog, unstarted, started, done).

    updated_at?: string

    The time/date the Workflow State was last updated.

    date-time

    verb?: string | null

    The verb that triggers a move to that Workflow State when making VCS commits.

    workflow?: WorkflowSlim

    The default Workflow for the Workspace the caller is authenticated against.

    Settings

    Member Visibility

    On This Page

    Properties