Atlassian: Plans schemas
21 Atlassian schemas with complete fields and constraints.
← Plans operations · All schemas
Create plan — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
crossProjectReleases | array | Optional | The cross-project releases to include in the plan. Unique items: true |
crossProjectReleases[] | Model | Each item | Expand Create plan — request body — body cross Project Releases item |
customFields | array | Optional | The custom fields for the plan. Unique items: true |
customFields[] | Model | Each item | Expand Create plan — request body — body custom Fields item |
exclusionRules | Model | Optional | Expand Create plan — request body — body exclusion Rules The exclusion rules for the plan. |
issueSources | array | Required within parent | The issue sources to include in the plan. Unique items: true |
issueSources[] | Model | Each item | Expand Create plan — request body — body issue Sources item |
leadAccountId | string | Optional | The account ID of the plan lead. |
name | string | Required within parent | The plan name. Maximum length: 255 Minimum length: 1 |
permissions | array | Optional | The permissions for the plan. Unique items: true |
permissions[] | Model | Each item | Expand Create plan — request body — body permissions item |
scheduling | Model | Required within parent | Expand Create plan — request body — body scheduling The scheduling settings for the plan. |
Referenced models: Create plan — request body — body cross Project Releases item, Create plan — request body — body custom Fields item, Create plan — request body — body exclusion Rules, Create plan — request body — body issue Sources item, Create plan — request body — body permissions item, Create plan — request body — body scheduling
Create plan — request body — body cross Project Releases item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
name | string | Required within parent | The cross-project release name. |
releaseIds | array | Optional | The IDs of the releases to include in the cross-project release. Unique items: true |
releaseIds[] | integer | Each item | Format: int64 |
Create plan — request body — body custom Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
customFieldId | integer | Required within parent | The custom field ID. Format: int64 |
filter | boolean | Optional | Allows filtering issues based on their values for the custom field. |
Create plan — request body — body exclusion Rules
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
issueIds | array | Optional | The IDs of the issues to exclude from the plan. Unique items: true |
issueIds[] | integer | Each item | Format: int64 |
issueTypeIds | array | Optional | The IDs of the issue types to exclude from the plan. Unique items: true |
issueTypeIds[] | integer | Each item | Format: int64 |
numberOfDaysToShowCompletedIssues | integer | Optional | Issues completed this number of days ago will be excluded from the plan. Format: int32 |
releaseIds | array | Optional | The IDs of the releases to exclude from the plan. Unique items: true |
releaseIds[] | integer | Each item | Format: int64 |
workStatusCategoryIds | array | Optional | The IDs of the work status categories to exclude from the plan. Unique items: true |
workStatusCategoryIds[] | integer | Each item | Format: int64 |
workStatusIds | array | Optional | The IDs of the work statuses to exclude from the plan. Unique items: true |
workStatusIds[] | integer | Each item | Format: int64 |
Create plan — request body — body issue Sources item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
type | string | Required within parent | The issue source type. This must be "Board", "Project" or "Filter". One of: Board, Project, Filter |
value | integer | Required within parent | The issue source value. This must be a board ID if the type is "Board", a project ID if the type is "Project" or a filter ID if the type is "Filter". Format: int64 |
Create plan — request body — body permissions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
holder | Model | Required within parent | Expand Create plan — request body — body permissions item holder The permission holder. |
type | string | Required within parent | The permission type. This must be "View" or "Edit". One of: View, Edit |
Referenced models: Create plan — request body — body permissions item holder
Create plan — request body — body permissions item holder
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
type | string | Required within parent | The permission holder type. This must be "Group" or "AccountId". One of: Group, AccountId |
value | string | Required within parent | The permission holder value. This must be a group name if the type is "Group" or an account ID if the type is "AccountId". |
Create plan — request body — body scheduling
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
dependencies | string | Optional | The dependencies for the plan. This must be "Sequential" or "Concurrent". One of: Sequential, Concurrent |
endDate | Model | Optional | Expand Create plan — request body — body scheduling end Date The end date field for the plan. |
estimation | string | Required within parent | The estimation unit for the plan. This must be "StoryPoints", "Days" or "Hours". One of: StoryPoints, Days, Hours |
inferredDates | string | Optional | The inferred dates for the plan. This must be "None", "SprintDates" or "ReleaseDates". One of: None, SprintDates, ReleaseDates |
startDate | Model | Optional | Expand Create plan — request body — body scheduling end Date The start date field for the plan. |
Referenced models: Create plan — request body — body scheduling end Date
Create plan — request body — body scheduling end Date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
dateCustomFieldId | integer | Optional | A date custom field ID. This is required if the type is "DateCustomField". Format: int64 |
type | string | Required within parent | The date field type. This must be "DueDate", "TargetStartDate", "TargetEndDate" or "DateCustomField". One of: DueDate, TargetStartDate, TargetEndDate, DateCustomField |
Duplicate plan — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
name | string | Required within parent | The plan name. |
Get plan — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
crossProjectReleases | JSON | Optional | |
crossProjectReleases (anyOf 1) | array | Alternative | The cross-project releases included in the plan. |
crossProjectReleases (anyOf 1)[] | Model | Each item | Expand Get plan — response body — cross Project Releases The cross-project releases included in the plan item |
crossProjectReleases (anyOf 2) | null | Alternative | |
customFields | JSON | Optional | |
customFields (anyOf 1) | array | Alternative | The custom fields for the plan. |
customFields (anyOf 1)[] | Model | Each item | Expand Get plan — response body — custom Fields The custom fields for the plan item |
customFields (anyOf 2) | null | Alternative | |
exclusionRules | JSON | Optional | |
exclusionRules (anyOf 1) | Model | Alternative | Expand Get plan — response body — exclusion Rules issue Ids, issue Type Ids, number Of Days To Show Completed Issues, release Ids, work Status Category Ids, work Status Ids The exclusion rules for the plan. |
exclusionRules (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The plan ID. Format: int64 |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
issueSources | JSON | Optional | |
issueSources (anyOf 1) | array | Alternative | The issue sources included in the plan. |
issueSources (anyOf 1)[] | Model | Each item | Expand Get plan — response body — issue Sources The issue sources included in the plan item |
issueSources (anyOf 2) | null | Alternative | |
lastSaved | JSON | Optional | |
lastSaved (anyOf 1) | string | Alternative | The date when the plan was last saved in UTC. |
lastSaved (anyOf 2) | null | Alternative | |
leadAccountId | JSON | Optional | |
leadAccountId (anyOf 1) | string | Alternative | The account ID of the plan lead. |
leadAccountId (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The plan name. |
name (anyOf 2) | null | Alternative | |
permissions | JSON | Optional | |
permissions (anyOf 1) | array | Alternative | The permissions for the plan. |
permissions (anyOf 1)[] | Model | Each item | Expand Get plan — response body — permissions The permissions for the plan item |
permissions (anyOf 2) | null | Alternative | |
scheduling | JSON | Optional | |
scheduling (anyOf 1) | Model | Alternative | Expand Get plan — response body — scheduling dependencies, end Date, estimation, inferred Dates, start Date The scheduling settings for the plan. |
scheduling (anyOf 2) | null | Alternative | |
status | JSON | Optional | |
status (anyOf 1) | string | Alternative | The plan status. This is "Active", "Trashed" or "Archived". Known values: Active, Trashed, Archived |
status (anyOf 2) | null | Alternative |
Referenced models: Get plan — response body — cross Project Releases The cross-project releases included in the plan item, Get plan — response body — custom Fields The custom fields for the plan item, Get plan — response body — exclusion Rules issue Ids, issue Type Ids, number Of Days To Show Completed Issues, release Ids, work Status Category Ids, work Status Ids, Get plan — response body — issue Sources The issue sources included in the plan item, Get plan — response body — permissions The permissions for the plan item, Get plan — response body — scheduling dependencies, end Date, estimation, inferred Dates, start Date
Get plan — response body — cross Project Releases The cross-project releases included in the plan item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The cross-project release name. |
name (anyOf 2) | null | Alternative | |
releaseIds | JSON | Optional | |
releaseIds (anyOf 1) | array | Alternative | The IDs of the releases included in the cross-project release. Unique items: true |
releaseIds (anyOf 1)[] | JSON | Each item | |
releaseIds (anyOf 1)[] (anyOf 1) | integer | Alternative | Format: int64 |
releaseIds (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
releaseIds (anyOf 2) | null | Alternative |
Get plan — response body — custom Fields The custom fields for the plan item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
customFieldId | JSON | Optional | |
customFieldId (anyOf 1) | JSON | Alternative | |
customFieldId (anyOf 1) (anyOf 1) | integer | Alternative | The custom field ID. Format: int64 |
customFieldId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
customFieldId (anyOf 2) | null | Alternative | |
filter | JSON | Optional | |
filter (anyOf 1) | boolean | Alternative | Allows filtering issues based on their values for the custom field. |
filter (anyOf 2) | null | Alternative |
Get plan — response body — exclusion Rules issue Ids, issue Type Ids, number Of Days To Show Completed Issues, release Ids, work Status Category Ids, work Status Ids
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
issueIds | JSON | Optional | |
issueIds (anyOf 1) | array | Alternative | The IDs of the issues excluded from the plan. Unique items: true |
issueIds (anyOf 1)[] | JSON | Each item | |
issueIds (anyOf 1)[] (anyOf 1) | integer | Alternative | Format: int64 |
issueIds (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
issueIds (anyOf 2) | null | Alternative | |
issueTypeIds | JSON | Optional | |
issueTypeIds (anyOf 1) | array | Alternative | The IDs of the issue types excluded from the plan. Unique items: true |
issueTypeIds (anyOf 1)[] | JSON | Each item | |
issueTypeIds (anyOf 1)[] (anyOf 1) | integer | Alternative | Format: int64 |
issueTypeIds (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
issueTypeIds (anyOf 2) | null | Alternative | |
numberOfDaysToShowCompletedIssues | JSON | Optional | |
numberOfDaysToShowCompletedIssues (anyOf 1) | JSON | Alternative | |
numberOfDaysToShowCompletedIssues (anyOf 1) (anyOf 1) | integer | Alternative | Issues completed this number of days ago are excluded from the plan. Format: int32 |
numberOfDaysToShowCompletedIssues (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
numberOfDaysToShowCompletedIssues (anyOf 2) | null | Alternative | |
releaseIds | JSON | Optional | |
releaseIds (anyOf 1) | array | Alternative | The IDs of the releases excluded from the plan. Unique items: true |
releaseIds (anyOf 1)[] | JSON | Each item | |
releaseIds (anyOf 1)[] (anyOf 1) | integer | Alternative | Format: int64 |
releaseIds (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
releaseIds (anyOf 2) | null | Alternative | |
workStatusCategoryIds | JSON | Optional | |
workStatusCategoryIds (anyOf 1) | array | Alternative | The IDs of the work status categories excluded from the plan. Unique items: true |
workStatusCategoryIds (anyOf 1)[] | JSON | Each item | |
workStatusCategoryIds (anyOf 1)[] (anyOf 1) | integer | Alternative | Format: int64 |
workStatusCategoryIds (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
workStatusCategoryIds (anyOf 2) | null | Alternative | |
workStatusIds | JSON | Optional | |
workStatusIds (anyOf 1) | array | Alternative | The IDs of the work statuses excluded from the plan. Unique items: true |
workStatusIds (anyOf 1)[] | JSON | Each item | |
workStatusIds (anyOf 1)[] (anyOf 1) | integer | Alternative | Format: int64 |
workStatusIds (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
workStatusIds (anyOf 2) | null | Alternative |
Get plan — response body — issue Sources The issue sources included in the plan item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The issue source type. This is "Board", "Project" or "Filter". Known values: Board, Project, Filter, Custom |
type (anyOf 2) | null | Alternative | |
value | JSON | Optional | |
value (anyOf 1) | JSON | Alternative | |
value (anyOf 1) (anyOf 1) | integer | Alternative | The issue source value. This is a board ID if the type is "Board", a project ID if the type is "Project" or a filter ID if the type is "Filter". Format: int64 |
value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
value (anyOf 2) | null | Alternative |
Get plan — response body — permissions The permissions for the plan item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
holder | JSON | Optional | |
holder (anyOf 1) | Model | Alternative | Expand Get plan — response body — permissions The permissions for the plan item holder type, value The permission holder. |
holder (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The permission type. This is "View" or "Edit". Known values: View, Edit |
type (anyOf 2) | null | Alternative |
Referenced models: Get plan — response body — permissions The permissions for the plan item holder type, value
Get plan — response body — permissions The permissions for the plan item holder type, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The permission holder type. This is "Group" or "AccountId". Known values: Group, AccountId |
type (anyOf 2) | null | Alternative | |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | The permission holder value. This is a group name if the type is "Group" or an account ID if the type is "AccountId". |
value (anyOf 2) | null | Alternative |
Get plan — response body — scheduling dependencies, end Date, estimation, inferred Dates, start Date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dependencies | JSON | Optional | |
dependencies (anyOf 1) | string | Alternative | The dependencies for the plan. This is "Sequential" or "Concurrent". Known values: Sequential, Concurrent |
dependencies (anyOf 2) | null | Alternative | |
endDate | JSON | Optional | |
endDate (anyOf 1) | Model | Alternative | Expand Get plan — response body — scheduling dependencies, end Date, estimation, inferred Dates, start Date end Date date Custom Field Id, type The end date field for the plan. |
endDate (anyOf 2) | null | Alternative | |
estimation | JSON | Optional | |
estimation (anyOf 1) | string | Alternative | The estimation unit for the plan. This is "StoryPoints", "Days" or "Hours". Known values: StoryPoints, Days, Hours |
estimation (anyOf 2) | null | Alternative | |
inferredDates | JSON | Optional | |
inferredDates (anyOf 1) | string | Alternative | The inferred dates for the plan. This is "None", "SprintDates" or "ReleaseDates". Known values: None, SprintDates, ReleaseDates |
inferredDates (anyOf 2) | null | Alternative | |
startDate | JSON | Optional | |
startDate (anyOf 1) | Model | Alternative | Expand Get plan — response body — scheduling dependencies, end Date, estimation, inferred Dates, start Date end Date date Custom Field Id, type The start date field for the plan. |
startDate (anyOf 2) | null | Alternative |
Referenced models: Get plan — response body — scheduling dependencies, end Date, estimation, inferred Dates, start Date end Date date Custom Field Id, type
Get plan — response body — scheduling dependencies, end Date, estimation, inferred Dates, start Date end Date date Custom Field Id, type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dateCustomFieldId | JSON | Optional | |
dateCustomFieldId (anyOf 1) | JSON | Alternative | |
dateCustomFieldId (anyOf 1) (anyOf 1) | integer | Alternative | A date custom field ID. This is returned if the type is "DateCustomField". Format: int64 |
dateCustomFieldId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
dateCustomFieldId (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The date field type. This is "DueDate", "TargetStartDate", "TargetEndDate" or "DateCustomField". Known values: DueDate, TargetStartDate, TargetEndDate, DateCustomField |
type (anyOf 2) | null | Alternative |
Get plans paginated — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cursor | JSON | Optional | |
cursor (anyOf 1) | string | Alternative | |
cursor (anyOf 2) | null | Alternative | |
last | JSON | Optional | |
last (anyOf 1) | boolean | Alternative | |
last (anyOf 2) | null | Alternative | |
nextPageCursor | JSON | Optional | |
nextPageCursor (anyOf 1) | string | Alternative | |
nextPageCursor (anyOf 2) | null | Alternative | |
size | JSON | Optional | |
size (anyOf 1) | JSON | Alternative | |
size (anyOf 1) (anyOf 1) | integer | Alternative | Format: int32 |
size (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
size (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | |
values (anyOf 1)[] | Model | Each item | Expand Get plans paginated — response body — values array item |
values (anyOf 2) | null | Alternative |
Referenced models: Get plans paginated — response body — values array item
Get plans paginated — response body — values array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The plan ID. |
id (anyOf 2) | null | Alternative | |
issueSources | JSON | Optional | |
issueSources (anyOf 1) | array | Alternative | The issue sources included in the plan. Unique items: true |
issueSources (anyOf 1)[] | Model | Each item | Expand Get plan — response body — issue Sources The issue sources included in the plan item |
issueSources (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The plan name. |
name (anyOf 2) | null | Alternative | |
scenarioId | JSON | Optional | |
scenarioId (anyOf 1) | string | Alternative | Default scenario ID. |
scenarioId (anyOf 2) | null | Alternative | |
status | JSON | Optional | |
status (anyOf 1) | string | Alternative | The plan status. This is "Active", "Trashed" or "Archived". Known values: Active, Trashed, Archived |
status (anyOf 2) | null | Alternative |
Referenced models: Get plan — response body — issue Sources The issue sources included in the plan item