Function: getWorkflowTransitionRuleConfigurations()

function getWorkflowTransitionRuleConfigurations(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;

Defined in: src/cloud/api/workflowTransitionRules.ts:32

Returns a paginated list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules:

• Of one or more transition rule types, such as workflow post functions.
• Matching one or more transition rule keys.

Only workflows containing transition rules created by the calling Connect or Forge app are returned.

Due to server-side optimizations, workflows with an empty list of rules may be returned; these workflows can be ignored.

Permissions required: Only Connect or Forge apps can use this operation.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ draft?: boolean; expand?: | "transition" | string & object | ("transition" | string & object)[]; keys?: string[]; maxResults?: number; startAt?: number; types: (string & object | "postfunction" | "condition" | "validator")[]; withTags?: string[]; workflowNames?: string[]; }	-
parameters.draft?	boolean	Deprecated: Whether draft or published workflows are returned. If not provided, both workflow types are returned. The 'draft' parameter will be removed from this API on November 2, 2026.
parameters.expand?	| "transition" | string & object | ("transition" | string & object)[]	Use 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.keys?	string[]	The transition rule class keys, as defined in the Connect or the Forge app descriptor, of the transition rules to return.
parameters.maxResults?	number	The maximum number of items to return per page.
parameters.startAt?	number	The index of the first item to return in a page of results (page offset).
parameters.types?	(string & object | "postfunction" | "condition" | "validator")[]	The types of the transition rules to return.
parameters.withTags?	string[]	The list of tags to filter by.
parameters.workflowNames?	string[]	The list of workflow names to filter by.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>