Atlassian: Project components schemas
7 Atlassian schemas with complete fields and constraints.
← Project components operations · All schemas
Create component — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a project component. Additional keys: not allowed |
ari | string | Optional | Compass component's ID. Can't be updated. Not required for creating a Project Component. Read only: true |
assignee | Model | Optional | Expand Assign issue — request body — body The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component. Read only: true |
assigneeType | string | Optional | The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values: * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in. * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component. * `UNASSIGNED` an assignee is not set for issues created with this component. * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in. Default value: `PROJECT_DEFAULT`. Optional when creating or updating a component. One of: PROJECT_DEFAULT, COMPONENT_LEAD, PROJECT_LEAD, UNASSIGNED |
description | string | Optional | The description for the component. Optional when creating or updating a component. |
id | string | Optional | The unique identifier for the component. Read only: true |
isAssigneeTypeValid | boolean | Optional | Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned. Read only: true |
lead | Model | Optional | Expand Assign issue — request body — body The user details for the component's lead user. Read only: true |
leadAccountId | string | Optional | The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Maximum length: 128 write Only: true |
leadUserName | string | Optional | This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. |
metadata | object | Optional | Compass component's metadata. Can't be updated. Not required for creating a Project Component. Read only: true Additional keys: see wildcard field |
metadata.* | string | Additional keys | Read only: true |
name | string | Optional | The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters. |
project | string | Optional | The key of the project the component is assigned to. Required when creating a component. Can't be updated. |
projectId | integer | Optional | The ID of the project the component is assigned to. Format: int64 Read only: true |
realAssignee | Model | Optional | Expand Assign issue — request body — body The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee. Read only: true |
realAssigneeType | string | Optional | The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values: * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in. * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in. * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues. * `PROJECT_DEFAULT` when none of the preceding cases are true. One of: PROJECT_DEFAULT, COMPONENT_LEAD, PROJECT_LEAD, UNASSIGNED Read only: true |
self | string | Optional | The URL of the component. Format: uri Read only: true |
Referenced models: Assign issue — request body — body
Find components for projects — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
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 | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Find components for projects — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Find components for projects — response body — values The list of items item
Find components for projects — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
ari | JSON | Optional | |
ari (anyOf 1) | string | Alternative | |
ari (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | |
id (anyOf 2) | null | Alternative | |
metadata | JSON | Optional | |
metadata (anyOf 1) | object | Alternative | Additional keys: see wildcard field |
metadata (anyOf 1).* | string | Additional keys | |
metadata (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | |
self (anyOf 2) | null | Alternative |
Get component issues count — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Count of issues assigned to a component. |
issueCount | JSON | Optional | |
issueCount (anyOf 1) | JSON | Alternative | |
issueCount (anyOf 1) (anyOf 1) | integer | Alternative | The count of issues assigned to a component. Format: int64 Read only: true |
issueCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
issueCount (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL for this count of issues for a component. Format: uri Read only: true |
self (anyOf 2) | null | Alternative |
Get component — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a project component. |
ari | JSON | Optional | |
ari (anyOf 1) | string | Alternative | Compass component's ID. Can't be updated. Not required for creating a Project Component. Read only: true |
ari (anyOf 2) | null | Alternative | |
assignee | JSON | Optional | |
assignee (anyOf 1) | Model | Alternative | Expand Get user — response body The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component. Read only: true |
assignee (anyOf 2) | null | Alternative | |
assigneeType | JSON | Optional | |
assigneeType (anyOf 1) | string | Alternative | The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values: * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in. * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component. * `UNASSIGNED` an assignee is not set for issues created with this component. * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in. Default value: `PROJECT_DEFAULT`. Optional when creating or updating a component. Known values: PROJECT_DEFAULT, COMPONENT_LEAD, PROJECT_LEAD, UNASSIGNED |
assigneeType (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description for the component. Optional when creating or updating a component. |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The unique identifier for the component. Read only: true |
id (anyOf 2) | null | Alternative | |
isAssigneeTypeValid | JSON | Optional | |
isAssigneeTypeValid (anyOf 1) | boolean | Alternative | Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned. Read only: true |
isAssigneeTypeValid (anyOf 2) | null | Alternative | |
lead | JSON | Optional | |
lead (anyOf 1) | Model | Alternative | Expand Get user — response body The user details for the component's lead user. Read only: true |
lead (anyOf 2) | null | Alternative | |
leadAccountId | JSON | Optional | |
leadAccountId (anyOf 1) | string | Alternative | The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Maximum length: 128 write Only: true |
leadAccountId (anyOf 2) | null | Alternative | |
leadUserName | JSON | Optional | |
leadUserName (anyOf 1) | string | Alternative | This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. |
leadUserName (anyOf 2) | null | Alternative | |
metadata | JSON | Optional | |
metadata (anyOf 1) | object | Alternative | Compass component's metadata. Can't be updated. Not required for creating a Project Component. Read only: true Additional keys: see wildcard field |
metadata (anyOf 1).* | string | Additional keys | Read only: true |
metadata (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters. |
name (anyOf 2) | null | Alternative | |
project | JSON | Optional | |
project (anyOf 1) | string | Alternative | The key of the project the component is assigned to. Required when creating a component. Can't be updated. |
project (anyOf 2) | null | Alternative | |
projectId | JSON | Optional | |
projectId (anyOf 1) | JSON | Alternative | |
projectId (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the project the component is assigned to. Format: int64 Read only: true |
projectId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
projectId (anyOf 2) | null | Alternative | |
realAssignee | JSON | Optional | |
realAssignee (anyOf 1) | Model | Alternative | Expand Get user — response body The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee. Read only: true |
realAssignee (anyOf 2) | null | Alternative | |
realAssigneeType | JSON | Optional | |
realAssigneeType (anyOf 1) | string | Alternative | The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values: * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in. * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in. * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues. * `PROJECT_DEFAULT` when none of the preceding cases are true. Known values: PROJECT_DEFAULT, COMPONENT_LEAD, PROJECT_LEAD, UNASSIGNED Read only: true |
realAssigneeType (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the component. Format: uri Read only: true |
self (anyOf 2) | null | Alternative |
Referenced models: Get user — response body
Get project components paginated — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
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 | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get project components paginated — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get project components paginated — response body — values The list of items item
Get project components paginated — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a component with a count of the issues it contains. |
assignee | JSON | Optional | |
assignee (anyOf 1) | Model | Alternative | Expand Get user — response body The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component. |
assignee (anyOf 2) | null | Alternative | |
assigneeType | JSON | Optional | |
assigneeType (anyOf 1) | string | Alternative | The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Takes the following values: * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in. * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component. * `UNASSIGNED` an assignee is not set for issues created with this component. * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in. Known values: PROJECT_DEFAULT, COMPONENT_LEAD, PROJECT_LEAD, UNASSIGNED Read only: true |
assigneeType (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description for the component. Read only: true |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The unique identifier for the component. Read only: true |
id (anyOf 2) | null | Alternative | |
isAssigneeTypeValid | JSON | Optional | |
isAssigneeTypeValid (anyOf 1) | boolean | Alternative | Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned. Read only: true |
isAssigneeTypeValid (anyOf 2) | null | Alternative | |
issueCount | JSON | Optional | |
issueCount (anyOf 1) | JSON | Alternative | |
issueCount (anyOf 1) (anyOf 1) | integer | Alternative | Count of issues for the component. Format: int64 Read only: true |
issueCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
issueCount (anyOf 2) | null | Alternative | |
lead | JSON | Optional | |
lead (anyOf 1) | Model | Alternative | Expand Get user — response body The user details for the component's lead user. |
lead (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name for the component. Read only: true |
name (anyOf 2) | null | Alternative | |
project | JSON | Optional | |
project (anyOf 1) | string | Alternative | The key of the project to which the component is assigned. Read only: true |
project (anyOf 2) | null | Alternative | |
projectId | JSON | Optional | |
projectId (anyOf 1) | JSON | Alternative | |
projectId (anyOf 1) (anyOf 1) | integer | Alternative | Not used. Format: int64 Read only: true |
projectId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
projectId (anyOf 2) | null | Alternative | |
realAssignee | JSON | Optional | |
realAssignee (anyOf 1) | Model | Alternative | Expand Get user — response body The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee. |
realAssignee (anyOf 2) | null | Alternative | |
realAssigneeType | JSON | Optional | |
realAssigneeType (anyOf 1) | string | Alternative | The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values: * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in. * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in. * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues. * `PROJECT_DEFAULT` when none of the preceding cases are true. Known values: PROJECT_DEFAULT, COMPONENT_LEAD, PROJECT_LEAD, UNASSIGNED Read only: true |
realAssigneeType (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL for this count of the issues contained in the component. Format: uri Read only: true |
self (anyOf 2) | null | Alternative |
Referenced models: Get user — response body