Module projects_api

Source

Enums§

ArchiveProjectError
struct for typed errors of method archive_project
CreateProjectError
struct for typed errors of method create_project
DeleteProjectAsynchronouslyError
struct for typed errors of method delete_project_asynchronously
DeleteProjectError
struct for typed errors of method delete_project
GetAllProjectsError
struct for typed errors of method get_all_projects
GetAllStatusesError
struct for typed errors of method get_all_statuses
GetHierarchyError
struct for typed errors of method get_hierarchy
GetNotificationSchemeForProjectError
struct for typed errors of method get_notification_scheme_for_project
GetProjectError
struct for typed errors of method get_project
RestoreError
struct for typed errors of method restore
SearchProjectsError
struct for typed errors of method search_projects
UpdateProjectError
struct for typed errors of method update_project
UpdateProjectTypeError
struct for typed errors of method update_project_type

Functions§

archive_project
Archives a project. Archived projects cannot be deleted. To delete an archived project, restore the project and then delete it. To restore a project, use the Jira UI. Permissions required: Administer Jira global permission.
create_project
Creates a project based on a project type template, as shown in the following table: | Project Type Key | Project Template Key | |–|–| | business | com.atlassian.jira-core-project-templates:jira-core-simplified-content-management, com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval, com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking, com.atlassian.jira-core-project-templates:jira-core-simplified-process-control, com.atlassian.jira-core-project-templates:jira-core-simplified-procurement, com.atlassian.jira-core-project-templates:jira-core-simplified-project-management, com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment, com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking | | service_desk | com.atlassian.servicedesk:simplified-it-service-desk, com.atlassian.servicedesk:simplified-internal-service-desk, com.atlassian.servicedesk:simplified-external-service-desk | | software | com.pyxis.greenhopper.jira:gh-simplified-agility-kanban, com.pyxis.greenhopper.jira:gh-simplified-agility-scrum, com.pyxis.greenhopper.jira:gh-simplified-basic, com.pyxis.greenhopper.jira:gh-simplified-kanban-classic, com.pyxis.greenhopper.jira:gh-simplified-scrum-classic | The project types are available according to the installed Jira features as follows: * Jira Core, the default, enables business projects. * Jira Service Management enables service_desk projects. * Jira Software enables software projects. To determine which features are installed, go to Jira settings > Apps > Manage apps and review the System Apps list. To add Jira Software or Jira Service Management into a JIRA instance, use Jira settings > Apps > Finding new apps. For more information, see Managing add-ons. Permissions required: Administer Jira global permission.
delete_project
Deletes a project. Permissions required: Administer Jira global permission.
delete_project_asynchronously
Deletes a project asynchronously. This operation is: * transactional, that is, if part of the delete fails the project is not deleted. * asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates. Permissions required: Administer Jira global permission.
get_all_projects
Returns all projects visible to the user. Deprecated, use Get projects paginated that supports search and pagination. This operation can be accessed anonymously. Permissions required: Projects are returned only where the user has Browse Projects or Administer projects project permission for the project.
get_all_statuses
Returns the valid statuses for a project. The statuses are grouped by issue type, as each project has a set of valid issue types and each issue type has a set of valid statuses. This operation can be accessed anonymously. Permissions required: Browse Projects project permission for the project.
get_hierarchy
Get the issue type hierarchy for a next-gen project. The issue type hierarchy for a project consists of: * Epic at level 1 (optional). * One or more issue types at level 0 such as Story, Task, or Bug. Where the issue type Epic is defined, these issue types are used to break down the content of an epic. * Subtask at level -1 (optional). This issue type enables level 0 issue types to be broken down into components. Issues based on a level -1 issue type must have a parent issue. Permissions required: Browse projects project permission for the project.
get_notification_scheme_for_project
Gets a notification scheme associated with the project. See the Get notification scheme resource for more information about notification schemes. Permissions required: Administer Jira global permission or Administer Projects project permission.
get_project
Returns the project details for a project. This operation can be accessed anonymously. Permissions required: Browse projects project permission for the project.
restore
Restores a project from the Jira recycle bin. Permissions required: Administer Jira global permission.
search_projects
Returns a paginated list of projects visible to the user. This operation can be accessed anonymously. Permissions required: Projects are returned only where the user has one of: * Browse Projects project permission for the project. * Administer Projects project permission for the project. * Administer Jira global permission.
update_project
Updates the project details of a project. All parameters are optional in the body of the request. Permissions required: Administer Jira global permission.
update_project_type
Deprecated, this feature is no longer supported and no alternatives are available, see Convert project to a different template or type. Updates a project type. The project type can be updated for classic projects only, project type cannot be updated for next-gen projects. Permissions required: Administer Jira global permission.