Jira Plans (Advanced Roadmaps) endpoint functions.
Covers plan lifecycle (create, get, update, archive, trash, duplicate) and team membership within a plan (Atlassian teams and plan-only teams).
All functions take a client built with atlassian.jira.client/client as the
first argument.
Jira Plans (Advanced Roadmaps) endpoint functions. Covers plan lifecycle (create, get, update, archive, trash, duplicate) and team membership within a plan (Atlassian teams and plan-only teams). All functions take a client built with `atlassian.jira.client/client` as the first argument.
(add-atlassian-team client plan-id body)Add Atlassian team to plan. POST /rest/api/3/plans/plan/{planId}/team/atlassian Path params: planId — the ID of the plan. Body: AddAtlassianTeamRequest — {:id str :planningStyle "Scrum"|"Kanban" :capacity num :issueSourceId int :sprintLength int}
Add Atlassian team to plan.
POST /rest/api/3/plans/plan/{planId}/team/atlassian
Path params: planId — the ID of the plan.
Body: AddAtlassianTeamRequest — {:id str :planningStyle "Scrum"|"Kanban" :capacity num :issueSourceId int :sprintLength int}(archive-plan client plan-id)Archive plan. PUT /rest/api/3/plans/plan/{planId}/archive Path params: planId — the ID of the plan.
Archive plan.
PUT /rest/api/3/plans/plan/{planId}/archive
Path params: planId — the ID of the plan.(create-plan client body)(create-plan client body opts)Create plan. POST /rest/api/3/plans/plan Body: CreatePlanRequest — {:name str :leadAccountId str :issueSources [...] :scheduling {...} :exclusionRules {...} :crossProjectReleases [...] :customFields [...] :permissions [...]} opts (query params): :useGroupId
Create plan.
POST /rest/api/3/plans/plan
Body: CreatePlanRequest — {:name str :leadAccountId str :issueSources [...] :scheduling {...} :exclusionRules {...} :crossProjectReleases [...] :customFields [...] :permissions [...]}
opts (query params): :useGroupId(create-plan-only-team client plan-id body)Create plan-only team. POST /rest/api/3/plans/plan/{planId}/team/planonly Path params: planId — the ID of the plan. Body: CreatePlanOnlyTeamRequest — {:name str :planningStyle "Scrum"|"Kanban" :memberAccountIds [...] :capacity num :issueSourceId int :sprintLength int}
Create plan-only team.
POST /rest/api/3/plans/plan/{planId}/team/planonly
Path params: planId — the ID of the plan.
Body: CreatePlanOnlyTeamRequest — {:name str :planningStyle "Scrum"|"Kanban" :memberAccountIds [...] :capacity num :issueSourceId int :sprintLength int}(delete-plan-only-team client plan-id plan-only-team-id)Delete plan-only team. DELETE /rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId} Path params: planId — the ID of the plan; planOnlyTeamId — the ID of the plan-only team.
Delete plan-only team.
DELETE /rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}
Path params: planId — the ID of the plan; planOnlyTeamId — the ID of the plan-only team.(duplicate-plan client plan-id body)Duplicate plan. POST /rest/api/3/plans/plan/{planId}/duplicate Path params: planId — the ID of the plan. Body: DuplicatePlanRequest — {:name str} (required)
Duplicate plan.
POST /rest/api/3/plans/plan/{planId}/duplicate
Path params: planId — the ID of the plan.
Body: DuplicatePlanRequest — {:name str} (required)(get-atlassian-team client plan-id atlassian-team-id)Get Atlassian team in plan. GET /rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId} Path params: planId — the ID of the plan; atlassianTeamId — the ID of the Atlassian team.
Get Atlassian team in plan.
GET /rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}
Path params: planId — the ID of the plan; atlassianTeamId — the ID of the Atlassian team.(get-plan client plan-id)(get-plan client plan-id opts)Get plan. GET /rest/api/3/plans/plan/{planId} Path params: planId — the ID of the plan. opts (query params): :useGroupId
Get plan.
GET /rest/api/3/plans/plan/{planId}
Path params: planId — the ID of the plan.
opts (query params): :useGroupId(get-plan-only-team client plan-id plan-only-team-id)Get plan-only team. GET /rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId} Path params: planId — the ID of the plan; planOnlyTeamId — the ID of the plan-only team.
Get plan-only team.
GET /rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}
Path params: planId — the ID of the plan; planOnlyTeamId — the ID of the plan-only team.(get-plans client)(get-plans client opts)Get plans paginated. GET /rest/api/3/plans/plan opts (query params): :includeTrashed, :includeArchived, :cursor, :maxResults
Get plans paginated. GET /rest/api/3/plans/plan opts (query params): :includeTrashed, :includeArchived, :cursor, :maxResults
(get-teams client plan-id)(get-teams client plan-id opts)Get teams in plan paginated. GET /rest/api/3/plans/plan/{planId}/team Path params: planId — the ID of the plan. opts (query params): :cursor, :maxResults
Get teams in plan paginated.
GET /rest/api/3/plans/plan/{planId}/team
Path params: planId — the ID of the plan.
opts (query params): :cursor, :maxResults(remove-atlassian-team client plan-id atlassian-team-id)Remove Atlassian team from plan. DELETE /rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId} Path params: planId — the ID of the plan; atlassianTeamId — the ID of the Atlassian team.
Remove Atlassian team from plan.
DELETE /rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}
Path params: planId — the ID of the plan; atlassianTeamId — the ID of the Atlassian team.(trash-plan client plan-id)Trash plan. PUT /rest/api/3/plans/plan/{planId}/trash Path params: planId — the ID of the plan.
Trash plan.
PUT /rest/api/3/plans/plan/{planId}/trash
Path params: planId — the ID of the plan.(update-atlassian-team client plan-id atlassian-team-id body)Update Atlassian team in plan. PUT /rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId} Path params: planId — the ID of the plan; atlassianTeamId — the ID of the Atlassian team. Body: Atlassian team update fields (same shape as AddAtlassianTeamRequest).
Update Atlassian team in plan.
PUT /rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}
Path params: planId — the ID of the plan; atlassianTeamId — the ID of the Atlassian team.
Body: Atlassian team update fields (same shape as AddAtlassianTeamRequest).(update-plan client plan-id body)(update-plan client plan-id body opts)Update plan. PUT /rest/api/3/plans/plan/{planId} Path params: planId — the ID of the plan. Body: plan update fields (same shape as CreatePlanRequest). opts (query params): :useGroupId
Update plan.
PUT /rest/api/3/plans/plan/{planId}
Path params: planId — the ID of the plan.
Body: plan update fields (same shape as CreatePlanRequest).
opts (query params): :useGroupId(update-plan-only-team client plan-id plan-only-team-id body)Update plan-only team. PUT /rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId} Path params: planId — the ID of the plan; planOnlyTeamId — the ID of the plan-only team. Body: plan-only team update fields (same shape as CreatePlanOnlyTeamRequest).
Update plan-only team.
PUT /rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}
Path params: planId — the ID of the plan; planOnlyTeamId — the ID of the plan-only team.
Body: plan-only team update fields (same shape as CreatePlanOnlyTeamRequest).cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |