Columns
A column of a board, such as Backlog or In review, or a sub-column inside another column. The type tells whether the cards in it are waiting, in progress or done. Cards refer to the column with column_ref, which must be a column of the card's board. Sub-columns point at their parent with parent_column_ref on the same board. Top-level columns stand on the board in the order of their records, and the sub-columns of a column in the order of theirs.
A record of this entity needs records of other entities in the package: Boards.
Files in the package
List every file of this entity in resource_files of the manifest, with "resource": "columns". An entity can have any number of files. See Bundle format.
[
{
"resource": "columns",
"path": "resources/columns.json"
}
]Fields
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string (ExternalId) | Yes | Your own identifier of the record, for example k-mrr, unique within the resource across all of its files and case sensitive. Other records refer to this one by it. The import also keeps it as the external id of the object it creates.Constraints: 1–512 characters. |
board_ref | Ref<boards> refers to Boards | Yes | The board the column belongs to. Give the external_id of a boards record. |
title | string | Yes | Name of the column, for example In review. Up to 128 characters.Constraints: 1–128 characters. |
type | enum | Yes | What the cards in this column count as: queued (not started), in_progress (being worked on) or done (finished). A card takes its state from its column: moving into a done column marks it completed and records when, and its first move into an in_progress column records when work started.Constraints: one of queued, in_progress, done. |
parent_column_ref | Ref<columns>? refers to Columns | No | The column this sub-column sits inside, for example In progress for the sub-columns Doing and Review. Give the external_id of a columns record on the same board; leave it out for a top-level column. A column cannot be inside itself, directly or through other columns.Rule: A column of the same board. |
wip_limit | integer? | No | The most cards the column should hold at the same time (its work-in-progress limit), at least 1. When the column holds more, the board highlights it. The limit counts cards, not their size; leave it out for no limit. Constraints: >= 1. |
References
Referenced by
- Activities:
payload.column_ref,payload.from.column_ref,payload.to.column_ref - Card history:
snapshot.column_ref - Cards:
column_ref - Columns:
parent_column_ref
Columns
Show on the entity map
Example
A record of this entity:
{
"external_id": "c-backlog",
"board_ref": "b-kpi",
"title": "Backlog",
"type": "queued"
}Rules
- parent_column_ref builds a tree; no record can be its own ancestor.
Related entities
Boards, Cards, Lanes
Check after the import
After the import, the records of this entity can be checked on Columns › Get list of columns and Subcolumn › Get list of subcolumns.
JSON Schema
columns.json
