Class ProjectComponents

Index

Constructors

Methods

createComponent deleteComponent findComponentsForProjects getComponent getComponentRelatedIssues getProjectComponents getProjectComponentsPaginated updateComponent

Constructors

constructor

new ProjectComponents(client: Client): Version3.ProjectComponents
Parameters
- client: Client
Returns Version3.ProjectComponents
- Defined in src/version3/projectComponents.ts:9

Methods

createComponent

createComponent<T = Version3Models.ProjectComponent>(
parameters: Version3Parameters.CreateComponent,
callback: Callback<T>,
): Promise<void>
Creates a component. Use components to provide containers for issues within a project. Use components to provide containers for issues within a project.

This operation can be accessed anonymously.

Permissions required: Administer projects project permission for the project in which the component is created or Administer Jira global permission.
Type Parameters
- T = Version3Models.ProjectComponent
Parameters
- parameters: Version3Parameters.CreateComponent
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectComponents.ts:66
createComponent<T = Version3Models.ProjectComponent>(
parameters: Version3Parameters.CreateComponent,
callback?: undefined,
): Promise<T>
Creates a component. Use components to provide containers for issues within a project. Use components to provide containers for issues within a project.

This operation can be accessed anonymously.

Permissions required: Administer projects project permission for the project in which the component is created or Administer Jira global permission.
Type Parameters
- T = Version3Models.ProjectComponent
Parameters
- parameters: Version3Parameters.CreateComponent
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectComponents.ts:80

deleteComponent

deleteComponent<T = void>(
parameters: Version3Parameters.DeleteComponent,
callback: Callback<T>,
): Promise<void>
Deletes a component.

This operation can be accessed anonymously.

Permissions required: Administer projects project permission for the project containing the component or Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteComponent
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectComponents.ts:204
deleteComponent<T = void>(
parameters: Version3Parameters.DeleteComponent,
callback?: undefined,
): Promise<T>
Deletes a component.

This operation can be accessed anonymously.

Permissions required: Administer projects project permission for the project containing the component or Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteComponent
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectComponents.ts:214

findComponentsForProjects

findComponentsForProjects<T = Paginated<Version3Models.Component>>(
parameters: Version3Parameters.FindComponentsForProjects,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of all components in a project, including global (Compass) components when applicable.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.
Type Parameters
- T = Paginated<Version3Models.Component>
Parameters
- parameters: Version3Parameters.FindComponentsForProjects
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectComponents.ts:20
findComponentsForProjects<T = Paginated<Version3Models.Component>>(
parameters: Version3Parameters.FindComponentsForProjects,
callback?: undefined,
): Promise<T>
Returns a paginated list of all components in a project, including global (Compass) components when applicable.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.
Type Parameters
- T = Paginated<Version3Models.Component>
Parameters
- parameters: Version3Parameters.FindComponentsForProjects
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectComponents.ts:33

getComponent

getComponent<T = Version3Models.ProjectComponent>(
parameters: Version3Parameters.GetComponent,
callback: Callback<T>,
): Promise<void>
Returns a component.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for project containing the component.
Type Parameters
- T = Version3Models.ProjectComponent
Parameters
- parameters: Version3Parameters.GetComponent
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectComponents.ts:122
getComponent<T = Version3Models.ProjectComponent>(
parameters: Version3Parameters.GetComponent,
callback?: undefined,
): Promise<T>
Returns a component.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for project containing the component.
Type Parameters
- T = Version3Models.ProjectComponent
Parameters
- parameters: Version3Parameters.GetComponent
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectComponents.ts:134

getComponentRelatedIssues

getComponentRelatedIssues<T = Version3Models.ComponentIssuesCount>(
parameters: Version3Parameters.GetComponentRelatedIssues,
callback: Callback<T>,
): Promise<void>
Returns the counts of issues assigned to the component.

This operation can be accessed anonymously.

Deprecation notice: The required OAuth 2.0 scopes will be updated on June 15, 2024.
- Classic: read:jira-work
- Granular: read:field:jira, read:project.component:jira
Permissions required: None.
Type Parameters
- T = Version3Models.ComponentIssuesCount
Parameters
- parameters: Version3Parameters.GetComponentRelatedIssues
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectComponents.ts:239
getComponentRelatedIssues<T = Version3Models.ComponentIssuesCount>(
parameters: Version3Parameters.GetComponentRelatedIssues,
callback?: undefined,
): Promise<T>
Returns the counts of issues assigned to the component.

This operation can be accessed anonymously.

Deprecation notice: The required OAuth 2.0 scopes will be updated on June 15, 2024.
- Classic: read:jira-work
- Granular: read:field:jira, read:project.component:jira
Permissions required: None.
Type Parameters
- T = Version3Models.ComponentIssuesCount
Parameters
- parameters: Version3Parameters.GetComponentRelatedIssues
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectComponents.ts:255

getProjectComponents

getProjectComponents<T = Version3Models.ProjectComponent[]>(
parameters: Version3Parameters.GetProjectComponents,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version3Models.ProjectComponent[]
Parameters
- parameters: Version3Parameters.GetProjectComponents
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectComponents.ts:337
getProjectComponents<T = Version3Models.ProjectComponent[]>(
parameters: Version3Parameters.GetProjectComponents,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version3Models.ProjectComponent[]
Parameters
- parameters: Version3Parameters.GetProjectComponents
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectComponents.ts:354

getProjectComponentsPaginated

getProjectComponentsPaginated<T = Version3Models.PageComponentWithIssueCount>(
parameters: Version3Parameters.GetProjectComponentsPaginated,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of all components in a project. See the Get project components resource if you want to get a full list of versions without pagination.

If your project uses Compass components, this API will return a 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.
Type Parameters
- T = Version3Models.PageComponentWithIssueCount
Parameters
- parameters: Version3Parameters.GetProjectComponentsPaginated
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectComponents.ts:284
getProjectComponentsPaginated<T = Version3Models.PageComponentWithIssueCount>(
parameters: Version3Parameters.GetProjectComponentsPaginated,
callback?: undefined,
): Promise<T>
Returns a paginated list of all components in a project. See the Get project components resource if you want to get a full list of versions without pagination.

If your project uses Compass components, this API will return a 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.
Type Parameters
- T = Version3Models.PageComponentWithIssueCount
Parameters
- parameters: Version3Parameters.GetProjectComponentsPaginated
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectComponents.ts:301

updateComponent

updateComponent<T = Version3Models.ProjectComponent>(
parameters: Version3Parameters.UpdateComponent,
callback: Callback<T>,
): Promise<void>
Updates a component. Any fields included in the request are overwritten. If leadAccountId is an empty string ("") the component lead is removed.

This operation can be accessed anonymously.

Permissions required: Administer projects project permission for the project containing the component or Administer Jira global permission.
Type Parameters
- T = Version3Models.ProjectComponent
Parameters
- parameters: Version3Parameters.UpdateComponent
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectComponents.ts:157
updateComponent<T = Version3Models.ProjectComponent>(
parameters: Version3Parameters.UpdateComponent,
callback?: undefined,
): Promise<T>
Updates a component. Any fields included in the request are overwritten. If leadAccountId is an empty string ("") the component lead is removed.

This operation can be accessed anonymously.

Permissions required: Administer projects project permission for the project containing the component or Administer Jira global permission.
Type Parameters
- T = Version3Models.ProjectComponent
Parameters
- parameters: Version3Parameters.UpdateComponent
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectComponents.ts:171

Class ProjectComponents

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.ProjectComponents

Methods

createComponent

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteComponent

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

findComponentsForProjects

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getComponent

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getComponentRelatedIssues

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getProjectComponents

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getProjectComponentsPaginated

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateComponent

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page