Function: readWorkflowPreviews()

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

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

Returns a requested workflow within a given project. The response provides a read-only preview of the workflow, omitting full configuration details.

Permissions required:

• At least one of the Administer projects and View (read-only) workflow project permissions

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ issueTypeIds?: string[]; projectId: string; workflowIds?: string[]; workflowNames?: string[]; }	-
parameters.issueTypeIds?	string[]	The list of issue type IDs. At most 25 issue type IDs can be specified.
parameters.projectId?	string	The projectId parameter is required and will be used for permission checks. In addition, you must supply at least one of the following lookup terms: workflowNames, workflowIds, or issueTypeIds. The specified workflows must be associated with the given project.
parameters.workflowIds?	string[]	The list of workflow IDs to be returned. At most 25 workflow IDs can be specified.
parameters.workflowNames?	string[]	The list of workflow names to be returned. At most 25 workflow names can be specified.
options?	RequestOptions	-

Returns

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