Function: readWorkflows()

function readWorkflows(client, parameters): Promise<{
[key: string]: unknown;
  statuses?: object[];
  workflows?: object[];
}>;

Defined in: src/cloud/api/workflows.ts:191

Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types.

Permissions required:

• Administer Jira global permission to access all, including project-scoped, workflows
• At least one of the Administer projects and View (read-only) workflow project permissions to access project-scoped workflows

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ projectAndIssueTypes?: object[]; workflowIds?: string[]; workflowNames?: string[]; }	-
parameters.projectAndIssueTypes?	object[]	The list of projects and issue types to query.
parameters.workflowIds?	string[]	The list of workflow IDs to query.
parameters.workflowNames?	string[]	The list of workflow names to query.

Returns

Promise<{ [key: string]: unknown; statuses?: object[]; workflows?: object[]; }>