Workflow

A workflow instance.

Properties

Name	Type	Description
`context`	`object`	The workflow instance context.
`description`	`string`	The Description of this document.
`documents`	`object`	Any documents that are bound to the workflow instance.
`id`	`string`	The ID of this document.
`modelId`	`string`	The ID of the workflow model backing this workflow instance.
`modelVersion`	`string`	The version of the workflow model backing this workflow instance.
`projectId`	`string`	The ID of the project that this workflow instance was launched within (if applicable). If the workflow instance as not launched inside of a project, this will be null.
`projectTitle`	`string`	The title of the project that this workflow instance was launched within (if applicable). If the workflow instance as not launched inside of a project, this will be null.
`properties`	`object`	The properties for this document.
`runtimeApplicationId`	`string`	The ID of an Application that may be associated with the workflow instance (if applicable).
`runtimeBranchId`	`string`	The ID of a Branch that may be associated with the workflow instance (if applicable).
`runtimeEmailProviderId`	`string`	The ID of an Email Provider that may be associated with the workflow instance (if applicable).
`runtimeRepositoryId`	`string`	The ID of a Repository that may be associated with the workflow instance (if applicable).
`state`	`string`	The state of this workflow. Either `NOT_STARTED`, `RUNNING`, `SUSPENDED` or `TERMINATED`.
`swimlaneIds`	`array`	An array of swimlane IDs that have been defined for this workflow instance.
`timeCompleted`	`calendar`	The time when this workflow instance completed. If the workflow instance hasn't completed, this will be null.
`timeStarted`	`calendar`	The time when this workflow instance started.
`title`	`string`	The Title of this document.
`workflowData`	`object`	Any data that is bound to the workflow instance.

Methods

getSwimlanePrincipalIds

Usage

array getSwimlanePrincipalIds()

Arguments

None

Return

Type	Description
`array`

stringify

Usage

string stringify()

Arguments

None

Return

Type	Description
`string`

Examples

In this code sample, we take the JSON for the given document and produce a string representation of it.

var text = document.stringify(true);