Interface BTObjectWorkflowInfo

An workflowable object like Release or Task that supports states and transitions.

Export

Interface

BTObjectWorkflowInfo

Hierarchy

  • BTObjectWorkflowInfo

Properties

canBeDiscarded? href? id? isDiscarded? isFrozen? metadataState? name? objectType? stateId? viewRef? workflowId?

Properties

Optional canBeDiscarded

canBeDiscarded?: boolean

Whether workflowable object can be discarded.

Memberof

BTObjectWorkflowInfo

Optional href

href?: string

URI to fetch complete information of the resource.

Memberof

BTObjectWorkflowInfo

Optional id

id?: string

Id of the resource.

Memberof

BTObjectWorkflowInfo

Optional isDiscarded

isDiscarded?: boolean

Whether workflowable object has been discarded.

Memberof

BTObjectWorkflowInfo

Optional isFrozen

isFrozen?: boolean

Whether workflowable object has reached terminal state and is frozen.

Memberof

BTObjectWorkflowInfo

Optional metadataState

metadataState?: BTMetadataStateType

Memberof

BTObjectWorkflowInfo

Optional name

name?: string

Name of the resource.

Memberof

BTObjectWorkflowInfo

Optional objectType

objectType?: BTAPIWorkflowableType

Memberof

BTObjectWorkflowInfo

Optional stateId

stateId?: string

The current state of object like SETUP, REJECTED etc. Custom workflows can have any declared state.

Memberof

BTObjectWorkflowInfo

Optional viewRef

viewRef?: string

URI to visualize the resource in a webclient if applicable.

Memberof

BTObjectWorkflowInfo

Optional workflowId

workflowId?: string

The workflow definition id that governs this object's states and transitions.

Memberof

BTObjectWorkflowInfo

Settings

Member Visibility

Theme

Generated using TypeDoc