Skip to content

Function: workflowRuleSearch() ​

ts
function workflowRuleSearch(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  invalidRules?: string[];
  validRules?: object[];
  workflowEntityId?: string;
}>;

Defined in: src/cloud/api/appMigration.ts:63

Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect app.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ Atlassian-Transfer-Id: string; expand?: string; ruleIds: string[]; workflowEntityId: string; }-
parameters.Atlassian-Transfer-IdstringThe app migration transfer ID.
parameters.expand?stringUse expand to include additional information in the response. This parameter accepts transition which, for each rule, returns information about the transition the rule is assigned to.
parameters.ruleIds?string[]The list of workflow rule IDs.
parameters.workflowEntityId?stringThe workflow ID.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; invalidRules?: string[]; validRules?: object[]; workflowEntityId?: string; }>