WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. 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_node: string,
  parent_task_id: string,
  wait_for_completion: boolean,
  group_by: 'nodes' | 'parents'
})

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_node` or `parentNode`	`string` - Return tasks with specified parent node.
`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'` - Group tasks by nodes or parent/child relationships Default: `nodes`

« tasks.get termvectors »