@camunda8/sdk
    Preparing search index...

    Interface SearchProcessDefinitionsRequest

    interface SearchProcessDefinitionsRequest {
        filter: {
            name?: string;
            processDefinitionId?: string;
            processDefinitionKey?: string;
            resourceName?: string;
            tenantId?: string;
            version?: number;
            versionTag?: string;
        };
        page?: SearchPageRequest;
        sort: {
            field: | "name"
            | "processDefinitionKey"
            | "tenantId"
            | "version"
            | "processDefinitionId"
            | "resourceName"
            | "versionTag";
            order?: "ASC"
            | "DESC";
        }[];
    }
    Index

    Properties

    filter page? sort

    Properties

    filter: {
        name?: string;
        processDefinitionId?: string;
        processDefinitionKey?: string;
        resourceName?: string;
        tenantId?: string;
        version?: number;
        versionTag?: string;
    }

    Process definition search filter.

    Type declaration

    • Optionalname?: string

      Name of this process definition.

    • OptionalprocessDefinitionId?: string

      Process definition ID of this process definition.

    • OptionalprocessDefinitionKey?: string

      The key for this process definition.

    • OptionalresourceName?: string

      Resource name of this process definition.

    • OptionaltenantId?: string

      Tenant ID of this process definition.

    • Optionalversion?: number

      Version of this process definition.

    • OptionalversionTag?: string

      Version tag of this process definition.

    Optionalpage

    page?: SearchPageRequest

    Pagination criteria.

    sort: {
        field:
            | "name"
            | "processDefinitionKey"
            | "tenantId"
            | "version"
            | "processDefinitionId"
            | "resourceName"
            | "versionTag";
        order?: "ASC"
        | "DESC";
    }[]

    Sort field criteria.

    Type declaration

    • field:
          | "name"
          | "processDefinitionKey"
          | "tenantId"
          | "version"
          | "processDefinitionId"
          | "resourceName"
          | "versionTag"
    • Optionalorder?: "ASC" | "DESC"

      The order in which to sort the related field. Default value: ASC

    Settings

    Member Visibility

    On This Page

    Properties