Interface GetWorkflowTransitionRuleConfigurations

interface GetWorkflowTransitionRuleConfigurations {
    draft?: boolean;
    expand?: string;
    keys?: string[];
    maxResults?: number;
    startAt?: number;
    types: string[];
    withTags?: string[];
    workflowNames?: string[];
}

Properties

draft? expand? keys? maxResults? startAt? types withTags? workflowNames?

Properties

Optional draft

draft?: boolean

Whether draft or published workflows are returned. If not provided, both workflow types are returned.

Optional expand

expand?: string

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.

Optional keys

keys?: string[]

The transition rule class keys, as defined in the Connect or the Forge app descriptor, of the transition rules to return.

Optional maxResults

maxResults?: number

The maximum number of items to return per page.

Optional startAt

startAt?: number

The index of the first item to return in a page of results (page offset).

types

types: string[]

The types of the transition rules to return.

Optional withTags

withTags?: string[]

The list of tags to filter by.

Optional workflowNames

workflowNames?: string[]

The list of workflow names to filter by.

Settings

Member Visibility

Theme

On This Page

draftexpandkeysmaxResultsstartAttypeswithTagsworkflowNames