com.atlassian.jira.rest.v2.issue

Class ProjectResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.ProjectResource

public class ProjectResource
extends Object

Since:

4.2

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_RECENT_PROJECTS

Constructor Summary

Constructors

Constructor and Description

ProjectResource(ProjectService projectService, JiraAuthenticationContext authContext, javax.ws.rs.core.UriInfo uriInfo, VersionService versionService, ProjectComponentService projectComponentService, AvatarService avatarService, UserManager userManager, ProjectBeanFactory projectBeanFactory, VersionBeanFactory versionBeanFactory, PermissionManager permissionManager, ProjectManager projectManager, AvatarManager avatarManager, AvatarPickerHelper avatarPickerHelper, AttachmentHelper attachmentHelper, JiraBaseUrls jiraBaseUrls, WorkflowManager workflowManager, IssueTypeSchemeManager issueTypeSchemeManager, PermissionSchemeManager permissionSchemeManager, NotificationSchemeManager notificationSchemeManager, IssueSecuritySchemeManager issueSecuritySchemeManager, ResourceUriBuilder uriBuilder, StatusHelper statusHelper, ProjectFinder projectFinder, XsrfInvocationChecker xsrfChecker, UserProjectHistoryManager projectHistoryManager, ResponseFactory responses, I18nHelper i18nHelper, com.atlassian.jira.blueprint.core.api.CoreProjectConfigurator coreProjectConfigurator, ArchivedProjectService archivedProjectService, OrderByRequestParser orderByRequestParser, com.atlassian.jira.rest.v2.issue.ProjectWorkflowSchemeAssignor projectWorkflowSchemeAssignor, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	archiveProject(String projectIdOrKey) Archives a project.
javax.ws.rs.core.Response	createAvatarFromTemporary(String projectIdOrKey, AvatarCroppingBean croppingInstructions) Converts the temporary avatar into the final one.
javax.ws.rs.core.Response	createProject(ProjectInputBean project) Creates a new project.
javax.ws.rs.core.Response	deleteAvatar(String projectIdOrKey, Long id) Deletes avatar
javax.ws.rs.core.Response	deleteProject(String projectIdOrKey) Deletes a project.
javax.ws.rs.core.Response	getAllAvatars(String projectIdOrKey) Returns all avatars which are visible for the currently logged in user.
javax.ws.rs.core.Response	getAllProjects(String expand, Integer recent, boolean includeArchived, boolean browseArchive) Returns all projects which are visible for the currently logged in user.
javax.ws.rs.core.Response	getAllStatuses(String projectIdOrKey) Get all issue types with valid status values for a project
javax.ws.rs.core.Response	getProject(String projectIdOrKey, String expand) Contains a full representation of a project in JSON format.
javax.ws.rs.core.Response	getProjectComponents(String projectIdOrKey) Contains a full representation of a the specified project's components.
javax.ws.rs.core.Response	getProjectVersions(String projectIdOrKey, String expand) Contains a full representation of a the specified project's versions.
javax.ws.rs.core.Response	getProjectVersionsPaginated(String projectIdOrKey, Long startAt, Integer maxResults, String orderBy, String expand) Returns all versions for the specified project.
javax.ws.rs.core.Response	restoreProject(String projectIdOrKey) Restore an archived project.
javax.ws.rs.core.Response	storeTemporaryAvatar(String projectIdOrKey, String filename, Long size, javax.servlet.http.HttpServletRequest request) Uploads an image and creates a temporary avatar.
javax.ws.rs.core.Response	storeTemporaryAvatarUsingMultiPart(String projectIdOrKey, com.atlassian.plugins.rest.common.multipart.FilePart filePart, javax.servlet.http.HttpServletRequest request) Creates temporary avatar using multipart.
javax.ws.rs.core.Response	updateProject(String projectIdOrKey, String expand, ProjectUpdateBean updateData) Updates a project.
javax.ws.rs.core.Response	updateProjectAvatar(String projectIdOrKey, AvatarBean avatarBean) Updates an avatar for a project.
javax.ws.rs.core.Response	updateProjectType(String projectIdOrKey, String newProjectTypeKey) Updates the type of a project.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_RECENT_PROJECTS

public static final int MAX_RECENT_PROJECTS

See Also:

Constant Field Values

Constructor Detail

ProjectResource

public ProjectResource(ProjectService projectService,
                       JiraAuthenticationContext authContext,
                       javax.ws.rs.core.UriInfo uriInfo,
                       VersionService versionService,
                       ProjectComponentService projectComponentService,
                       AvatarService avatarService,
                       UserManager userManager,
                       ProjectBeanFactory projectBeanFactory,
                       VersionBeanFactory versionBeanFactory,
                       PermissionManager permissionManager,
                       ProjectManager projectManager,
                       AvatarManager avatarManager,
                       AvatarPickerHelper avatarPickerHelper,
                       AttachmentHelper attachmentHelper,
                       JiraBaseUrls jiraBaseUrls,
                       WorkflowManager workflowManager,
                       IssueTypeSchemeManager issueTypeSchemeManager,
                       PermissionSchemeManager permissionSchemeManager,
                       NotificationSchemeManager notificationSchemeManager,
                       IssueSecuritySchemeManager issueSecuritySchemeManager,
                       ResourceUriBuilder uriBuilder,
                       StatusHelper statusHelper,
                       ProjectFinder projectFinder,
                       XsrfInvocationChecker xsrfChecker,
                       UserProjectHistoryManager projectHistoryManager,
                       ResponseFactory responses,
                       I18nHelper i18nHelper,
                       com.atlassian.jira.blueprint.core.api.CoreProjectConfigurator coreProjectConfigurator,
                       ArchivedProjectService archivedProjectService,
                       OrderByRequestParser orderByRequestParser,
                       com.atlassian.jira.rest.v2.issue.ProjectWorkflowSchemeAssignor projectWorkflowSchemeAssignor,
                       com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

getProject

public javax.ws.rs.core.Response getProject(String projectIdOrKey,
                                            String expand)

Contains a full representation of a project in JSON format.

All project keys associated with the project will only be returned if expand=projectKeys.

Parameters:

projectIdOrKey - the project id or project key

expand - the parameters to expand

Returns:

a project

createProject

public javax.ws.rs.core.Response createProject(ProjectInputBean project)

Creates a new project.

Parameters:

project - new project details

Returns:

The ProjectIdentity of newly created project.

updateProject

public javax.ws.rs.core.Response updateProject(String projectIdOrKey,
                                               String expand,
                                               ProjectUpdateBean updateData)

Updates a project.

Only non null values sent in JSON will be updated in the project.

Values available for the assigneeType field are: "PROJECT_LEAD" and "UNASSIGNED".

Parameters:

projectIdOrKey - identity of the project to update

expand - the parameters to expand in returned project

updateData - new values for the project

Returns:

updated project details.

updateProjectType

public javax.ws.rs.core.Response updateProjectType(String projectIdOrKey,
                                                   String newProjectTypeKey)

Updates the type of a project.

Parameters:

projectIdOrKey - identity of the project to update

newProjectTypeKey - The key of the new project type

Returns:

A response that will contain the updated project if the operation was successful.

archiveProject

public javax.ws.rs.core.Response archiveProject(String projectIdOrKey)

Archives a project.

Parameters:

projectIdOrKey - Project id or project key

Returns:

no content response

restoreProject

public javax.ws.rs.core.Response restoreProject(String projectIdOrKey)

Restore an archived project. In case of success restored project should be re-indexed.

Parameters:

projectIdOrKey - Project id or project key

Returns:

no content response

deleteProject

public javax.ws.rs.core.Response deleteProject(String projectIdOrKey)

Deletes a project.

Parameters:

projectIdOrKey - Project id or project key

Returns:

no content response

getProjectVersions

public javax.ws.rs.core.Response getProjectVersions(String projectIdOrKey,
                                                    String expand)

Contains a full representation of a the specified project's versions.

Parameters:

projectIdOrKey - the project id or project key

expand - the parameters to expand

Returns:

the passed project's versions.

getProjectVersionsPaginated

public javax.ws.rs.core.Response getProjectVersionsPaginated(String projectIdOrKey,
                                                             Long startAt,
                                                             Integer maxResults,
                                                             String orderBy,
                                                             String expand)

Returns all versions for the specified project. Results are paginated.

Results can be ordered by the following fields:

• sequence
• name
• startDate
• releaseDate

Parameters:

projectIdOrKey - the project id or project key

startAt - the page offset, if not specified then defaults to 0

maxResults - how many results on the page should be included. Defaults to 50.

orderBy - ordering of the results.

expand - the parameters to expand

Returns:

the passed project's versions.

getProjectComponents

public javax.ws.rs.core.Response getProjectComponents(String projectIdOrKey)

Contains a full representation of a the specified project's components.

Parameters:

projectIdOrKey - the project id or project key

Returns:

the passed project's components.

getAllProjects

public javax.ws.rs.core.Response getAllProjects(String expand,
                                                Integer recent,
                                                boolean includeArchived,
                                                boolean browseArchive)

Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the list of projects that are visible when using anonymous access.

Parameters:

expand - the parameters to expand

recent - if this parameter is set then only projects recently accessed by the current user (if not logged in then based on HTTP session) will be returned (maximum count limited to the specified number but no more than 20).

includeArchived - whether to include archived projects in response, default: false

browseArchive - whether to include only projects where current user can browse archive

Returns:

all projects for which the user has the BROWSE project permission. If no user is logged in, it returns all projects, which are visible when using anonymous access.

Since:

v4.3

getAllAvatars

public javax.ws.rs.core.Response getAllAvatars(String projectIdOrKey)

Returns all avatars which are visible for the currently logged in user. The avatars are grouped into system and custom.

Parameters:

projectIdOrKey - project id or project key

Returns:

all avatars for which the user has the BROWSE project permission.

Since:

v5.0

createAvatarFromTemporary

public javax.ws.rs.core.Response createAvatarFromTemporary(String projectIdOrKey,
                                                           AvatarCroppingBean croppingInstructions)

Converts the temporary avatar into the final one. This is step 2/3 of changing an avatar for a project:

• Upload (store temporary avatar)
• Crop (create avatar from temporary)
• Update (update project avatar)

Parameters:

projectIdOrKey - project id or project key

croppingInstructions - cropping instructions

Returns:

created avatar

updateProjectAvatar

public javax.ws.rs.core.Response updateProjectAvatar(String projectIdOrKey,
                                                     AvatarBean avatarBean)

Updates an avatar for a project. This is step 3/3 of changing an avatar for a project:

• Upload (store temporary avatar)
• Crop (create avatar from temporary)
• Update (update project avatar)

Parameters:

projectIdOrKey - project id or project key

avatarBean - avatar data returned in step 2

Returns:

avatar update status

storeTemporaryAvatar

public javax.ws.rs.core.Response storeTemporaryAvatar(String projectIdOrKey,
                                                      String filename,
                                                      Long size,
                                                      @Context
                                                      javax.servlet.http.HttpServletRequest request)

Uploads an image and creates a temporary avatar. This is step 1/3 of changing an avatar for a project:

• Upload (store temporary avatar)
• Crop (create avatar from temporary)
• Update (update project avatar)

Supported image formats:

• BMP
• GIF
• JPEG
• PNG
• WBMP

 curl \
   -X POST \
   -u admin:admin \
   -H "X-Atlassian-Token: no-check" \
   -H "Content-Type: image/png" \
   --data-binary @mynewavatar.png \
   'http://localhost:8090/jira/rest/api/2/user/avatar/temporary?username=admin&filename=mynewavatar.png'
 

Parameters:

projectIdOrKey - Project id or project key

filename - name of file being uploaded

size - size of the image file

request - servlet request

Returns:

temporary avatar cropping instructions

Since:

v5.0

storeTemporaryAvatarUsingMultiPart

public javax.ws.rs.core.Response storeTemporaryAvatarUsingMultiPart(String projectIdOrKey,
                                                                    com.atlassian.plugins.rest.common.multipart.FilePart filePart,
                                                                    @Context
                                                                    javax.servlet.http.HttpServletRequest request)

Creates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because the client uses remote iframing to submit avatars using multipart. So we must send them a valid HTML page back from which the client parses the JSON.

Parameters:

projectIdOrKey - Project id or project key

request - servlet request

Returns:

temporary avatar cropping instructions

Since:

v5.0

deleteAvatar

public javax.ws.rs.core.Response deleteAvatar(String projectIdOrKey,
                                              Long id)

Deletes avatar

Parameters:

projectIdOrKey - Project id or project key

id - database id for avatar

Returns:

no content response

Since:

v5.0

getAllStatuses

public javax.ws.rs.core.Response getAllStatuses(String projectIdOrKey)

Get all issue types with valid status values for a project

Parameters:

projectIdOrKey - Project id or project key

Returns:

collection of issue types with possi

Since:

v6.0