get_board_cycle
Get boards with their budgets, budget change history, and associated cycles.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
openOnly | bool | No | true | When true, only returns open (non-closed) cycles. |
Returns
A list ofBoardDto objects, each containing:
boardId,boardName— board identitybudgetHours— total budget in hoursbudgetChanges— history of budget adjustments with reason, user, date, and deltacycles— list of cycles with ID, name, dates, budget, and closed status
get_board_reason_codes
Get the list of budget reason change codes used when adjusting board budgets.| Property | |
|---|---|
| Read-only | Yes |
Parameters
None.Returns
A list ofConfigBudgetReason objects with ID and name.
get_board_cycle_item_list
Get items within a specific cycle, with optional limit and description inclusion.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cycleId | string | Yes | — | Cycle ID to query items from. |
limit | int | No | 25 | Maximum number of items to return. |
includeDescription | bool | No | false | Include item descriptions in the response. |
Returns
A list ofCycleItemDto objects sorted by key, each containing: key, name, description (if requested), container, board, cycle, status, work estimate, time logged, resource type, and resource name.
create_board
Create a new planning board for organizing work into cycles.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Board name. |
container | string[] | No | Container IDs to associate. Use get_containers. |
resource | string[] | No | Resource (user) IDs to associate. Use get_user_list. |
budgetHours | int | No | Initial budget in hours. Uses the first available budget reason code. |
Returns
ABoardDto with the created board’s details.
update_board
Update board settings including name, containers, resources, and budget. Only provided fields are updated.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
boardId | string | Yes | Board ID. |
name | string | No | New board name. |
containerIds | string[] | No | Replace container associations. |
resourceIds | string[] | No | Replace resource associations. |
budgetChangeHours | int | No | Budget change amount in hours. Requires budgetChangeReasonId. |
budgetChangeReasonId | string | No | Reason code for the budget change. Use get_board_reason_codes. |
Returns
ABoardDto with the updated board details and current cycles.