ProjectsApi (Everit - Atlassian Jira Cloud REST Client 3.0.1-202010281413 API)

java.lang.Object
- org.everit.atlassian.restclient.jiracloud.v3.api.ProjectsApi

```
public class ProjectsApi
extends Object
```

Constructor Summary

Constructors
Constructor and Description

ProjectsApi(org.everit.http.restclient.RestClient restClient)

Constructors
Constructor and Description
`ProjectsApi(org.everit.http.restclient.RestClient restClient)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`io.reactivex.Single<Object>`	`archiveProject(String projectIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)` Archive project Archives a project.
`io.reactivex.Single<ProjectIdentifiers>`	`createProject(ProjectInputBean projectInputBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)` 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
`io.reactivex.Completable`	`deleteProject(String projectIdOrKey, Optional<Boolean> enableUndo, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)` Delete project Deletes a project.
`io.reactivex.Completable`	`deleteProjectAsynchronously(String projectIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)` Delete project asynchronously Deletes a project asynchronously.
`io.reactivex.Single<List<Project>>`	`getAllProjects(Optional<String> expand, Optional<Integer> recent, Optional<List<String>> properties, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)` Deprecated.
`io.reactivex.Single<List<IssueTypeWithStatus>>`	`getAllStatuses(String projectIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)` Get all statuses for project Returns the valid statuses for a project.
`io.reactivex.Single<ProjectIssueTypeHierarchy>`	`getHierarchy(Long projectId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)` Get project issue type hierarchy Get the issue type hierarchy for a next-gen project.
`io.reactivex.Single<NotificationScheme>`	`getNotificationSchemeForProject(String projectKeyOrId, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)` Get project notification scheme Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project.
`io.reactivex.Single<Project>`	`getProject(String projectIdOrKey, Optional<String> expand, Optional<List<String>> properties, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)` Get project Returns the [project details](https://confluence.atlassian.com/x/ahLpNw) for a project.
`io.reactivex.Single<Project>`	`restore(String projectIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)` Restore deleted project Restores a project from the Jira recycle bin.
`io.reactivex.Single<PageBeanProject>`	`searchProjects(Optional<Long> startAt, Optional<Integer> maxResults, Optional<String> orderBy, Optional<String> query, Optional<String> typeKey, Optional<Long> categoryId, Optional<String> searchBy, Optional<String> action, Optional<String> expand, Optional<List<String>> status, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)` Get projects paginated Returns a [paginated](#pagination) list of projects visible to the user.
`io.reactivex.Single<Project>`	`updateProject(String projectIdOrKey, ProjectInputBean projectInputBean, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)` Update project Updates the [project details](https://confluence.atlassian.com/x/ahLpNw) of a project.
`io.reactivex.Single<Project>`	`updateProjectType(String projectIdOrKey, String newProjectTypeKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProjectsApi
```
public ProjectsApi(org.everit.http.restclient.RestClient restClient)
```
- Method Detail
  - archiveProject
```
public io.reactivex.Single<Object> archiveProject(String projectIdOrKey,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
```
    Archive project Archives a project. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
    
    Parameters:
    
    projectIdOrKey - The project ID or project key (case sensitive). (required)
    
    restRequestEnhancer -
    Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
    
    Returns:
    
    Single<Object>
  - createProject
```
public io.reactivex.Single<ProjectIdentifiers> createProject(ProjectInputBean projectInputBean,
                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
```
    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 Desk 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 Desk into a JIRA instance, use **Jira settings** > **Apps** > **Finding new apps**. For more information, see [ Managing add-ons](https://confluence.atlassian.com/x/S31NLg). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
    
    Parameters:
    
    projectInputBean - The JSON representation of the project being created. (required)
    
    restRequestEnhancer -
    Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
    
    Returns:
    
    Single<ProjectIdentifiers>
  - deleteProject
```
public io.reactivex.Completable deleteProject(String projectIdOrKey,
                                              Optional<Boolean> enableUndo,
                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
```
    Delete project Deletes a project. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
    
    Parameters:
    
    projectIdOrKey - The project ID or project key (case sensitive). (required)
    
    enableUndo - EXPERIMENTAL. Whether this project is placed in the Jira recycle bin where it will be available for restoration. (optional, default to false)
    
    restRequestEnhancer -
    Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
    
    Returns:
    
    Completable
  - deleteProjectAsynchronously
```
public io.reactivex.Completable deleteProjectAsynchronously(String projectIdOrKey,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
```
    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](#async). Follow the `location` link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
    
    Parameters:
    
    projectIdOrKey - The project ID or project key (case sensitive). (required)
    
    restRequestEnhancer -
    Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
    
    Returns:
    
    Completable
  - getAllProjects
```
@Deprecated
public io.reactivex.Single<List<Project>> getAllProjects(Optional<String> expand,
                                                                      Optional<Integer> recent,
                                                                      Optional<List<String>> properties,
                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
```
    Deprecated.
    
    Get all projects Returns all projects visible to the user. Deprecated, use [ Get projects paginated](#api-rest-api-3-project-search-get) that supports search and pagination. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Projects are returned only where the user has *Browse Projects* or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
    
    Parameters:
    
    expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: * `description` Returns the project description. * `issueTypes` Returns all issue types associated with the project. * `lead` Returns information about the project lead. * `projectKeys` Returns all project keys associated with the project. (optional)
    
    recent - Returns the user's most recently accessed projects. You may specify the number of results to return up to a maximum of 20. If access is anonymous, then the recently accessed projects are based on the current HTTP session. (optional)
    
    properties - A list of project properties to return for the project. This parameter accepts a comma-separated list. (optional, default to new ArrayList<>())
    
    restRequestEnhancer -
    Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
    
    Returns:
    
    Single<List<Project>>
  - getAllStatuses
```
public io.reactivex.Single<List<IssueTypeWithStatus>> getAllStatuses(String projectIdOrKey,
                                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
```
    Get all statuses for project 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](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
    
    Parameters:
    
    projectIdOrKey - The project ID or project key (case sensitive). (required)
    
    restRequestEnhancer -
    Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
    
    Returns:
    
    Single<List<IssueTypeWithStatus>>
  - getHierarchy
```
public io.reactivex.Single<ProjectIssueTypeHierarchy> getHierarchy(Long projectId,
                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
```
    Get project issue type 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](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
    
    Parameters:
    
    projectId - The ID of the project. (required)
    
    restRequestEnhancer -
    Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
    
    Returns:
    
    Single<ProjectIssueTypeHierarchy>
  - getNotificationSchemeForProject
```
public io.reactivex.Single<NotificationScheme> getNotificationSchemeForProject(String projectKeyOrId,
                                                                               Optional<String> expand,
                                                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
```
    Get project notification scheme Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project. See the [Get notification scheme](#api-rest-api-3-notificationscheme-id-get) resource for more information about notification schemes. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg).
    
    Parameters:
    
    projectKeyOrId - The project ID or project key (case sensitive). (required)
    
    expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `all` Returns all expandable information. * `field` Returns information about any custom fields assigned to receive an event. * `group` Returns information about any groups assigned to receive an event. * `notificationSchemeEvents` Returns a list of event associations. This list is returned for all expandable information. * `projectRole` Returns information about any project roles assigned to receive an event. * `user` Returns information about any users assigned to receive an event. (optional)
    
    restRequestEnhancer -
    Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
    
    Returns:
    
    Single<NotificationScheme>
  - getProject
```
public io.reactivex.Single<Project> getProject(String projectIdOrKey,
                                               Optional<String> expand,
                                               Optional<List<String>> properties,
                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
```
    Get project Returns the [project details](https://confluence.atlassian.com/x/ahLpNw) for a project. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
    
    Parameters:
    
    projectIdOrKey - The project ID or project key (case sensitive). (required)
    
    expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include: * `description` The project description. * `issueTypes` The issue types associated with the project. * `lead` The project lead. * `projectKeys` All project keys associated with the project. * `issueTypeHierarchy` The project issue type hierarchy. (optional)
    
    properties - A list of project properties to return for the project. This parameter accepts a comma-separated list. (optional, default to new ArrayList<>())
    
    restRequestEnhancer -
    Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
    
    Returns:
    
    Single<Project>
  - restore
```
public io.reactivex.Single<Project> restore(String projectIdOrKey,
                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
```
    Restore deleted project Restores a project from the Jira recycle bin. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
    
    Parameters:
    
    projectIdOrKey - The project ID or project key (case sensitive). (required)
    
    restRequestEnhancer -
    Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
    
    Returns:
    
    Single<Project>
  - searchProjects
```
public io.reactivex.Single<PageBeanProject> searchProjects(Optional<Long> startAt,
                                                           Optional<Integer> maxResults,
                                                           Optional<String> orderBy,
                                                           Optional<String> query,
                                                           Optional<String> typeKey,
                                                           Optional<Long> categoryId,
                                                           Optional<String> searchBy,
                                                           Optional<String> action,
                                                           Optional<String> expand,
                                                           Optional<List<String>> status,
                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
```
    Get projects paginated Returns a [paginated](#pagination) list of projects visible to the user. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Projects are returned only where the user has one of: * *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
    
    Parameters:
    
    startAt - The index of the first item to return in a page of results (page offset). (optional, default to 0l)
    
    maxResults - The maximum number of items to return per page. (optional, default to 50)
    
    orderBy - [Order](#ordering) the results by a field. * `category` Sorts by project category. A complete list of category IDs is found using [Get all project categories](#api-rest-api-3-projectCategory-get). * `issueCount` Sorts by the total number of issues in each project. * `key` Sorts by project key. * `lastIssueUpdatedTime` Sorts by the last issue update time. * `name` Sorts by project name. * `owner` Sorts by project lead. * `archivedDate` EXPERIMENTAL. Sorts by project archived date. * `deletedDate` EXPERIMENTAL. Sorts by project deleted date. (optional, default to key)
    
    query - Filter the results using a literal string. Projects with a matching `key` or `name` are returned (case insensitive). (optional)
    
    typeKey - Orders results by the [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes). This parameter accepts a comma-separated list. Valid values are `business`, `service_desk`, and `software`. (optional)
    
    categoryId - The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation. (optional)
    
    searchBy - (optional, default to "key, name")
    
    action - Filter results by projects for which the user can: * `view` the project, meaning that they have one of the following permissions: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * `browse` the project, meaning that they have the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * `edit` the project, meaning that they have one of the following permissions: * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, default to view)
    
    expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: * `description` Returns the project description. * `projectKeys` Returns all project keys associated with a project. * `lead` Returns information about the project lead. * `issueTypes` Returns all issue types associated with the project. * `url` Returns the URL associated with the project. * `insight` EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project. (optional)
    
    status - EXPERIMENTAL. Filter results by project status: * `live` Search live projects. * `archived` Search archived projects. * `deleted` Search deleted projects, those in the recycle bin. (optional, default to new ArrayList<>())
    
    restRequestEnhancer -
    Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
    
    Returns:
    
    Single<PageBeanProject>
  - updateProject
```
public io.reactivex.Single<Project> updateProject(String projectIdOrKey,
                                                  ProjectInputBean projectInputBean,
                                                  Optional<String> expand,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
```
    Update project Updates the [project details](https://confluence.atlassian.com/x/ahLpNw) of a project. All parameters are optional in the body of the request. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
    
    Parameters:
    
    projectIdOrKey - The project ID or project key (case sensitive). (required)
    
    projectInputBean - The project details to be updated. (required)
    
    expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include: * `description` The project description. * `issueTypes` The issue types associated with the project. * `lead` The project lead. * `projectKeys` All project keys associated with the project. (optional)
    
    restRequestEnhancer -
    Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
    
    Returns:
    
    Single<Project>
  - updateProjectType
```
@Deprecated
public io.reactivex.Single<Project> updateProjectType(String projectIdOrKey,
                                                                   String newProjectTypeKey,
                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
```
    Deprecated.
    
    Update project type Deprecated, this feature is no longer supported and no alternatives are available, see [Convert project to a different template or type](https://confluence.atlassian.com/x/yEKeOQ). Updates a [project type](https://confluence.atlassian.com/x/GwiiLQ). The project type can be updated for classic projects only, project type cannot be updated for next-gen projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
    
    Parameters:
    
    projectIdOrKey - The project ID or project key (case sensitive). (required)
    
    newProjectTypeKey - The key of the new project type. (required)
    
    restRequestEnhancer -
    Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
    
    Returns:
    
    Single<Project>

Class ProjectsApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProjectsApi

Method Detail

archiveProject

createProject

deleteProject

deleteProjectAsynchronously

getAllProjects

getAllStatuses

getHierarchy

getNotificationSchemeForProject

getProject

restore

searchProjects

updateProject

updateProjectType