Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SearchTasksParams

Parameters for the searchTasks-function.

Hierarchy

  • SearchTasksParams

Index

Properties

Properties

Optional filter

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

Optional search criteria.

Type declaration

  • Optional assignee?: string[]

    Search for recipient. Minimum 1 character, maximum 255.

  • Optional attachment?: string[]
    Search for attachment.     Minimum 1 character, maximum 1.000.
  • Optional completionDate?: string[]

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

  • Optional completionUser?: string[]

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

  • Optional contextKey?: string[]

    Search for context key. Max. 255 characters.

  • Optional contextName?: string[]
    Search for context name.     Max. 255 characters.
  • Optional contextType?: string[]
    Search for context type.     Max. 255 characters.
  • Optional dmsObjectId?: string[]
    Search for DMS object ID.     Minimum 1 character, maximum 100.
  • Optional dmsRepoId?: string[]

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

  • Optional dueDate?: string[]

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

  • Optional metadata?: {}

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

    • [key: string]: string[]

      Search entry for an individual piece of metadata. Minimum 1 character, maximum 255. The key contains a minimum of 1 character, maximum 255.

  • Optional priority?: (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]”]).

  • Optional received?: string[]
    Search for date received. Date format according to RFC3339. You can only search for a range.
  • Optional reminderDate?: string[]

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

  • Optional sender?: string[]

    Search for sender. Minimum 1 character, maximum 255.

  • Optional state?: ("OPEN" | "COMPLETED")[]

    Search for state. Permitted values: OPEN and COMPLETED.

  • Optional subject?: string[]

    Search for subject. Minimum 1 character, maximum 255.

Optional orderBy

orderBy?: string

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

Optional orderDir

orderDir?: "ASC" | "DESC"

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

Optional pageSize

pageSize?: number

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

Generated using TypeDoc