@dvelop-sdk
    Preparing search index...

    Interface SearchTasksParams

    Parameters for the searchTasks-function.

    interface SearchTasksParams {
        filter?: {
            assignee?: string[];
            attachment?: string[];
            completionDate?: string[];
            completionUser?: string[];
            contextKey?: string[];
            contextName?: string[];
            contextType?: string[];
            dmsObjectId?: string[];
            dmsRepoId?: string[];
            dueDate?: string[];
            metadata?: { [key: string]: string[] };
            priority?: (string | number)[];
            received?: string[];
            reminderDate?: string[];
            sender?: string[];
            state?: ("OPEN" | "COMPLETED")[];
            subject?: string[];
        };
        orderBy?: string;
        orderDir?: "ASC"
        | "DESC";
        pageSize?: number;
    }
    Index

    Properties

    filter? orderBy? orderDir? pageSize?

    Properties

    filter?: {
        assignee?: string[];
        attachment?: string[];
        completionDate?: string[];
        completionUser?: string[];
        contextKey?: string[];
        contextName?: string[];
        contextType?: string[];
        dmsObjectId?: string[];
        dmsRepoId?: string[];
        dueDate?: string[];
        metadata?: { [key: string]: string[] };
        priority?: (string | number)[];
        received?: string[];
        reminderDate?: string[];
        sender?: string[];
        state?: ("OPEN" | "COMPLETED")[];
        subject?: string[];
    }

    Optional search criteria.

    Type Declaration

    • Optionalassignee?: string[]

      Search for recipient. Minimum 1 character, maximum 255.

    • Optionalattachment?: string[]

      Search for attachment. Minimum 1 character, maximum 1.000.

    • OptionalcompletionDate?: string[]

      Search for completion date. Date format according to RFC3339. You can only search for a range.

    • OptionalcompletionUser?: string[]

      Search for user who completed the task. Minimum 1 character, maximum 255.

    • OptionalcontextKey?: string[]

      Search for context key. Max. 255 characters.

    • OptionalcontextName?: string[]

      Search for context name. Max. 255 characters.

    • OptionalcontextType?: string[]

      Search for context type. Max. 255 characters.

    • OptionaldmsObjectId?: string[]

      Search for DMS object ID. Minimum 1 character, maximum 100.

    • OptionaldmsRepoId?: string[]

      Search for DMS repository ID. Minimum 1 character, maximum 100.

    • OptionaldueDate?: string[]

      Search for due date. Date format according to RFC3339. You can only search for a range.

    • Optionalmetadata?: { [key: string]: string[] }

      Search for metadata. Can contain any quantity of metadata. You can only use metadata of the type “STRING” for the search.

    • Optionalpriority?: (string | number)[]

      Search for priority. Between 0 and 100. You can search for individual priorities (.e.g.: [50]) or priority ranges (e.g. [“[5 to 50]”]).

    • Optionalreceived?: string[]

      Search for date received. Date format according to RFC3339. You can only search for a range.

    • OptionalreminderDate?: string[]

      Search for reminder date. Date format according to RFC3339. You can only search for a range.

    • Optionalsender?: string[]

      Search for sender. Minimum 1 character, maximum 255.

    • Optionalstate?: ("OPEN" | "COMPLETED")[]

      Search for state. Permitted values: OPEN and COMPLETED.

    • Optionalsubject?: string[]

      Search for subject. Minimum 1 character, maximum 255.

    orderBy?: string

    Value used to sort the results. Permitted values: received, subject, priority and dueDate.

    orderDir?: "ASC" | "DESC"

    Specified sort order. Permitted values: ASC for sorting in ascending order and DESC for sorting in descending order.

    pageSize?: number

    Number of tasks per page in the results. Maximum 100.

    Settings

    Member Visibility

    On This Page

    Properties