Perencanaan
Cycle, module, epic, release, dan milestone.
Cycle, module, epic, release, dan milestone. Lihat Token dan izin untuk aturan akses.
| Tool | Jenis | Ringkasan |
|---|---|---|
get_cycle | baca | Reads a cycle (sprint) with its progress and work items. |
create_cycle | tulis | Creates a cycle (sprint) in a project. |
update_cycle | tulis | Changes a cycle. |
delete_cycle | tulis | Deletes a cycle; its work items stay but leave the cycle. |
cycle_burndown | baca | Burndown of a cycle: open work items left per day against the ideal line (null for days ahead). |
transfer_cycle_items | tulis | Moves the unfinished work items of a completed cycle into another (not completed) cycle. |
add_work_items_to | tulis | Adds work items to a cycle, module, epic, milestone or release of their project. |
remove_work_items_from | tulis | Takes work items out of a cycle, module, epic, milestone or release. |
get_module | baca | Reads a module with its lead, members, links, progress and work items. |
create_module | tulis | Creates a module in a project. |
update_module | tulis | Changes a module. |
delete_module | tulis | Deletes a module; its work items stay. |
add_module_link | tulis | Adds a web link (http/https) to a module. |
remove_module_link | tulis | Removes a link from a module, by link id (see get_module) or its exact url. |
list_epics | baca | Lists the epics of a project with status, owner and progress. |
get_epic | baca | Reads an epic with its progress and work items. |
create_epic | tulis | Creates an epic in a project (epics must be enabled for it). |
update_epic | tulis | Changes an epic. |
delete_epic | tulis | Deletes an epic; its work items stay. |
list_releases | baca | Lists the releases of a project with status, dates and progress. |
get_release | baca | Reads a release with its progress and work items. |
create_release | tulis | Creates a release in a project. |
update_release | tulis | Changes a release. |
delete_release | tulis | Deletes a release; its work items stay. |
mark_release_released | tulis | Marks a release as released (today unless released_on is given) and notifies its lead and assignees. |
list_release_labels | baca | Lists the release labels of a workspace (shared by all its projects). |
list_milestones | baca | Lists the milestones of a project with target date, overdue flag and progress. |
create_milestone | tulis | Creates a milestone in a project. |
update_milestone | tulis | Changes a milestone. |
delete_milestone | tulis | Deletes a milestone; its work items stay. |
get_estimate_system | baca | Reads a project's estimate system: none, points, time (hours) or categories (sizes like XS..XL), and its values. |
set_estimate_system | tulis | Sets a project's estimate system and optionally its values (default values when switching: points 1,2,3,5,8,13; time 1,2,4,8; categories XS,S,M,L,XL). |
add_estimate_values | tulis | Adds values to a project's estimate system (numbers for points/time, labels for categories). |
remove_estimate_values | tulis | Removes values from a project's estimate system. |
get_epic_settings | baca | Reads a project's epic settings: whether epics are on, status mode (manual, or auto = follows its work items) and the default status of new epics. |
set_epic_settings | tulis | Changes a project's epic settings. enabled=false stops new epics being created (existing ones stay). status_mode=auto moves an epic to in-progress when work starts and completed when all its items are closed (paused/cancelled epics are left alone). |
get_cycle
Hanya baca. Bisa dipakai dengan token baca saja.
Reads a cycle (sprint) with its progress and work items.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
cycle | string | ya | Cycle name or id |
create_cycle
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Creates a cycle (sprint) in a project. Without both dates it stays a draft. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | ya | Project key, id or name |
name | string | ya | minimal 1 karakter |
description | string | tidak | |
start_on | string | tidak | format YYYY-MM-DD |
end_on | string | tidak | format YYYY-MM-DD |
update_cycle
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Changes a cycle. Only the fields given change; pass clear to empty dates. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
cycle | string | ya | Cycle name or id |
name | string | tidak | minimal 1 karakter |
description | string | tidak | |
start_on | string | tidak | format YYYY-MM-DD |
end_on | string | tidak | format YYYY-MM-DD |
clear | array<"start_on" / "end_on"> | tidak |
delete_cycle
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Deletes a cycle; its work items stay but leave the cycle. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
cycle | string | ya | Cycle name or id |
cycle_burndown
Hanya baca. Bisa dipakai dengan token baca saja.
Burndown of a cycle: open work items left per day against the ideal line (null for days ahead).
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
cycle | string | ya | Cycle name or id |
transfer_cycle_items
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Moves the unfinished work items of a completed cycle into another (not completed) cycle. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | ya | Project key, id or name |
from_cycle | string | ya | Completed cycle name or id |
to_cycle | string | ya | Target cycle name or id |
add_work_items_to
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Adds work items to a cycle, module, epic, milestone or release of their project. An item is in at most one cycle, epic, milestone and release (adding moves it); modules can share items. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
kind | "cycle" / "module" / "epic" / "milestone" / "release" | ya | |
target | string | ya | Name or id of the cycle/module/milestone/release; epic title, number or id |
items | array<string> | ya | Work item references like PROJ-12, or ids |
remove_work_items_from
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Takes work items out of a cycle, module, epic, milestone or release. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
kind | "cycle" / "module" / "epic" / "milestone" / "release" | ya | |
target | string | ya | Name or id of the cycle/module/milestone/release; epic title, number or id |
items | array<string> | ya | Work item references like PROJ-12, or ids |
get_module
Hanya baca. Bisa dipakai dengan token baca saja.
Reads a module with its lead, members, links, progress and work items.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
module | string | ya | Module name or id |
create_module
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Creates a module in a project. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | ya | Project key, id or name |
name | string | ya | minimal 1 karakter |
description | string | tidak | |
status | "backlog" / "planned" / "in-progress" / "paused" / "completed" / "cancelled" | tidak | |
lead | string | tidak | Email or name; "me" for yourself |
members | array<string> | tidak | Emails or names; "me" for yourself |
start_on | string | tidak | format YYYY-MM-DD |
target_on | string | tidak | format YYYY-MM-DD |
update_module
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Changes a module. Only the fields given change; members replaces the member list; pass clear to empty lead or dates. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
module | string | ya | Module name or id |
name | string | tidak | minimal 1 karakter |
description | string | tidak | |
status | "backlog" / "planned" / "in-progress" / "paused" / "completed" / "cancelled" | tidak | |
lead | string | tidak | Email or name; "me" for yourself |
members | array<string> | tidak | Emails or names; "me" for yourself |
start_on | string | tidak | format YYYY-MM-DD |
target_on | string | tidak | format YYYY-MM-DD |
clear | array<"lead" / "start_on" / "target_on"> | tidak |
delete_module
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Deletes a module; its work items stay. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
module | string | ya | Module name or id |
add_module_link
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Adds a web link (http/https) to a module. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
module | string | ya | Module name or id |
url | string | ya | minimal 1 karakter |
title | string | tidak |
remove_module_link
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Removes a link from a module, by link id (see get_module) or its exact url. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
module | string | ya | Module name or id |
link | string | ya | Link id or url |
list_epics
Hanya baca. Bisa dipakai dengan token baca saja.
Lists the epics of a project with status, owner and progress.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | ya | Project key, id or name |
get_epic
Hanya baca. Bisa dipakai dengan token baca saja.
Reads an epic with its progress and work items.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
epic | string | ya | Epic title, number (e.g. 3 or #3) or id |
create_epic
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Creates an epic in a project (epics must be enabled for it). Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | ya | Project key, id or name |
title | string | ya | minimal 1 karakter |
description | string | tidak | |
status | "backlog" / "planned" / "in-progress" / "paused" / "completed" / "cancelled" | tidak | |
color | string | tidak | pola ^#[0-9a-fA-F]{6}$ |
owner | string | tidak | Email or name; "me" for yourself |
start_on | string | tidak | format YYYY-MM-DD |
target_on | string | tidak | format YYYY-MM-DD |
update_epic
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Changes an epic. Only the fields given change; pass clear to empty owner or dates. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
epic | string | ya | Epic title, number or id |
title | string | tidak | minimal 1 karakter |
description | string | tidak | |
status | "backlog" / "planned" / "in-progress" / "paused" / "completed" / "cancelled" | tidak | |
color | string | tidak | pola ^#[0-9a-fA-F]{6}$ |
owner | string | tidak | Email or name; "me" for yourself |
start_on | string | tidak | format YYYY-MM-DD |
target_on | string | tidak | format YYYY-MM-DD |
clear | array<"owner" / "start_on" / "target_on"> | tidak |
delete_epic
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Deletes an epic; its work items stay. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
epic | string | ya | Epic title, number or id |
list_releases
Hanya baca. Bisa dipakai dengan token baca saja.
Lists the releases of a project with status, dates and progress.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | ya | Project key, id or name |
get_release
Hanya baca. Bisa dipakai dengan token baca saja.
Reads a release with its progress and work items.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
release | string | ya | Release name, "name version", version or id |
create_release
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Creates a release in a project. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | ya | Project key, id or name |
name | string | ya | minimal 1 karakter |
version | string | tidak | |
description | string | tidak | Plain text; blank lines start new paragraphs |
status | "planned" / "in_progress" / "released" / "cancelled" | tidak | |
start_on | string | tidak | format YYYY-MM-DD |
target_on | string | tidak | format YYYY-MM-DD |
released_on | string | tidak | format YYYY-MM-DD |
lead | string | tidak | Email or name; "me" for yourself (default on create) |
labels | array<string> | tidak | Release label names (see list_release_labels) |
update_release
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Changes a release. Only the fields given change; labels replaces the label list; pass clear to empty lead or dates. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
release | string | ya | Release name, "name version", version or id |
name | string | tidak | minimal 1 karakter |
version | string | tidak | |
description | string | tidak | Plain text; blank lines start new paragraphs |
status | "planned" / "in_progress" / "released" / "cancelled" | tidak | |
start_on | string | tidak | format YYYY-MM-DD |
target_on | string | tidak | format YYYY-MM-DD |
released_on | string | tidak | format YYYY-MM-DD |
lead | string | tidak | Email or name; "me" for yourself (default on create) |
labels | array<string> | tidak | Release label names (see list_release_labels) |
clear | array<"lead" / "start_on" / "target_on" / "released_on"> | tidak |
delete_release
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Deletes a release; its work items stay. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
release | string | ya | Release name, "name version", version or id |
mark_release_released
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Marks a release as released (today unless released_on is given) and notifies its lead and assignees. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
release | string | ya | Release name, "name version", version or id |
released_on | string | tidak | format YYYY-MM-DD |
list_release_labels
Hanya baca. Bisa dipakai dengan token baca saja.
Lists the release labels of a workspace (shared by all its projects).
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
list_milestones
Hanya baca. Bisa dipakai dengan token baca saja.
Lists the milestones of a project with target date, overdue flag and progress.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | ya | Project key, id or name |
create_milestone
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Creates a milestone in a project. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | ya | Project key, id or name |
name | string | ya | minimal 1 karakter |
description | string | tidak | |
target_on | string | tidak | format YYYY-MM-DD |
update_milestone
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Changes a milestone. Only the fields given change; pass clear to empty the target date. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
milestone | string | ya | Milestone name or id |
name | string | tidak | minimal 1 karakter |
description | string | tidak | |
target_on | string | tidak | format YYYY-MM-DD |
clear | array<"target_on"> | tidak |
delete_milestone
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Deletes a milestone; its work items stay. Needs write access.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | tidak | Project key, id or name; needed unless the reference is an id |
milestone | string | ya | Milestone name or id |
get_estimate_system
Hanya baca. Bisa dipakai dengan token baca saja.
Reads a project's estimate system: none, points, time (hours) or categories (sizes like XS..XL), and its values.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | ya | Project key, id or name |
set_estimate_system
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Sets a project's estimate system and optionally its values (default values when switching: points 1,2,3,5,8,13; time 1,2,4,8; categories XS,S,M,L,XL). Switching scheme or turning it off deletes every estimate in the project; replacing values deletes estimates using dropped values (except under time). Destructive changes need confirm=true. Needs project admin.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | ya | Project key, id or name |
scheme | "none" / "points" / "time" / "categories" | ya | |
values | array<string> | tidak | Numbers for points/time, labels (<= 20 chars) for categories |
confirm | boolean | tidak | Must be true when the change deletes estimates |
add_estimate_values
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Adds values to a project's estimate system (numbers for points/time, labels for categories). Existing estimates stay. Needs project admin.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | ya | Project key, id or name |
values | array<string> | ya |
remove_estimate_values
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Removes values from a project's estimate system. Under points or categories, work items estimated with a removed value lose their estimate, so this needs confirm=true. Needs project admin.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | ya | Project key, id or name |
values | array<string> | ya | |
confirm | boolean | tidak | Must be true when estimates would be deleted |
get_epic_settings
Hanya baca. Bisa dipakai dengan token baca saja.
Reads a project's epic settings: whether epics are on, status mode (manual, or auto = follows its work items) and the default status of new epics.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | ya | Project key, id or name |
set_epic_settings
Menulis. Butuh token atau koneksi dengan akses Baca dan tulis.
Changes a project's epic settings. enabled=false stops new epics being created (existing ones stay). status_mode=auto moves an epic to in-progress when work starts and completed when all its items are closed (paused/cancelled epics are left alone). Only the fields given change. Needs project admin.
| Parameter | Tipe | Wajib | Keterangan |
|---|---|---|---|
workspace | string | tidak | Workspace slug or name; needed when the token reaches more than one (see list_workspaces) |
project | string | ya | Project key, id or name |
enabled | boolean | tidak | |
status_mode | "manual" / "auto" | tidak | |
default_status | "backlog" / "planned" / "in-progress" / "paused" / "completed" / "cancelled" | tidak | Status of new epics |