NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

« tasks.get termvectors »

› ›

tasks.list

edit

tasks.list

edit

client.tasks.list({
  nodes: string | string[],
  actions: string | string[],
  detailed: boolean,
  parent_task_id: string,
  wait_for_completion: boolean,
  group_by: 'nodes' | 'parents' | 'none',
  timeout: string
})

Reference

`nodes`	`string \| string[]` - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you’re connecting to, leave empty to get information from all nodes
`actions`	`string \| string[]` - A comma-separated list of actions that should be returned. Leave empty to return all.
`detailed`	`boolean` - Return detailed task information (default: false)
`parent_task_id` or `parentTaskId`	`string` - Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
`wait_for_completion` or `waitForCompletion`	`boolean` - Wait for the matching tasks to complete (default: false)
`group_by` or `groupBy`	`'nodes' \| 'parents' \| 'none'` - Group tasks by nodes or parent/child relationships Default: `nodes`
`timeout`	`string` - Explicit operation timeout

« tasks.get termvectors »