Sign in

v4

OpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Project components

Get project components

Returns all components in a project. See the Get project components paginated resource if you want to get a full list of components with pagination.

If your project uses Compass components, this API will return a paginated list of Compass components that are linked to issues in that project.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

get/rest/api/3/project/{projectIdOrKey}/components

Path parameters

projectIdOrKeystring required

The project ID or project key (case sensitive).

Query parameters

componentSource'jira' | 'compass' | 'auto'

The source of the components to return. Can be jira (default), compass or auto. When auto is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to jira.

Response

Returned if the request is successful.

aristring

Compass component's ID. Can't be updated. Not required for creating a Project Component.

assigneeType'PROJECT_DEFAULT' | 'COMPONENT_LEAD' | 'PROJECT_LEAD' | 'UNASSIGNED'

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.

descriptionstring

The description for the component. Optional when creating or updating a component.

idstring

The unique identifier for the component.

isAssigneeTypeValidboolean

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.

leadAccountIdstring

The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

leadUserNamestring

This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

metadataobject

Compass component's metadata. Can't be updated. Not required for creating a Project Component.

namestring

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.

projectstring

The key of the project the component is assigned to. Required when creating a component. Can't be updated.

projectIdinteger

The ID of the project the component is assigned to.

realAssigneeType'PROJECT_DEFAULT' | 'COMPONENT_LEAD' | 'PROJECT_LEAD' | 'UNASSIGNED'

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 assigneeType 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.
selfstring uri

The URL of the component.