Skip to content

Atlassian: Teams in plan schemas

6 Atlassian schemas with complete fields and constraints.

← Teams in plan operations · All schemas

Add Atlassian team to plan — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
capacitynumberOptionalThe capacity for the Atlassian team.
Format: double
idstringRequired within parentThe Atlassian team ID.
issueSourceIdintegerOptionalThe ID of the issue source for the Atlassian team.
Format: int64
planningStylestringRequired within parentThe planning style for the Atlassian team. This must be "Scrum" or "Kanban".
One of: Scrum, Kanban
sprintLengthintegerOptionalThe sprint length for the Atlassian team.
Format: int64

Create plan-only team — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
capacitynumberOptionalThe capacity for the plan-only team.
Format: double
issueSourceIdintegerOptionalThe ID of the issue source for the plan-only team.
Format: int64
memberAccountIdsarrayOptionalThe account IDs of the plan-only team members.
Unique items: true
memberAccountIds[]stringEach item
namestringRequired within parentThe plan-only team name.
Maximum length: 255
Minimum length: 1
planningStylestringRequired within parentThe planning style for the plan-only team. This must be "Scrum" or "Kanban".
One of: Scrum, Kanban
sprintLengthintegerOptionalThe sprint length for the plan-only team.
Format: int64

Get Atlassian team in plan — response body

FieldTypePresenceDescription and constraints
$objectRoot
capacityJSONOptional
capacity (anyOf 1)JSONAlternative
capacity (anyOf 1) (anyOf 1)numberAlternativeThe capacity for the Atlassian team.
Format: double
capacity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
capacity (anyOf 2)nullAlternative
idJSONOptional
id (anyOf 1)stringAlternativeThe Atlassian team ID.
id (anyOf 2)nullAlternative
issueSourceIdJSONOptional
issueSourceId (anyOf 1)JSONAlternative
issueSourceId (anyOf 1) (anyOf 1)integerAlternativeThe ID of the issue source for the Atlassian team.
Format: int64
issueSourceId (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issueSourceId (anyOf 2)nullAlternative
planningStyleJSONOptional
planningStyle (anyOf 1)stringAlternativeThe planning style for the Atlassian team. This is "Scrum" or "Kanban".
Known values: Scrum, Kanban
planningStyle (anyOf 2)nullAlternative
sprintLengthJSONOptional
sprintLength (anyOf 1)JSONAlternative
sprintLength (anyOf 1) (anyOf 1)integerAlternativeThe sprint length for the Atlassian team.
Format: int64
sprintLength (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sprintLength (anyOf 2)nullAlternative

Get plan-only team — response body

FieldTypePresenceDescription and constraints
$objectRoot
capacityJSONOptional
capacity (anyOf 1)JSONAlternative
capacity (anyOf 1) (anyOf 1)numberAlternativeThe capacity for the plan-only team.
Format: double
capacity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
capacity (anyOf 2)nullAlternative
idJSONOptional
id (anyOf 1)JSONAlternative
id (anyOf 1) (anyOf 1)integerAlternativeThe plan-only team ID.
Format: int64
id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id (anyOf 2)nullAlternative
issueSourceIdJSONOptional
issueSourceId (anyOf 1)JSONAlternative
issueSourceId (anyOf 1) (anyOf 1)integerAlternativeThe ID of the issue source for the plan-only team.
Format: int64
issueSourceId (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issueSourceId (anyOf 2)nullAlternative
memberAccountIdsJSONOptional
memberAccountIds (anyOf 1)arrayAlternativeThe account IDs of the plan-only team members.
memberAccountIds (anyOf 1)[]stringEach item
memberAccountIds (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeThe plan-only team name.
name (anyOf 2)nullAlternative
planningStyleJSONOptional
planningStyle (anyOf 1)stringAlternativeThe planning style for the plan-only team. This is "Scrum" or "Kanban".
Known values: Scrum, Kanban
planningStyle (anyOf 2)nullAlternative
sprintLengthJSONOptional
sprintLength (anyOf 1)JSONAlternative
sprintLength (anyOf 1) (anyOf 1)integerAlternativeThe sprint length for the plan-only team.
Format: int64
sprintLength (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sprintLength (anyOf 2)nullAlternative

Get teams in plan paginated — response body

FieldTypePresenceDescription and constraints
$objectRoot
cursorJSONOptional
cursor (anyOf 1)stringAlternative
cursor (anyOf 2)nullAlternative
lastJSONOptional
last (anyOf 1)booleanAlternative
last (anyOf 2)nullAlternative
nextPageCursorJSONOptional
nextPageCursor (anyOf 1)stringAlternative
nextPageCursor (anyOf 2)nullAlternative
sizeJSONOptional
size (anyOf 1)JSONAlternative
size (anyOf 1) (anyOf 1)integerAlternativeFormat: int32
size (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
size (anyOf 2)nullAlternative
totalJSONOptional
total (anyOf 1)JSONAlternative
total (anyOf 1) (anyOf 1)integerAlternativeFormat: int64
total (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)nullAlternative
valuesJSONOptional
values (anyOf 1)arrayAlternative
values (anyOf 1)[]ModelEach itemExpand Get teams in plan paginated — response body — values array item
values (anyOf 2)nullAlternative

Referenced models: Get teams in plan paginated — response body — values array item

Get teams in plan paginated — response body — values array item

FieldTypePresenceDescription and constraints
$objectRoot
idJSONOptional
id (anyOf 1)stringAlternativeThe team ID.
id (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeThe team name. This is returned if the type is "PlanOnly".
name (anyOf 2)nullAlternative
typeJSONOptional
type (anyOf 1)stringAlternativeThe team type. This is "PlanOnly" or "Atlassian".
Known values: PlanOnly, Atlassian
type (anyOf 2)nullAlternative

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.