plans

add-atlassian-team

Add Atlassian team to plan

Adds an existing Atlassian team to a plan and configures their plannning settings.

Permissions required: Administer Jira global permission.

POST /rest/api/3/plans/plan/{planId}/team/atlassian

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--planId`	string	Yes	The ID of the plan.

Example:

bash

jr plans add-atlassian-team --planId <planId>

create

Create plan

Creates a plan.

Permissions required: Administer Jira global permission.

POST /rest/api/3/plans/plan

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--useGroupId`	string	No	Whether to accept group IDs instead of group names. Group names are deprecated.

Example:

bash

jr plans create

create-only-team

Create plan-only team

Creates a plan-only team and configures their planning settings.

Permissions required: Administer Jira global permission.

POST /rest/api/3/plans/plan/{planId}/team/planonly

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--planId`	string	Yes	The ID of the plan.

Example:

bash

jr plans create-only-team --planId <planId>

delete-only-team

Delete plan-only team

Deletes a plan-only team and their planning settings.

Permissions required: Administer Jira global permission.

DELETE /rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}

Flag	Type	Required	Description
`--planId`	string	Yes	The ID of the plan.
`--planOnlyTeamId`	string	Yes	The ID of the plan-only team.

Example:

bash

jr plans delete-only-team --planId <planId> --planOnlyTeamId <planOnlyTeamId>

duplicate

Duplicate plan

Duplicates a plan.

Permissions required: Administer Jira global permission.

POST /rest/api/3/plans/plan/{planId}/duplicate

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--planId`	string	Yes	The ID of the plan.

Example:

bash

jr plans duplicate --planId <planId>

get-atlassian-team

Get Atlassian team in plan

Returns planning settings for an Atlassian team in a plan.

Permissions required: Administer Jira global permission.

GET /rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}

Flag	Type	Required	Description
`--atlassianTeamId`	string	Yes	The ID of the Atlassian team.
`--planId`	string	Yes	The ID of the plan.

Example:

bash

jr plans get-atlassian-team --atlassianTeamId <atlassianTeamId> --planId <planId>

get-only-team

Get plan-only team

Returns planning settings for a plan-only team.

Permissions required: Administer Jira global permission.

GET /rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}

Flag	Type	Required	Description
`--planId`	string	Yes	The ID of the plan.
`--planOnlyTeamId`	string	Yes	The ID of the plan-only team.

Example:

bash

jr plans get-only-team --planId <planId> --planOnlyTeamId <planOnlyTeamId>

get-plan

Get plan

Returns a plan.

Permissions required: Administer Jira global permission.

GET /rest/api/3/plans/plan/{planId}

Flag	Type	Required	Description
`--planId`	string	Yes	The ID of the plan.
`--useGroupId`	string	No	Whether to return group IDs instead of group names. Group names are deprecated.

Example:

bash

jr plans get-plan --planId <planId>

get-plans

Get plans paginated

Returns a paginated list of plans.

Permissions required: Administer Jira global permission.

GET /rest/api/3/plans/plan

Flag	Type	Required	Description
`--cursor`	string	No	The cursor to start from. If not provided, the first page will be returned.
`--includeArchived`	string	No	Whether to include archived plans in the results.
`--includeTrashed`	string	No	Whether to include trashed plans in the results.
`--maxResults`	string	No	The maximum number of plans to return per page. The maximum value is 50. The default value is 50.

Example:

bash

jr plans get-plans

get-teams

Get teams in plan paginated

Returns a paginated list of plan-only and Atlassian teams in a plan.

Permissions required: Administer Jira global permission.

GET /rest/api/3/plans/plan/{planId}/team

Flag	Type	Required	Description
`--cursor`	string	No	The cursor to start from. If not provided, the first page will be returned.
`--maxResults`	string	No	The maximum number of plan teams to return per page. The maximum value is 50. The default value is 50.
`--planId`	string	Yes	The ID of the plan.

Example:

bash

jr plans get-teams --planId <planId>

remove-atlassian-team

Remove Atlassian team from plan

Removes an Atlassian team from a plan and deletes their planning settings.

Permissions required: Administer Jira global permission.

DELETE /rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}

Flag	Type	Required	Description
`--atlassianTeamId`	string	Yes	The ID of the Atlassian team.
`--planId`	string	Yes	The ID of the plan.

Example:

bash

jr plans remove-atlassian-team --atlassianTeamId <atlassianTeamId> --planId <planId>

trash

Trash plan

Moves a plan to trash.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/plans/plan/{planId}/trash

Flag	Type	Required	Description
`--planId`	string	Yes	The ID of the plan.

Example:

bash

jr plans trash --planId <planId>

update

Update plan

Updates any of the following details of a plan using JSON Patch.

name
leadAccountId
scheduling
- estimation with StoryPoints, Days or Hours as possible values
- startDate
  - type with DueDate, TargetStartDate, TargetEndDate or DateCustomField as possible values
  - dateCustomFieldId
- endDate
  - type with DueDate, TargetStartDate, TargetEndDate or DateCustomField as possible values
  - dateCustomFieldId
- inferredDates with None, SprintDates or ReleaseDates as possible values
- dependencies with Sequential or Concurrent as possible values
issueSources
- type with Board, Project or Filter as possible values
- value
exclusionRules
- numberOfDaysToShowCompletedIssues
- issueIds
- workStatusIds
- workStatusCategoryIds
- issueTypeIds
- releaseIds
crossProjectReleases
- name
- releaseIds
customFields
- customFieldId
- filter
permissions
- type with View or Edit as possible values
- holder
  - type with Group or AccountId as possible values
  - value

Permissions required: Administer Jira global permission.

Note that "add" operations do not respect array indexes in target locations. Call the "Get plan" endpoint to find out the order of array elements.

PUT /rest/api/3/plans/plan/{planId}

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--planId`	string	Yes	The ID of the plan.
`--useGroupId`	string	No	Whether to accept group IDs instead of group names. Group names are deprecated.

Example:

bash

jr plans update --planId <planId>

update-atlassian-team

Update Atlassian team in plan

Updates any of the following planning settings of an Atlassian team in a plan using JSON Patch.

planningStyle
issueSourceId
sprintLength
capacity

Permissions required: Administer Jira global permission.

Note that "add" operations do not respect array indexes in target locations. Call the "Get Atlassian team in plan" endpoint to find out the order of array elements.

PUT /rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}

Flag	Type	Required	Description
`--atlassianTeamId`	string	Yes	The ID of the Atlassian team.
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--planId`	string	Yes	The ID of the plan.

Example:

bash

jr plans update-atlassian-team --atlassianTeamId <atlassianTeamId> --planId <planId>

update-only-team

Update plan-only team

Updates any of the following planning settings of a plan-only team using JSON Patch.

name
planningStyle
issueSourceId
sprintLength
capacity
memberAccountIds

Permissions required: Administer Jira global permission.

Note that "add" operations do not respect array indexes in target locations. Call the "Get plan-only team" endpoint to find out the order of array elements.

PUT /rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--planId`	string	Yes	The ID of the plan.
`--planOnlyTeamId`	string	Yes	The ID of the plan-only team.

Example:

bash

jr plans update-only-team --planId <planId> --planOnlyTeamId <planOnlyTeamId>

plans ​

add-atlassian-team ​

archive ​

create ​

create-only-team ​

delete-only-team ​

duplicate ​

get-atlassian-team ​

get-only-team ​

get-plan ​

get-plans ​

get-teams ​

remove-atlassian-team ​

trash ​

update ​

update-atlassian-team ​

update-only-team ​

plans

add-atlassian-team

archive

create

create-only-team

delete-only-team

duplicate

get-atlassian-team

get-only-team

get-plan

get-plans

get-teams

remove-atlassian-team

trash

update

update-atlassian-team

update-only-team