Sanity Library Reference Docs
    Preparing search index...

    Interface ProjectedInstanceSummary

    interface ProjectedInstanceSummary {
        assignment?: AssignmentStateCounts;
        currentStage: string;
        currentStageTitle?: string;
        definition: string;
        done: boolean;
        instanceId: string;
        lastChangedAt: string;
        subject?: ProjectedSubject;
        workflowTitle?: string;
    }
    Index

    Properties

    assignment? currentStage currentStageTitle? definition done instanceId lastChangedAt subject? workflowTitle?

    Properties

    assignment?: AssignmentStateCounts

    Viewer-scoped assignment slots when the list call supplied an assignment identity.

    currentStage: string

    Current stage name.

    currentStageTitle?: string

    Stage's human-readable title, when the definition supplies one.

    definition: string

    The name of the workflow definition this instance was started from.

    done: boolean

    Whether the instance is in a terminal stage (no further actions possible).

    instanceId: string

    Sanity document id of the workflow.instance.

    lastChangedAt: string

    ISO timestamp the instance was last changed.

    subject?: ProjectedSubject

    What this workflow is about. See ProjectedSubject.

    workflowTitle?: string

    Human-readable title of the workflow, sourced from the instance's definitionSnapshot. Reflects the title as of the version the instance was started under — a definition renamed later won't change running instances. Absent if the definition has no title.

    Settings

    Member Visibility

    On This Page

    Properties