Syntax

getWorkflowStatusIds(workflowName [, isDraft])

Package

Alias

Pkg Usage

Description

Retrieves an unique list of statuses (ids) for a given workflow.

Retrieves an unique list of statuses (ids) for a given workflow.

Parameters

Parameter name

Type

Required

Description

workflow name

String

Yes

Name of the given workflow.

isDraft

Boolean

No

Flag for specifying whether we should consider the draft or not. If not specified, it defaults to "false".

Return Type

String []

The return value is an array of strings, containing the ids for the existing statuses in the workflow.

Examples

Example 1

string key = "TEST-19";
return getWorkflowStatusIds(key.workflow);

Result: 1|3|4|5|6

Example 2

string key = "TEST-19";
return getWorkflowStatusIds(key.workflow, false);

Result: 1|3|4|5|6

Example 3

Setting the second parameter to "true", if we do have a draft where another status is added, the result will contain this status also.

string key = "TEST-19";
return getWorkflowStatusIds(key.workflow, true);

Result: 1|3|4|5|6|10100

See also