Skip to main content
Version: 8.10 (unreleased)

Type Alias: ProcessDefinitionFilter

type ProcessDefinitionFilter = object;

Process definition search filter.

Properties​

hasStartForm?​

optional hasStartForm?: boolean;

Indicates whether the start event of the process has an associated Form Key.

isLatestVersion?​

optional isLatestVersion?: boolean;

Whether to only return the latest version of each process definition. When using this filter, pagination functionality is limited, you can only paginate forward using after and limit. The response contains no startCursor in the page, and requests ignore the from and before in the page. When using this filter, sorting is limited to processDefinitionId and tenantId fields only.

name?​

optional name?: StringFilterProperty;

Name of this process definition.

processDefinitionId?​

optional processDefinitionId?: StringFilterProperty;

Process definition ID of this process definition.

processDefinitionKey?​

optional processDefinitionKey?: ProcessDefinitionKey;

The key for this process definition.

resourceName?​

optional resourceName?: string;

Resource name of this process definition.

tenantId?​

optional tenantId?: TenantId;

Tenant ID of this process definition.

version?​

optional version?: number;

Version of this process definition.

versionTag?​

optional versionTag?: string;

Version tag of this process definition.