tridion-sites-extensions-api-docs

Home > @tridion-sites/models > WorkItem

WorkItem class

Represents the data of a Work Item: the association between an item participating in workflow and an Activity.

Signature:

export declare class WorkItem extends WorkflowObject

Extends: WorkflowObject

Constructors

Constructor Modifiers Description
(constructor)({ backendModel, activity, owner, process, subject, subjectOwningRepository, …workflowObjectArgs })   Constructs a new instance of the WorkItem class

Properties

Property Modifiers Type Description
_backendModel   BackendWorkItem  
activity   Link | undefined Activity which contains the Work Item. If the Work Item is read in context of the Activity, the value is undefined. The value is only set if the Work Item is read stand-alone.
comment   string | undefined Work Item comments can be used to communicate between workflow participants. It does not have meaning for the CM system itself. When an Activity is finished, its Work Item comments are carried over to the next Activity.
getInternalModel   () => BackendWorkItem  
owner   Link | undefined <p>User who owns the Work Item.</p><p>The owner of the Work Item can view/edit the “Subject”. The owners of all Work Items of an Activity are called the “Workflow.Activity.Performers” of the Activity. In the future, each Work Item can have different Owner hence the Activity may have multiple Performers.</p>
process   Link | undefined <p>Process which contains the Work Item.</p><p>If the Work Item is read in context of the Process, the value is undefined The value is only set if the Work Item is read stand-alone.</p>
subject   Link | undefined The item participating in the workflow.
subjectOwningRepository   Link | undefined Owning Repository of the Subject.