Interface WorkflowStatusUpdate

Details of the status being updated.

interface WorkflowStatusUpdate {
    description?: string;
    id?: string;
    name: string;
    statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
    statusReference: string;
}

Hierarchy

  • Record<string, unknown>
    • WorkflowStatusUpdate

Properties

description? id? name statusCategory statusReference

Properties

Optionaldescription

description?: string

The description of the status.

Optionalid

id?: string

The ID of the status. When reusing an existing status, this field should be provided.

name

name: string

The name of the status.

statusCategory

statusCategory: "TODO" | "IN_PROGRESS" | "DONE"

The category of the status.

statusReference

statusReference: string

The reference of the status. If adding a new status to a team-managed workflow, this must be a UUID (for company-managed a UUID is not needed).

Settings

Member Visibility

On This Page

Properties