`kanboard` capability operations

kanboard capability operations

Kanban capability

Part of the pipeline capability catalog. Index: ../capabilities.md.

complete_task

Complete a task for the signed-in caller. Creates or updates data.
Example: {"id":1} (mutation)

Inputs (params):

Param Type Required Description
id int yes Task ID

Usage:

  - name: complete_task_step
    capability: kanboard
    operation: complete_task
    params:
      id: 0  # required

create_project

Create a project for the signed-in caller. Creates or updates data.
Example: {"name":"example"} (mutation)

Inputs (params):

Param Type Required Description
name string yes Project name
description string no Project description

Usage:

  - name: create_project_step
    capability: kanboard
    operation: create_project
    params:
      name: "..."  # required
      description: "..."

create_task

Create a task for the signed-in caller. Creates or updates data.
Example: {} (mutation)

Inputs (params):

Param Type Required Description
title string no Task title
description string no Task description
project_id int no Project ID
column_id int no Column ID
tags []string no Tags to assign
reference string no Reference URL or text
date_due int no Due date as unix timestamp
category_id int no Category ID
swimlane_id int no Swimlane ID

Usage:

  - name: create_task_step
    capability: kanboard
    operation: create_task
    params:
      title: "..."
      description: "..."
      project_id: 0
      column_id: 0
      tags: ["..."]
      reference: "..."
      date_due: 0
      category_id: 0
      swimlane_id: 0

delete_task

Delete a task for the signed-in caller. Deletes or removes data.
Example: {"id":1} (mutation)

Inputs (params):

Param Type Required Description
id int yes Task ID

Usage:

  - name: delete_task_step
    capability: kanboard
    operation: delete_task
    params:
      id: 0  # required

get_columns

Get columns for the signed-in caller. Read-only.
Example: {}

Inputs (params):

Param Type Required Description
project_id int no Project ID (defaults to 1)

Usage:

  - name: get_columns_step
    capability: kanboard
    operation: get_columns
    params:
      project_id: 0

get_task

Get a task for the signed-in caller. Read-only.
Example: {"id":1}

Inputs (params):

Param Type Required Description
id int yes Task ID

Usage:

  - name: get_task_step
    capability: kanboard
    operation: get_task
    params:
      id: 0  # required

health

Health check for the signed-in caller. Read-only.
Example: {}

Inputs (params):

(none)

Usage:

  - name: health_step
    capability: kanboard
    operation: health

list_categories

List categories for the signed-in caller. Read-only.
Example: {"limit":20}

Inputs (params):

Param Type Required Description
project_id int no Project ID (defaults to 1)

Usage:

  - name: list_categories_step
    capability: kanboard
    operation: list_categories
    params:
      project_id: 0

list_projects

List projects for the signed-in caller. Read-only.
Example: {"limit":20}

Inputs (params):

(none)

Usage:

  - name: list_projects_step
    capability: kanboard
    operation: list_projects

list_swimlanes

List swimlanes for the signed-in caller. Read-only.
Example: {"limit":20}

Inputs (params):

Param Type Required Description
project_id int no Project ID (defaults to 1)

Usage:

  - name: list_swimlanes_step
    capability: kanboard
    operation: list_swimlanes
    params:
      project_id: 0

list_tasks

List tasks for the signed-in caller. Read-only.
Example: {"limit":20}

Inputs (params):

Param Type Required Description
limit int no Maximum items per page
cursor string no Pagination cursor
sort_by string no Field to sort by
sort_order string no Sort order (asc/desc)
project_id int no Project ID filter
status string no Task status filter

Usage:

  - name: list_tasks_step
    capability: kanboard
    operation: list_tasks
    params:
      limit: 0
      cursor: "..."
      sort_by: "..."
      sort_order: "..."
      project_id: 0
      status: "..."

move_task

Move a task for the signed-in caller. Creates or updates data.
Example: {"id":1} (mutation)

Inputs (params):

Param Type Required Description
id int yes Task ID
column_id int no Target column ID
position int no Position in column
swimlane_id int no Target swimlane ID
project_id int no Target project ID

Usage:

  - name: move_task_step
    capability: kanboard
    operation: move_task
    params:
      id: 0  # required
      column_id: 0
      position: 0
      swimlane_id: 0
      project_id: 0

search_tasks

Search tasks for the signed-in caller. Read-only.
Example: {}

Inputs (params):

Param Type Required Description
limit int no Maximum items per page
cursor string no Pagination cursor
sort_by string no Field to sort by
sort_order string no Sort order (asc/desc)
q string no Search query
project_id int no Project ID filter

Usage:

  - name: search_tasks_step
    capability: kanboard
    operation: search_tasks
    params:
      limit: 0
      cursor: "..."
      sort_by: "..."
      sort_order: "..."
      q: "..."
      project_id: 0

update_task

Update a task for the signed-in caller. Creates or updates data.
Example: {"id":1} (mutation)

Inputs (params):

Param Type Required Description
id int yes Task ID
title string no New title
description string no New description
date_due int no Due date as unix timestamp
category_id int no Category ID
swimlane_id int no Swimlane ID

Usage:

  - name: update_task_step
    capability: kanboard
    operation: update_task
    params:
      id: 0  # required
      title: "..."
      description: "..."
      date_due: 0
      category_id: 0
      swimlane_id: 0