Function: getProjectComponents()
ts
function getProjectComponents(client, parameters): Promise<object[]>;Defined in: src/cloud/api/projectComponents.ts:217
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.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { componentSource?: "auto" | "jira" | string & object | "compass"; projectIdOrKey: string; } | - |
parameters.componentSource? | "auto" | "jira" | string & object | "compass" | 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. |
parameters.projectIdOrKey | string | The project ID or project key (case sensitive). |
Returns
Promise<object[]>