Skip to content

Function: readWorkflowFromHistory() ​

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

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

Returns a workflow and related statuses for a specified workflow id and version number.

Note: Stored workflow data expires after 60 days. Additionally, no data from before the 30th of October 2025 is available.

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 ​

ParameterType
clientClient
parameters{ version?: number; workflowId?: string; }
parameters.version?number
parameters.workflowId?string
options?RequestOptions

Returns ​

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