Add a Plan board
add_boardPut a Plan board on a tab in Plan (any other tab is refused): a preset (kanban, todo, sprint, bug-triage, retro, roadmap, weekly...) or columns by name, placed beside what the tab holds. A column named like one the document already has shares it, so its cards show on both. Then add cards with change_items.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tabId | No | The tab to put it on, which must be in Plan; defaults to the first tab with a board, else the first tab. | |
| title | No | The board’s title. | |
| types | No | The card types it shows and takes, by name or id; an empty list takes none. Absent: the preset’s (todo takes Actions, roadmap Projects, sprint Stories, Tasks and Bugs...; the answer says), or every type for columns by name. A preset’s Bug or Story the document lacks is added to its card types. | |
| preset | No | A ready-made board: its columns, card fields and widgets. Defaults to kanban (blank with columns). | |
| columns | No | Column names, left to right, replacing the preset’s. A name the document’s boards already use shares their column, so its cards show here too. | |
| documentId | Yes | The document (from find_documents). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rev | Yes | The tab revision after it. | |
| url | Yes | Link that opens the document in the livediagram editor. | |
| tabId | Yes | The tab it was put on. | |
| takes | Yes | The card types it shows: a card of another type is saved but no board shows it. | |
| title | Yes | The board’s title. | |
| brought | Yes | Card types the board brought into the document, by name (a bug-triage board brings Bug when the document lacks it); empty when it had them all. | |
| columns | Yes | Its columns, left to right. | |
| elementId | Yes | The board element id. | |
| changesetId | Yes | The changeset that added it (revertible). |