module:model/WorkflowDefinition

module:model/WorkflowDefinition

new module:model/WorkflowDefinition(accountId, documentVersion, schemaVersion, steps, trigger, variables, workflowDescription, workflowName)

Source:

Constructs a new WorkflowDefinition.
A DS workflow definition.

Parameters:
Name Type Description
accountId String
documentVersion String
schemaVersion String
steps Array:.<Object:>

A list of #/definitions/DSWorkflowStep. Each element is: A DS Workflow Step. This object should be any of the following object models: [#/definitions/DSServiceStep, #/definitions/DSTransformationStep, #/definitions/DSDocGenStep, #/definitions/DSSignStep]
trigger module:model/DSWorkflowTrigger
variables Object:.<String:, Object:>

A DS Workflow variable record
workflowDescription String
workflowName String

Members

(inner) accountId :String

Source:
Type:
  • String

(inner) createdByName :String

Source:

The name of the user who created this workflow definition

Type:
  • String

(inner) documentVersion :String

Source:
Type:
  • String

(inner) participants :Object:.<String:, module:model/Participant:>

Source:

A DS Workflow participant record

Type:

(inner) schemaVersion :String

Source:
Type:
  • String

(inner) steps :Array:.<Object:>

Source:

A list of #/definitions/DSWorkflowStep. Each element is: A DS Workflow Step. This object should be any of the following object models: [#/definitions/DSServiceStep, #/definitions/DSTransformationStep, #/definitions/DSDocGenStep, #/definitions/DSSignStep]

Type:
  • Array:.<Object:>

(inner) trigger :module:model/DSWorkflowTrigger

Source:
Type:

(inner) variables :Object:.<String:, Object:>

Source:

A DS Workflow variable record

Type:
  • Object:.<String:, Object:>

(inner) workflowDescription :String

Source:
Type:
  • String

(inner) workflowName :String

Source:
Type:
  • String

Methods

(static) constructFromObject(data, obj) → {module:model/WorkflowDefinition}

Source:

Constructs a WorkflowDefinition from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.
obj module:model/WorkflowDefinition

Optional instance to populate.
Returns:

The populated WorkflowDefinition instance.

Type
module:model/WorkflowDefinition