Atlassian: Get project components paginated

Atlassian projectComponents.getProjectComponentsPaginated: arguments, response, policy and SDK examples.

← Project components operations · Get started

Operation atlassian.getprojectcomponentspaginated

Provider route: GET /{cloudId}/rest/api/3/project/{projectIdOrKey}/component. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["projectComponents"]["getProjectComponentsPaginated"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.projectComponents.getProjectComponentsPaginated(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.project_components.get_project_components_paginated(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.cloudId`	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
`path.projectIdOrKey`	string	Required within parent
`query`	object	Optional	Additional keys: not allowed
`query.startAt`	integer	Optional	Default: 0 Format: int64
`query.maxResults`	integer	Optional	Default: 50 Format: int32
`query.orderBy`	string	Optional	One of: description, -description, +description, issueCount, -issueCount, +issueCount, lead, -lead, +lead, name, -name, +name
`query.componentSource`	string	Optional	Default: jira One of: jira, compass, auto
`query.query`	string	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Get project components paginated — response body

Referenced models: Get project components paginated — response body

Schemas

4 more schemas are linked from the tables above, on the schema pages.

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

Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48

Field	Type	Presence	Description and constraints
`$`	object	Root
`16x16`	JSON	Optional
`16x16 (anyOf 1)`	string	Alternative	The URL of the item's 16x16 pixel avatar. Format: uri
`16x16 (anyOf 2)`	null	Alternative
`24x24`	JSON	Optional
`24x24 (anyOf 1)`	string	Alternative	The URL of the item's 24x24 pixel avatar. Format: uri
`24x24 (anyOf 2)`	null	Alternative
`32x32`	JSON	Optional
`32x32 (anyOf 1)`	string	Alternative	The URL of the item's 32x32 pixel avatar. Format: uri
`32x32 (anyOf 2)`	null	Alternative
`48x48`	JSON	Optional
`48x48 (anyOf 1)`	string	Alternative	The URL of the item's 48x48 pixel avatar. Format: uri
`48x48 (anyOf 2)`	null	Alternative

Get user — response body — groups callback, items, max-results, paging Callback, size callback object

Field	Type	Presence	Description and constraints
`$`	object	Root

Get user groups — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about a group.
`groupId`	JSON	Optional
`groupId (anyOf 1)`	JSON	Alternative
`groupId (anyOf 1) (anyOf 1)`	string	Alternative	The ID of the group, which uniquely identifies the group across all Atlassian products. For example, 952d12c3-5b5b-4d04-bb32-44d383afc4b2.
`groupId (anyOf 1) (anyOf 2)`	null	Alternative
`groupId (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of group.
`name (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL for these group details. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.getprojectcomponentspaginated. Catalog operation: getprojectcomponentspaginated. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["read:jira-work"]

Official provider source

Report an issue with this page