Function: getWorkflow()

function getWorkflow(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  defaultMapping?: boolean;
  issueTypes?: string[];
  updateDraftIfNeeded?: boolean;
  workflow?: string;
}>;

Defined in: src/cloud/api/workflowSchemes.ts:433

Returns the workflow-issue type mappings for a workflow scheme.

Permissions required:Administer Jira global permission.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ id: number; returnDraftIfExists?: boolean; workflowName?: string; }	-
parameters.id	number	The ID of the workflow scheme.
parameters.returnDraftIfExists?	boolean	Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned.
parameters.workflowName?	string	The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; defaultMapping?: boolean; issueTypes?: string[]; updateDraftIfNeeded?: boolean; workflow?: string; }>