Module project_components_api 

Structs

CreateComponentParams

struct for passing parameters to the method create_component

DeleteComponentParams

struct for passing parameters to the method delete_component

GetComponentParams

struct for passing parameters to the method get_component

GetComponentRelatedIssuesParams

struct for passing parameters to the method get_component_related_issues

GetProjectComponentsPaginatedParams

struct for passing parameters to the method get_project_components_paginated

GetProjectComponentsParams

struct for passing parameters to the method get_project_components

UpdateComponentParams

struct for passing parameters to the method update_component

Enums

CreateComponentError

struct for typed errors of method create_component

DeleteComponentError

struct for typed errors of method delete_component

GetComponentError

struct for typed errors of method get_component

GetComponentRelatedIssuesError

struct for typed errors of method get_component_related_issues

GetProjectComponentsError

struct for typed errors of method get_project_components

GetProjectComponentsPaginatedError

struct for typed errors of method get_project_components_paginated

UpdateComponentError

struct for typed errors of method update_component

Functions

create_component

Creates a component. 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.

delete_component

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.

get_component

Returns a component. This operation can be accessed anonymously. Permissions required: Browse projects project permission for project containing the component.

get_component_related_issues

Returns the counts of issues assigned to the component. This operation can be accessed anonymously. Permissions required: None.

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. This operation can be accessed anonymously. Permissions required: Browse Projects project permission for the project.

get_project_components_paginated

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. This operation can be accessed anonymously. Permissions required: Browse Projects project permission for the project.

update_component

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.