Working with Projects in JIRA

The following operations are available for working with projects.Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with projects, see Sample configuration .

Operation	Description

Operation	Description
getProject	Gets information about a project.
getAvatarsForProject	Gets all avatars available for a project that are visible to the current user.
deleteAvatarForProject	Deletes an avatar from a project.
getComponentsOfProject	Gets all the components of a project.
getStatusesOfProject	Gets the issue types and their valid status values for a project.
getVersionsOfProject	Gets all the versions of a project.
getRolesOfProject	Gets all the roles in a project.
getRolesByIdOfProject	Gets details on a specific role.
getUserAssignableProjects	Gets a list of users that match the search string.
setActorsToRoleOfProject	Assigns users to a role in a project.

Following is more information about these operations.

Getting information about a project

To get information about a specific project, use getProject and specify the project key. This operation returns a JSON representation of the entire project, including name, ID, components, and more.

getProject

<jira.getProject>
	<projectIdOrKey>{$ctx:projectIdOrKey}</projectIdOrKey>
    <expand>{$ctx:expand}</expand>
</jira.getProject>

Properties

projectIdOrKey: The Identifier the project whose information you want to get.
expand : The parameters to expand.

Sample request

Following is a sample REST/JSON request that can be handled by the getProject operation.

Sample request for getProject

{
    "username":"admin",
    "password":"jira@jaffna",       
    "uri":"https://testcon.atlassian.net",        
    "projectIdOrKey":"TEST"
}

Related JIRA API

https://developer.atlassian.com/static/rest/jira/6.1.html#d2e3008

Getting avatars for a project

To get the avatars available for a specific project, use getAvatarsForProject and specify the project key. This operation returns a JSON representation of the avatars, including their name, ID, and whether the avatar is currently selected for the project.

getAvatarsForProject

<jira.getAvatarsForProject>
	<projectIdOrKey>{$ctx:projectIdOrKey}</projectIdOrKey>
</jira.getAvatarsForProject>

Properties

projectIdOrKey: The Identifier the project whose information you want to get.

Sample request

Following is a sample REST/JSON request that can be handled by the getAvatarsForProject operation.

Sample request for getAvatarsForProject

{
    "username":"admin",
    "password":"jira@jaffna",       
    "uri":"https://testcon.atlassian.net",        
    "projectIdOrKey":"TEST"
}

Related JIRA API

https://developer.atlassian.com/static/rest/jira/6.1.html#d2e3151

Deleting an avatar from a project

To delete an avatar from a project, use deleteAvatarForProject and specify the project key and avatar ID.

deleteAvatarForProject

<jira.deleteAvatarForProject>
	<projectIdOrKey>{$ctx:projectIdOrKey}</projectIdOrKey>
	<avatarId>{$ctx:avatarId}</avatarId>
</jira.deleteAvatarForProject>

Properties

projectIdOrKey: The Identifier the project whose information you want to get.
avatarId: Identifies the avatar to delete.

Sample request

Following is a sample REST/JSON request that can be handled by the deleteAvatarForProject operation.

Sample request for deleteAvatarForProject

{
    "username":"admin",
    "password":"jira@jaffna",       
    "uri":"https://testcon.atlassian.net",        
    "projectIdOrKey":"TEST",
    "avatarId":"10412"
}

Related JIRA API

https://developer.atlassian.com/static/rest/jira/6.1.html#d2e3175