Function: getWorkflow()

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

Defined in: src/server/api/workflowSchemes.ts:471

Returns the workflow mappings or requested mapping to the caller for the passed scheme.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ id: number; returnDraftIfExists?: boolean; workflowName?: string; }	-
parameters.id	number	The id of the scheme.
parameters.returnDraftIfExists?	boolean	When true indicates that a scheme's draft, if it exists, should be queried instead of the scheme itself.
parameters.workflowName?	string	The workflow mapping to return. Null can be passed to return all mappings. Must be a valid workflow name.
options?	RequestOptions	-

Returns

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