com.atlassian.jira.rpc.soap
Interface JiraSoapService

All Known Implementing Classes:

JiraSoapServiceImpl

public interface JiraSoapService

Method Summary

void	addActorsToProjectRole(java.lang.String token, java.lang.String[] actors, RemoteProjectRole projectRole, RemoteProject project, java.lang.String actorType)
boolean	addAttachmentsToIssue(java.lang.String token, java.lang.String issueKey, java.lang.String[] fileNames, byte[][] attachments) Deprecated. since v4.0 please use addBase64EncodedAttachmentsToIssue(String, String, String[], String[])
boolean	addBase64EncodedAttachmentsToIssue(java.lang.String token, java.lang.String issueKey, java.lang.String[] fileNames, java.lang.String[] base64EncodedAttachmentData) An alternative mechanism for adding attachments to an issue.
void	addComment(java.lang.String token, java.lang.String issueKey, RemoteComment remoteComment)
void	addDefaultActorsToProjectRole(java.lang.String token, java.lang.String[] actors, RemoteProjectRole projectRole, java.lang.String type)
RemotePermissionScheme	addPermissionTo(java.lang.String token, RemotePermissionScheme permissionScheme, RemotePermission permission, RemoteEntity remoteEntity)
void	addUserToGroup(java.lang.String token, RemoteGroup group, RemoteUser ruser)
RemoteVersion	addVersion(java.lang.String token, java.lang.String projectKey, RemoteVersion remoteVersion)
RemoteWorklog	addWorklogAndAutoAdjustRemainingEstimate(java.lang.String token, java.lang.String issueKey, RemoteWorklog remoteWorklog) Adds a worklog to the given issue.
RemoteWorklog	addWorklogAndRetainRemainingEstimate(java.lang.String token, java.lang.String issueKey, RemoteWorklog remoteWorklog) Adds a worklog to the given issue but leaves the issue's remaining estimate field unchanged.
RemoteWorklog	addWorklogWithNewRemainingEstimate(java.lang.String token, java.lang.String issueKey, RemoteWorklog remoteWorklog, java.lang.String newRemainingEstimate) Adds a worklog to the given issue and sets the issue's remaining estimate field to the given value.
void	archiveVersion(java.lang.String token, java.lang.String projectKey, java.lang.String versionName, boolean archive)
RemoteGroup	createGroup(java.lang.String token, java.lang.String groupName, RemoteUser firstUser) Creates a group with the given name optionally adding the given user to it.
RemoteIssue	createIssue(java.lang.String token, RemoteIssue rIssue)
RemoteIssue	createIssueWithSecurityLevel(java.lang.String token, RemoteIssue rIssue, java.lang.Long securityLevelId)
RemotePermissionScheme	createPermissionScheme(java.lang.String token, java.lang.String name, java.lang.String description)
RemoteProject	createProject(java.lang.String token, java.lang.String key, java.lang.String name, java.lang.String description, java.lang.String url, java.lang.String lead, RemotePermissionScheme permissionScheme, RemoteScheme notificationScheme, RemoteScheme issueSecurityScheme)
RemoteProject	createProjectFromObject(java.lang.String token, RemoteProject rproject)
RemoteProjectRole	createProjectRole(java.lang.String token, RemoteProjectRole projectRole)
RemoteUser	createUser(java.lang.String token, java.lang.String username, java.lang.String password, java.lang.String fullName, java.lang.String email) Creates a user in JIRA with the specified user details.
void	deleteGroup(java.lang.String token, java.lang.String groupName, java.lang.String swapGroupName)
void	deleteIssue(java.lang.String token, java.lang.String issueKey)
RemotePermissionScheme	deletePermissionFrom(java.lang.String token, RemotePermissionScheme permissionSchemeName, RemotePermission permission, RemoteEntity remoteEntity)
void	deletePermissionScheme(java.lang.String token, java.lang.String permissionSchemeName)
void	deleteProject(java.lang.String token, java.lang.String projectKey)
void	deleteProjectAvatar(java.lang.String token, long avatarId) Deletes the given custom Avatar from the system.
void	deleteProjectRole(java.lang.String token, RemoteProjectRole projectRole, boolean confirm)
void	deleteUser(java.lang.String token, java.lang.String username) Deletes a user in JIRA with the specified username.
void	deleteWorklogAndAutoAdjustRemainingEstimate(java.lang.String token, java.lang.String worklogId) Deletes the worklog with the given id and updates the remaining estimate field on the isssue by increasing it by the time spent amount on the worklog being deleted.
void	deleteWorklogAndRetainRemainingEstimate(java.lang.String token, java.lang.String worklogId) Deletes the worklog with the given id but leaves the remaining estimate field on the isssue unchanged.
void	deleteWorklogWithNewRemainingEstimate(java.lang.String token, java.lang.String worklogId, java.lang.String newRemainingEstimate) Deletes the worklog with the given id and sets the remaining estimate field on the isssue to the given value.
RemoteComment	editComment(java.lang.String token, RemoteComment remoteComment)
RemotePermission[]	getAllPermissions(java.lang.String token)
RemoteScheme[]	getAssociatedNotificationSchemes(java.lang.String token, RemoteProjectRole projectRole)
RemoteScheme[]	getAssociatedPermissionSchemes(java.lang.String token, RemoteProjectRole projectRole)
RemoteAttachment[]	getAttachmentsFromIssue(java.lang.String token, java.lang.String issueKey)
RemoteNamedObject[]	getAvailableActions(java.lang.String token, java.lang.String issueKey)
RemoteComment	getComment(java.lang.String token, java.lang.Long id)
RemoteComment[]	getComments(java.lang.String token, java.lang.String issueKey)
RemoteComponent[]	getComponents(java.lang.String token, java.lang.String projectKey) Returns an array of all the components for the specified project key.
RemoteConfiguration	getConfiguration(java.lang.String token) Returns information about the current configuration of JIRA.
RemoteField[]	getCustomFields(java.lang.String token)
RemoteRoleActors	getDefaultRoleActors(java.lang.String token, RemoteProjectRole projectRole)
RemoteFilter[]	getFavouriteFilters(java.lang.String token) This retreives a list of the currently logged in user's favourite fitlers.
RemoteField[]	getFieldsForAction(java.lang.String token, java.lang.String issueKey, java.lang.String actionIdString)
RemoteField[]	getFieldsForEdit(java.lang.String token, java.lang.String issueKey)
RemoteGroup	getGroup(java.lang.String token, java.lang.String groupName) Find the group with the specified name in JIRA.
RemoteIssue	getIssue(java.lang.String token, java.lang.String issueKey)
RemoteIssue	getIssueById(java.lang.String token, java.lang.String issueId)
long	getIssueCountForFilter(java.lang.String token, java.lang.String filterId)
RemoteIssue[]	getIssuesFromFilter(java.lang.String token, java.lang.String filterId) Deprecated. use getIssuesFromFilterWithLimit(String, String, int, int) instead
RemoteIssue[]	getIssuesFromFilterWithLimit(java.lang.String token, java.lang.String filterId, int offSet, int maxNumResults) Returns issues that match the saved filter specified by the filterId.
RemoteIssue[]	getIssuesFromJqlSearch(java.lang.String token, java.lang.String jqlSearch, int maxNumResults) Execute a specified JQL query and return the resulting issues.
RemoteIssue[]	getIssuesFromTextSearch(java.lang.String token, java.lang.String searchTerms) Deprecated. use getIssuesFromTextSearchWithLimit(String, String, int, int) instead
RemoteIssue[]	getIssuesFromTextSearchWithLimit(java.lang.String token, java.lang.String searchTerms, int offSet, int maxNumResults) Returns issues containing searchTerms.
RemoteIssue[]	getIssuesFromTextSearchWithProject(java.lang.String token, java.lang.String[] projectKeys, java.lang.String searchTerms, int maxNumResults) Returns issues containing searchTerms that are within the specified projects.
RemoteIssueType[]	getIssueTypes(java.lang.String token) Returns an array of all the issue types for all projects in JIRA.
RemoteIssueType[]	getIssueTypesForProject(java.lang.String token, java.lang.String projectId) Returns an array of all the (non-sub task) issue types for the specified project id.
RemoteScheme[]	getNotificationSchemes(java.lang.String token)
RemotePermissionScheme[]	getPermissionSchemes(java.lang.String token)
RemotePriority[]	getPriorities(java.lang.String token) Returns an array of all the issue priorities in JIRA.
RemoteAvatar	getProjectAvatar(java.lang.String token, java.lang.String projectKey) Retrieves the current avatar for the given project.
RemoteAvatar[]	getProjectAvatars(java.lang.String token, java.lang.String projectKey, boolean includeSystemAvatars) Retrieves avatars for the given project.
RemoteProject	getProjectById(java.lang.String token, java.lang.Long projectId) Returns the Project with the matching id (if the user has permission to browse it).
RemoteProject	getProjectByKey(java.lang.String token, java.lang.String projectKey) Returns the Project with the matching key (if the user has permission to browse it).
RemoteProjectRole	getProjectRole(java.lang.String token, java.lang.Long id)
RemoteProjectRoleActors	getProjectRoleActors(java.lang.String token, RemoteProjectRole projectRole, RemoteProject project)
RemoteProjectRole[]	getProjectRoles(java.lang.String token)
RemoteProject[]	getProjectsNoSchemes(java.lang.String token) Returns an array of all the Projects defined in JIRA.
RemoteProject	getProjectWithSchemesById(java.lang.String token, java.lang.Long projectId) Returns the Project with the matching id (if the user has permission to browse it) with notification, issue security and permission schemes attached.
java.util.Date	getResolutionDateById(java.lang.String token, java.lang.Long issueId) Given an issue id, this method returns the resolution date for this issue.
java.util.Date	getResolutionDateByKey(java.lang.String token, java.lang.String issueKey) Given an issue key, this method returns the resolution date for this issue.
RemoteResolution[]	getResolutions(java.lang.String token) Returns an array of all the issue resolutions in JIRA.
RemoteFilter[]	getSavedFilters(java.lang.String token) Deprecated. since v3.13. Please use getFavouriteFilters(String)
RemoteSecurityLevel	getSecurityLevel(java.lang.String token, java.lang.String issueKey) Returns the current security level for given issue
RemoteSecurityLevel[]	getSecurityLevels(java.lang.String token, java.lang.String projectKey) Returns an array of all security levels for a given project.
RemoteScheme[]	getSecuritySchemes(java.lang.String token)
RemoteServerInfo	getServerInfo(java.lang.String token) Returns information about the server JIRA is running on including build number and base URL.
RemoteStatus[]	getStatuses(java.lang.String token) Returns an array of all the issue statuses in JIRA.
RemoteIssueType[]	getSubTaskIssueTypes(java.lang.String token) Returns an array of all the sub task issue types in JIRA.
RemoteIssueType[]	getSubTaskIssueTypesForProject(java.lang.String token, java.lang.String projectId) Returns an array of all the sub task issue types for the specified project id.
RemoteUser	getUser(java.lang.String token, java.lang.String username) Returns information about a user defined to JIRA.
RemoteVersion[]	getVersions(java.lang.String token, java.lang.String projectKey) Returns an array of all the versions for the specified project key.
RemoteWorklog[]	getWorklogs(java.lang.String token, java.lang.String issueKey) Returns all worklogs for the given issue.
boolean	hasPermissionToCreateWorklog(java.lang.String token, java.lang.String issueKey) Determines if the user has the permission to add worklogs to the specified issue, that timetracking is enabled in JIRA and that the specified issue is in an editable workflow state.
boolean	hasPermissionToDeleteWorklog(java.lang.String token, java.lang.String worklogId) Determine whether the current user has the permission to delete the supplied worklog, that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state.
boolean	hasPermissionToEditComment(java.lang.String token, RemoteComment remoteComment)
boolean	hasPermissionToUpdateWorklog(java.lang.String token, java.lang.String worklogId) Determine whether the current user has the permission to update the supplied worklog, that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state.
boolean	isProjectRoleNameUnique(java.lang.String token, java.lang.String name)
java.lang.String	login(java.lang.String username, java.lang.String password) This will authenticate the user in JIRA and returned a authentication token that can then be used on all other SOAP methods.
boolean	logout(java.lang.String token) Cleans up an authentication token that was previously created with a call to login(java.lang.String, java.lang.String)
RemoteIssue	progressWorkflowAction(java.lang.String token, java.lang.String issueKey, java.lang.String actionIdString, RemoteFieldValue[] actionParams) This will progress an issue through a workflow.
void	refreshCustomFields(java.lang.String token)
void	releaseVersion(java.lang.String token, java.lang.String projectKey, RemoteVersion version)
void	removeActorsFromProjectRole(java.lang.String token, java.lang.String[] actors, RemoteProjectRole projectRole, RemoteProject project, java.lang.String actorType)
void	removeAllRoleActorsByNameAndType(java.lang.String token, java.lang.String name, java.lang.String type)
void	removeAllRoleActorsByProject(java.lang.String token, RemoteProject project)
void	removeDefaultActorsFromProjectRole(java.lang.String token, java.lang.String[] actors, RemoteProjectRole projectRole, java.lang.String actorType)
void	removeUserFromGroup(java.lang.String token, RemoteGroup group, RemoteUser ruser)
void	setNewProjectAvatar(java.lang.String token, java.lang.String projectKey, java.lang.String contentType, java.lang.String base64ImageData) Creates a new custom avatar for the given project and sets it to be current for the project.
void	setProjectAvatar(java.lang.String token, java.lang.String projectKey, java.lang.Long avatarId) Sets the current avatar for the given project to that with the given id.
RemoteGroup	updateGroup(java.lang.String token, RemoteGroup group)
RemoteIssue	updateIssue(java.lang.String token, java.lang.String issueKey, RemoteFieldValue[] actionParams) This will update an issue with new values.
RemoteProject	updateProject(java.lang.String token, RemoteProject rProject)
void	updateProjectRole(java.lang.String token, RemoteProjectRole projectRole)
void	updateWorklogAndAutoAdjustRemainingEstimate(java.lang.String token, RemoteWorklog remoteWorklog) Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog and changes the remaining estimate field on the relevant issue to the value obtained by adding the previous time spent amount of the worklog and subtracting the new time spent amount.
void	updateWorklogAndRetainRemainingEstimate(java.lang.String token, RemoteWorklog remoteWorklog) Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog but leaves the remaining estimate field on the relevant issue unchanged.
void	updateWorklogWithNewRemainingEstimate(java.lang.String token, RemoteWorklog remoteWorklog, java.lang.String newRemainingEstimate) Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog and sets the remaining estimate field on the relevant issue to the given value.

Method Detail

login

java.lang.String login(java.lang.String username,
                       java.lang.String password)
                       throws RemoteException,
                              RemoteAuthenticationException

This will authenticate the user in JIRA and returned a authentication token that can then be used on all other SOAP methods.

Parameters:

username - the JIRA user name to authenticate

password - the password of the JIRA user

Returns:

a authentication token that can then be used on further SOAP calls.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemoteAuthenticationException - If the username and password is an invalid combination

logout

boolean logout(java.lang.String token)

Cleans up an authentication token that was previously created with a call to login(java.lang.String, java.lang.String)

Parameters:

token - the SOAP authentication token

Returns:

true if the logout succeeded

getServerInfo

RemoteServerInfo getServerInfo(java.lang.String token)

Returns information about the server JIRA is running on including build number and base URL.

Parameters:

token - the SOAP authentication token.

Returns:

a RemoteServerInfo object

getProjectById

RemoteProject getProjectById(java.lang.String token,
                             java.lang.Long projectId)
                             throws RemotePermissionException,
                                    RemoteAuthenticationException,
                                    RemoteException

Returns the Project with the matching id (if the user has permission to browse it).

Parameters:

token - the SOAP authentication token.

projectId - the id of the requested project

Returns:

the RemoteProject object specified by the key, if it exists and the user has the BROWSE permission for it

Throws:

RemotePermissionException - if the User does not have permission to BROWSE the project.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteException

getProjectWithSchemesById

RemoteProject getProjectWithSchemesById(java.lang.String token,
                                        java.lang.Long projectId)
                                        throws RemoteException

Returns the Project with the matching id (if the user has permission to browse it) with notification, issue security and permission schemes attached.

Parameters:

token - the SOAP authentication token.

projectId - the id of the requested project

Returns:

the RemoteProject object specified by the key, if it exists and the user has the BROWSE permission for it

Throws:

RemotePermissionException - if the User does not have permission to BROWSE the project.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteException

getProjectByKey

RemoteProject getProjectByKey(java.lang.String token,
                              java.lang.String projectKey)
                              throws RemotePermissionException,
                                     RemoteAuthenticationException,
                                     RemoteException

Returns the Project with the matching key (if the user has permission to browse it).

Parameters:

token - the SOAP authentication token.

projectKey - the key of the requested project

Returns:

the RemoteProject object specified by the key, if it exists and the user has the BROWSE permission for it

Throws:

RemotePermissionException - if the User does not have permission to BROWSE the project.

RemoteAuthenticationException

RemoteException

getVersions

RemoteVersion[] getVersions(java.lang.String token,
                            java.lang.String projectKey)
                            throws RemotePermissionException,
                                   RemoteAuthenticationException,
                                   RemoteException

Returns an array of all the versions for the specified project key.

Parameters:

token - the SOAP authentication token.

projectKey - the key of the requested project

Returns:

an array of RemoteVersion objects

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getComponents

RemoteComponent[] getComponents(java.lang.String token,
                                java.lang.String projectKey)
                                throws RemotePermissionException,
                                       RemoteAuthenticationException,
                                       RemoteException

Returns an array of all the components for the specified project key.

Parameters:

token - the SOAP authentication token.

projectKey - the key of the requested project

Returns:

an array of RemoteComponent objects

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getIssueTypesForProject

RemoteIssueType[] getIssueTypesForProject(java.lang.String token,
                                          java.lang.String projectId)
                                          throws RemotePermissionException,
                                                 RemoteAuthenticationException

Returns an array of all the (non-sub task) issue types for the specified project id.

Parameters:

token - the SOAP authentication token.

projectId - id of the project

Returns:

an array of RemoteIssueType objects

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getSubTaskIssueTypesForProject

RemoteIssueType[] getSubTaskIssueTypesForProject(java.lang.String token,
                                                 java.lang.String projectId)
                                                 throws RemotePermissionException,
                                                        RemoteAuthenticationException

Returns an array of all the sub task issue types for the specified project id.

Parameters:

token - the SOAP authentication token.

projectId - id of the project

Returns:

an array of RemoteIssueType objects

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getIssueTypes

RemoteIssueType[] getIssueTypes(java.lang.String token)
                                throws RemotePermissionException,
                                       RemoteAuthenticationException

Returns an array of all the issue types for all projects in JIRA.

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemoteIssueType objects

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getSubTaskIssueTypes

RemoteIssueType[] getSubTaskIssueTypes(java.lang.String token)
                                       throws RemotePermissionException,
                                              RemoteAuthenticationException

Returns an array of all the sub task issue types in JIRA.

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemoteIssueType objects

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getPriorities

RemotePriority[] getPriorities(java.lang.String token)
                               throws RemotePermissionException,
                                      RemoteAuthenticationException

Returns an array of all the issue priorities in JIRA.

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemotePriority objects

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getStatuses

RemoteStatus[] getStatuses(java.lang.String token)
                           throws RemotePermissionException,
                                  RemoteAuthenticationException

Returns an array of all the issue statuses in JIRA.

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemoteStatus objects

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getResolutions

RemoteResolution[] getResolutions(java.lang.String token)
                                  throws RemotePermissionException,
                                         RemoteAuthenticationException

Returns an array of all the issue resolutions in JIRA.

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemoteResolution objects

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getUser

RemoteUser getUser(java.lang.String token,
                   java.lang.String username)
                   throws RemotePermissionException,
                          RemoteAuthenticationException

Returns information about a user defined to JIRA.

Parameters:

token - the SOAP authentication token.

username - the user name to look up

Returns:

a RemoteUser or null if it cant be found

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

createUser

RemoteUser createUser(java.lang.String token,
                      java.lang.String username,
                      java.lang.String password,
                      java.lang.String fullName,
                      java.lang.String email)
                      throws RemotePermissionException,
                             RemoteAuthenticationException,
                             RemoteValidationException,
                             RemoteException

Creates a user in JIRA with the specified user details.

Parameters:

token - the SOAP authentication token.

username - the user name to create

password - the password for the new user

fullName - the full name of the new user

email - the email of the new user

Returns:

the newly created RemoteUser

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

RemoteException

deleteUser

void deleteUser(java.lang.String token,
                java.lang.String username)
                throws RemotePermissionException,
                       RemoteAuthenticationException,
                       RemoteException,
                       RemoteValidationException

Deletes a user in JIRA with the specified username.

Parameters:

token - the SOAP authentication token.

username - the user name to delete

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteException

RemoteValidationException

getGroup

RemoteGroup getGroup(java.lang.String token,
                     java.lang.String groupName)
                     throws RemotePermissionException,
                            RemoteAuthenticationException,
                            RemoteException,
                            RemoteValidationException

Find the group with the specified name in JIRA.

Parameters:

token - the SOAP authentication token.

groupName - the name of the group to find.

Returns:

a RemoteGroup object for the found group or null if it cant be found.

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteException

RemoteValidationException

createGroup

RemoteGroup createGroup(java.lang.String token,
                        java.lang.String groupName,
                        RemoteUser firstUser)
                        throws RemotePermissionException,
                               RemoteAuthenticationException,
                               RemoteException,
                               RemoteValidationException

Creates a group with the given name optionally adding the given user to it.

Parameters:

token - the SOAP authentication token.

groupName - the name of the group to create.

firstUser - the user to add to the group (if null, no user will be added).

Returns:

the group.

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteValidationException - If there is a problem with the group name, such as if the group name exists.

RemoteException

addUserToGroup

void addUserToGroup(java.lang.String token,
                    RemoteGroup group,
                    RemoteUser ruser)
                    throws RemotePermissionException,
                           RemoteAuthenticationException,
                           RemoteException,
                           RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

removeUserFromGroup

void removeUserFromGroup(java.lang.String token,
                         RemoteGroup group,
                         RemoteUser ruser)
                         throws RemotePermissionException,
                                RemoteAuthenticationException,
                                RemoteException,
                                RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

updateGroup

RemoteGroup updateGroup(java.lang.String token,
                        RemoteGroup group)
                        throws RemotePermissionException,
                               RemoteAuthenticationException,
                               RemoteException,
                               RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

deleteGroup

void deleteGroup(java.lang.String token,
                 java.lang.String groupName,
                 java.lang.String swapGroupName)
                 throws RemotePermissionException,
                        RemoteAuthenticationException,
                        RemoteException,
                        RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

getSavedFilters

RemoteFilter[] getSavedFilters(java.lang.String token)
                               throws RemotePermissionException,
                                      RemoteAuthenticationException,
                                      RemoteException

Deprecated. since v3.13. Please use getFavouriteFilters(String)

This retreives a list of the currently logged in user's favourite fitlers.

Parameters:

token - the SOAP authentication token.

Returns:

a list of the currently logged in user's favourite fitlers.

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteValidationException - If there is a problem with the group name, such as if the group name exists.

RemoteException

getFavouriteFilters

RemoteFilter[] getFavouriteFilters(java.lang.String token)
                                   throws RemotePermissionException,
                                          RemoteAuthenticationException,
                                          RemoteException

This retreives a list of the currently logged in user's favourite fitlers.

Parameters:

token - the SOAP authentication token.

Returns:

a list of the currently logged in user's favourite fitlers.

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteValidationException - If there is a problem with the group name, such as if the group name exists.

RemoteException

getIssue

RemoteIssue getIssue(java.lang.String token,
                     java.lang.String issueKey)
                     throws RemotePermissionException,
                            RemoteAuthenticationException,
                            RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

getResolutionDateByKey

java.util.Date getResolutionDateByKey(java.lang.String token,
                                      java.lang.String issueKey)
                                      throws RemotePermissionException,
                                             RemoteAuthenticationException,
                                             RemoteException

Given an issue key, this method returns the resolution date for this issue. If the issue hasn't been resolved yet, this method will return null.

If the no issue with the given key exists a RemoteException will be thrown.

Parameters:

token - the SOAP authentication token

issueKey - the key of the issue

Returns:

The resolution date of the issue. May be null

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteException

Since:

4.0

getResolutionDateById

java.util.Date getResolutionDateById(java.lang.String token,
                                     java.lang.Long issueId)
                                     throws RemotePermissionException,
                                            RemoteAuthenticationException,
                                            RemoteException

Given an issue id, this method returns the resolution date for this issue. If the issue hasn't been resolved yet, this method will return null.

If the no issue with the given id exists a RemoteException will be thrown.

Parameters:

token - the SOAP authentication token

issueId - the id of the issue

Returns:

The resolution date of the issue. May be null

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteException

Since:

4.0

getComment

RemoteComment getComment(java.lang.String token,
                         java.lang.Long id)
                         throws RemoteException

Throws:

RemoteException

getComments

RemoteComment[] getComments(java.lang.String token,
                            java.lang.String issueKey)
                            throws RemotePermissionException,
                                   RemoteAuthenticationException,
                                   RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

createIssue

RemoteIssue createIssue(java.lang.String token,
                        RemoteIssue rIssue)
                        throws RemotePermissionException,
                               RemoteAuthenticationException,
                               RemoteException,
                               RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

createIssueWithSecurityLevel

RemoteIssue createIssueWithSecurityLevel(java.lang.String token,
                                         RemoteIssue rIssue,
                                         java.lang.Long securityLevelId)
                                         throws RemotePermissionException,
                                                RemoteAuthenticationException,
                                                RemoteException,
                                                RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

addAttachmentsToIssue

boolean addAttachmentsToIssue(java.lang.String token,
                              java.lang.String issueKey,
                              java.lang.String[] fileNames,
                              byte[][] attachments)
                              throws RemotePermissionException,
                                     RemoteAuthenticationException,
                                     RemoteException,
                                     RemoteValidationException

Deprecated. since v4.0 please use addBase64EncodedAttachmentsToIssue(String, String, String[], String[])

Add attachments to an issue.

This method accepts the data of the attachments as byte arrays. This is known to cause problems when the attachments are above a certain size. For more information, please see JRA-11693.

Parameters:

token - the SOAP authentication token.

issueKey - the issue to attach to

fileNames - an array of filenames; each element names an attachment to be uploaded

attachments - an array of byte arrays; each element contains the data of the attachment to be uploaded

Returns:

true if attachments were successfully added; if the operation was not successful, an exception would be thrown

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteValidationException - If there is a problem with the group name, such as if the group name exists.

RemoteException

addBase64EncodedAttachmentsToIssue

boolean addBase64EncodedAttachmentsToIssue(java.lang.String token,
                                           java.lang.String issueKey,
                                           java.lang.String[] fileNames,
                                           java.lang.String[] base64EncodedAttachmentData)
                                           throws RemotePermissionException,
                                                  RemoteAuthenticationException,
                                                  RemoteException,
                                                  RemoteValidationException

An alternative mechanism for adding attachments to an issue. This method accepts the data of the attachments as Base64 encoded strings instead of byte arrays. This is to combat the XML message bloat created by Axis when SOAP-ifying byte arrays.

For more information, please see JRA-11693.

Parameters:

token - the SOAP authentication token.

issueKey - the issue to attach to

fileNames - an array of filenames; each element names an attachment to be uploaded

base64EncodedAttachmentData - an array of Base 64 encoded Strings; each element contains the data of the attachment to be uploaded

Returns:

true if attachments were successfully added; if the operation was not successful, an exception would be thrown

Throws:

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

RemoteValidationException - If there is a problem with the group name, such as if the group name exists.

RemoteException

See Also:

addAttachmentsToIssue(String, String, String[], byte[][])

getAttachmentsFromIssue

RemoteAttachment[] getAttachmentsFromIssue(java.lang.String token,
                                           java.lang.String issueKey)
                                           throws RemotePermissionException,
                                                  RemoteAuthenticationException,
                                                  RemoteException,
                                                  RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

deleteIssue

void deleteIssue(java.lang.String token,
                 java.lang.String issueKey)
                 throws RemotePermissionException,
                        RemoteAuthenticationException,
                        RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

createProject

RemoteProject createProject(java.lang.String token,
                            java.lang.String key,
                            java.lang.String name,
                            java.lang.String description,
                            java.lang.String url,
                            java.lang.String lead,
                            RemotePermissionScheme permissionScheme,
                            RemoteScheme notificationScheme,
                            RemoteScheme issueSecurityScheme)
                            throws RemotePermissionException,
                                   RemoteAuthenticationException,
                                   RemoteException,
                                   RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

createProjectFromObject

RemoteProject createProjectFromObject(java.lang.String token,
                                      RemoteProject rproject)
                                      throws RemotePermissionException,
                                             RemoteAuthenticationException,
                                             RemoteException,
                                             RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

updateProject

RemoteProject updateProject(java.lang.String token,
                            RemoteProject rProject)
                            throws RemotePermissionException,
                                   RemoteAuthenticationException,
                                   RemoteException,
                                   RemoteValidationException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

RemoteValidationException

deleteProject

void deleteProject(java.lang.String token,
                   java.lang.String projectKey)
                   throws RemotePermissionException,
                          RemoteAuthenticationException,
                          RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

getNotificationSchemes

RemoteScheme[] getNotificationSchemes(java.lang.String token)
                                      throws RemotePermissionException,
                                             RemoteAuthenticationException,
                                             RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

getPermissionSchemes

RemotePermissionScheme[] getPermissionSchemes(java.lang.String token)
                                              throws RemotePermissionException,
                                                     RemoteAuthenticationException,
                                                     RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

getSecuritySchemes

RemoteScheme[] getSecuritySchemes(java.lang.String token)
                                  throws RemotePermissionException,
                                         RemoteAuthenticationException,
                                         RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

getAllPermissions

RemotePermission[] getAllPermissions(java.lang.String token)
                                     throws RemotePermissionException,
                                            RemoteException,
                                            RemoteAuthenticationException

Throws:

RemotePermissionException

RemoteException

RemoteAuthenticationException

createPermissionScheme

RemotePermissionScheme createPermissionScheme(java.lang.String token,
                                              java.lang.String name,
                                              java.lang.String description)
                                              throws RemotePermissionException,
                                                     RemoteException,
                                                     RemoteAuthenticationException,
                                                     RemoteValidationException

Throws:

RemotePermissionException

RemoteException

RemoteAuthenticationException

RemoteValidationException

addPermissionTo

RemotePermissionScheme addPermissionTo(java.lang.String token,
                                       RemotePermissionScheme permissionScheme,
                                       RemotePermission permission,
                                       RemoteEntity remoteEntity)
                                       throws RemotePermissionException,
                                              RemoteException,
                                              RemoteValidationException,
                                              RemoteAuthenticationException

Throws:

RemotePermissionException

RemoteException

RemoteValidationException

RemoteAuthenticationException

deletePermissionFrom

RemotePermissionScheme deletePermissionFrom(java.lang.String token,
                                            RemotePermissionScheme permissionSchemeName,
                                            RemotePermission permission,
                                            RemoteEntity remoteEntity)
                                            throws RemotePermissionException,
                                                   RemoteException,
                                                   RemoteAuthenticationException,
                                                   RemoteValidationException

Throws:

RemotePermissionException

RemoteException

RemoteAuthenticationException

RemoteValidationException

deletePermissionScheme

void deletePermissionScheme(java.lang.String token,
                            java.lang.String permissionSchemeName)
                            throws RemotePermissionException,
                                   RemoteException,
                                   RemoteAuthenticationException,
                                   RemoteValidationException

Throws:

RemotePermissionException

RemoteException

RemoteAuthenticationException

RemoteValidationException

addComment

void addComment(java.lang.String token,
                java.lang.String issueKey,
                RemoteComment remoteComment)
                throws RemotePermissionException,
                       RemoteAuthenticationException,
                       RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

hasPermissionToEditComment

boolean hasPermissionToEditComment(java.lang.String token,
                                   RemoteComment remoteComment)
                                   throws RemoteException

Throws:

RemoteException

editComment

RemoteComment editComment(java.lang.String token,
                          RemoteComment remoteComment)
                          throws RemoteException

Throws:

RemoteException

updateIssue

RemoteIssue updateIssue(java.lang.String token,
                        java.lang.String issueKey,
                        RemoteFieldValue[] actionParams)
                        throws RemoteException

This will update an issue with new values.

NOTE : You cannot update the 'status' field of the issue via this method. You must instead call :

progressWorkflowAction(String, String, String, com.atlassian.jira.rpc.soap.beans.RemoteFieldValue[])

to progress the issue status into a new workflow state.

Parameters:

token - the SOAP authentication token.

issueKey - the issue to update.

actionParams - the list of issue fields to change

Returns:

the updated RemoteIssue

Throws:

RemoteException - if the issue cannot be updated

progressWorkflowAction

RemoteIssue progressWorkflowAction(java.lang.String token,
                                   java.lang.String issueKey,
                                   java.lang.String actionIdString,
                                   RemoteFieldValue[] actionParams)
                                   throws RemoteException

This will progress an issue through a workflow.

Parameters:

token - the SOAP authentication token.

issueKey - the issue to update.

actionIdString - the workflow action to progress to

actionParams - the list of issue fields to change in this workflow step

Returns:

the updated RemoteIssue

Throws:

RemoteException - if the issue cannot be updated

getFieldsForEdit

RemoteField[] getFieldsForEdit(java.lang.String token,
                               java.lang.String issueKey)
                               throws RemoteException

Throws:

RemoteException

getAvailableActions

RemoteNamedObject[] getAvailableActions(java.lang.String token,
                                        java.lang.String issueKey)
                                        throws RemoteException

Throws:

RemoteException

getFieldsForAction

RemoteField[] getFieldsForAction(java.lang.String token,
                                 java.lang.String issueKey,
                                 java.lang.String actionIdString)
                                 throws RemoteException

Throws:

RemoteException

getCustomFields

RemoteField[] getCustomFields(java.lang.String token)
                              throws RemoteException

Throws:

RemoteException

addVersion

RemoteVersion addVersion(java.lang.String token,
                         java.lang.String projectKey,
                         RemoteVersion remoteVersion)
                         throws RemoteException

Throws:

RemoteException

refreshCustomFields

void refreshCustomFields(java.lang.String token)
                         throws RemoteException

Throws:

RemoteException

getIssuesFromFilter

RemoteIssue[] getIssuesFromFilter(java.lang.String token,
                                  java.lang.String filterId)
                                  throws RemoteException

Deprecated. use getIssuesFromFilterWithLimit(String, String, int, int) instead

Returns issues that match the saved filter specified by the filterId.

This method will return no more than the maxNumResults.

It will start the result set at the provided off set.

This method also respects the jira.search.views.max.limit and jira.search.views.max.unlimited.group JIRA properties which will override the max number of results returned.

If the jira.search.views.max.limit property is set and you are not in a group specified by jira.search.views.max.unlimited.group then the number of results returned will be constrained by the value of jira.search.views.max.limit if it is less than the specified maxNumResults.

Parameters:

token - the SOAP authentication token.

filterId - identifies the saved filter to use for the search.

Returns:

issues matching the saved filter

Throws:

RemoteException - If there was some problem preventing the operation from working.

getIssuesFromTextSearch

RemoteIssue[] getIssuesFromTextSearch(java.lang.String token,
                                      java.lang.String searchTerms)
                                      throws RemoteException

Deprecated. use getIssuesFromTextSearchWithLimit(String, String, int, int) instead

Returns issues containing searchTerms.

Note: this is a fuzzy search, returned in order of 'relevance', so the results are only generally useful for human consumption.

This method also respects the jira.search.views.max.limit and jira.search.views.max.unlimited.group JIRA properties which will override the max number of results returned.

If the jira.search.views.max.limit property is set and you are not in a group specified by jira.search.views.max.unlimited.group then the number of results returned will be constrained by the value of jira.search.views.max.limit if it is less than the specified maxNumResults.

Parameters:

token - the SOAP authentication token.

searchTerms - search terms

Returns:

issues matching the search terms

Throws:

RemoteException - If there was some problem preventing the operation from working.

See Also:

getIssuesFromJqlSearch(String, String, int)

getIssuesFromFilterWithLimit

RemoteIssue[] getIssuesFromFilterWithLimit(java.lang.String token,
                                           java.lang.String filterId,
                                           int offSet,
                                           int maxNumResults)
                                           throws RemoteException

Returns issues that match the saved filter specified by the filterId.

This method will return no more than the maxNumResults.

It will start the result set at the provided off set.

This method also respects the jira.search.views.max.limit and jira.search.views.max.unlimited.group JIRA properties which will override the max number of results returned.

If the jira.search.views.max.limit property is set and you are not in a group specified by jira.search.views.max.unlimited.group then the number of results returned will be constrained by the value of jira.search.views.max.limit if it is less than the specified maxNumResults.

Parameters:

token - the SOAP authentication token.

filterId - identifies the saved filter to use for the search.

offSet - the place in the result set to use as the first result returned

maxNumResults - the maximum number of results that this method will return.

Returns:

issues matching the saved filter

Throws:

RemoteException - If there was some problem preventing the operation from working.

getIssuesFromTextSearchWithLimit

RemoteIssue[] getIssuesFromTextSearchWithLimit(java.lang.String token,
                                               java.lang.String searchTerms,
                                               int offSet,
                                               int maxNumResults)
                                               throws RemoteException

Returns issues containing searchTerms.

Note: this is a fuzzy search, returned in order of 'relevance', so the results are only generally useful for human consumption.

This method will return no more than the maxNumResults.

It will start the result set at the provided off set.

This method also respects the jira.search.views.max.limit and jira.search.views.max.unlimited.group JIRA properties which will override the max number of results returned.

If the jira.search.views.max.limit property is set and you are not in a group specified by jira.search.views.max.unlimited.group then the number of results returned will be constrained by the value of jira.search.views.max.limit if it is less than the specified maxNumResults.

Parameters:

token - the SOAP authentication token.

searchTerms - search terms

offSet - the place in the result set to use as the first result returned

maxNumResults - the maximum number of results that this method will return.

Returns:

issues matching the search terms

Throws:

RemoteException - If there was some problem preventing the operation from working.

See Also:

getIssuesFromJqlSearch(String, String, int)

getIssuesFromTextSearchWithProject

RemoteIssue[] getIssuesFromTextSearchWithProject(java.lang.String token,
                                                 java.lang.String[] projectKeys,
                                                 java.lang.String searchTerms,
                                                 int maxNumResults)
                                                 throws RemoteException

Returns issues containing searchTerms that are within the specified projects.

Note: this is a fuzzy search, returned in order of 'relevance', so the results are only generally useful for human consumption.

This method will return no more than the maxNumResults.

This method also respects the jira.search.views.max.limit and jira.search.views.max.unlimited.group JIRA properties which will override the max number of results returned.

If the jira.search.views.max.limit property is set and you are not in a group specified by jira.search.views.max.unlimited.group then the number of results returned will be constrained by the value of jira.search.views.max.limit if it is less than the specified maxNumResults.

Parameters:

token - the SOAP authentication token.

searchTerms - search terms

maxNumResults - the maximum number of results that this method will return.

Returns:

issues matching the search terms

Throws:

RemoteException - If there was some problem preventing the operation from working.

See Also:

getIssuesFromJqlSearch(String, String, int)

getIssuesFromJqlSearch

RemoteIssue[] getIssuesFromJqlSearch(java.lang.String token,
                                     java.lang.String jqlSearch,
                                     int maxNumResults)
                                     throws RemoteException

Execute a specified JQL query and return the resulting issues.

This method also respects the jira.search.views.max.limit and jira.search.views.max.unlimited.group JIRA properties which will override the max number of results returned.

If the jira.search.views.max.limit property is set and you are not in a group specified by jira.search.views.max.unlimited.group then the number of results returned will be constrained by the value of jira.search.views.max.limit if it is less than the specified maxNumResults.

Parameters:

token - the SOAP authentication token

jqlSearch - JQL query string to execute

maxNumResults - the maximum number of results that this method will return

Returns:

issues matching the JQL query

Throws:

RemoteException - If there was a JQL parse error or an error occurs during the search

getProjectsNoSchemes

RemoteProject[] getProjectsNoSchemes(java.lang.String token)
                                     throws RemotePermissionException,
                                            RemoteAuthenticationException,
                                            RemoteException

Returns an array of all the Projects defined in JIRA.

Parameters:

token - the SOAP authentication token.

Returns:

an array of RemoteProject objects.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteAuthenticationException - If the token is invalid or the SOAP session has timed out

getIssueCountForFilter

long getIssueCountForFilter(java.lang.String token,
                            java.lang.String filterId)
                            throws RemoteException

Throws:

RemoteException

getIssueById

RemoteIssue getIssueById(java.lang.String token,
                         java.lang.String issueId)
                         throws RemotePermissionException,
                                RemoteAuthenticationException,
                                RemoteException

Throws:

RemotePermissionException

RemoteAuthenticationException

RemoteException

getConfiguration

RemoteConfiguration getConfiguration(java.lang.String token)
                                     throws RemotePermissionException,
                                            RemoteAuthenticationException,
                                            RemoteException

Returns information about the current configuration of JIRA.

Parameters:

token - the authr

Returns:

a RemoteConfiguration object which contains information about the current configuration of JIRA.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException

RemoteAuthenticationException

getProjectRoles

RemoteProjectRole[] getProjectRoles(java.lang.String token)
                                    throws RemoteException

Throws:

RemoteException

getProjectRole

RemoteProjectRole getProjectRole(java.lang.String token,
                                 java.lang.Long id)
                                 throws RemoteException

Throws:

RemoteException

createProjectRole

RemoteProjectRole createProjectRole(java.lang.String token,
                                    RemoteProjectRole projectRole)
                                    throws RemoteException

Throws:

RemoteException

isProjectRoleNameUnique

boolean isProjectRoleNameUnique(java.lang.String token,
                                java.lang.String name)
                                throws RemoteException

Throws:

RemoteException

deleteProjectRole

void deleteProjectRole(java.lang.String token,
                       RemoteProjectRole projectRole,
                       boolean confirm)
                       throws RemoteException

Throws:

RemoteException

addActorsToProjectRole

void addActorsToProjectRole(java.lang.String token,
                            java.lang.String[] actors,
                            RemoteProjectRole projectRole,
                            RemoteProject project,
                            java.lang.String actorType)
                            throws RemoteException

Throws:

RemoteException

removeActorsFromProjectRole

void removeActorsFromProjectRole(java.lang.String token,
                                 java.lang.String[] actors,
                                 RemoteProjectRole projectRole,
                                 RemoteProject project,
                                 java.lang.String actorType)
                                 throws RemoteException

Throws:

RemoteException

updateProjectRole

void updateProjectRole(java.lang.String token,
                       RemoteProjectRole projectRole)
                       throws RemoteException

Throws:

RemoteException

getProjectRoleActors

RemoteProjectRoleActors getProjectRoleActors(java.lang.String token,
                                             RemoteProjectRole projectRole,
                                             RemoteProject project)
                                             throws RemoteException

Throws:

RemoteException

getDefaultRoleActors

RemoteRoleActors getDefaultRoleActors(java.lang.String token,
                                      RemoteProjectRole projectRole)
                                      throws RemoteException

Throws:

RemoteException

addDefaultActorsToProjectRole

void addDefaultActorsToProjectRole(java.lang.String token,
                                   java.lang.String[] actors,
                                   RemoteProjectRole projectRole,
                                   java.lang.String type)
                                   throws RemoteException

Throws:

RemoteException

removeDefaultActorsFromProjectRole

void removeDefaultActorsFromProjectRole(java.lang.String token,
                                        java.lang.String[] actors,
                                        RemoteProjectRole projectRole,
                                        java.lang.String actorType)
                                        throws RemoteException

Throws:

RemoteException

removeAllRoleActorsByNameAndType

void removeAllRoleActorsByNameAndType(java.lang.String token,
                                      java.lang.String name,
                                      java.lang.String type)
                                      throws RemoteException

Throws:

RemoteException

removeAllRoleActorsByProject

void removeAllRoleActorsByProject(java.lang.String token,
                                  RemoteProject project)
                                  throws RemoteException

Throws:

RemoteException

getAssociatedNotificationSchemes

RemoteScheme[] getAssociatedNotificationSchemes(java.lang.String token,
                                                RemoteProjectRole projectRole)
                                                throws RemoteException

Throws:

RemoteException

getAssociatedPermissionSchemes

RemoteScheme[] getAssociatedPermissionSchemes(java.lang.String token,
                                              RemoteProjectRole projectRole)
                                              throws RemoteException

Throws:

RemoteException

releaseVersion

void releaseVersion(java.lang.String token,
                    java.lang.String projectKey,
                    RemoteVersion version)
                    throws RemoteException

Throws:

RemoteException

archiveVersion

void archiveVersion(java.lang.String token,
                    java.lang.String projectKey,
                    java.lang.String versionName,
                    boolean archive)
                    throws RemoteException

Throws:

RemoteException

addWorklogWithNewRemainingEstimate

RemoteWorklog addWorklogWithNewRemainingEstimate(java.lang.String token,
                                                 java.lang.String issueKey,
                                                 RemoteWorklog remoteWorklog,
                                                 java.lang.String newRemainingEstimate)
                                                 throws RemoteException,
                                                        RemotePermissionException,
                                                        RemoteValidationException

Adds a worklog to the given issue and sets the issue's remaining estimate field to the given value. The issue's time spent field will be increased by the amount in the remoteWorklog.getTimeSpent().

The following fields of remoteWorklog are ignored:

• id: generated by the system.
• author: derived from the authenticated user.
• updatedAuthor: derived from the authenticated user.
• created: derived from the current date.
• updated: derived from the current date.

Parameters:

token - the SOAP auth token.

issueKey - the key of the issue.

remoteWorklog - the worklog to add.

newRemainingEstimate - the new value for the issue's remaining estimate as a duration string, eg 1d 2h.

Returns:

Created worklog with the id set or null if no worklog was created.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

addWorklogAndAutoAdjustRemainingEstimate

RemoteWorklog addWorklogAndAutoAdjustRemainingEstimate(java.lang.String token,
                                                       java.lang.String issueKey,
                                                       RemoteWorklog remoteWorklog)
                                                       throws RemoteException,
                                                              RemotePermissionException,
                                                              RemoteValidationException

Adds a worklog to the given issue. The issue's time spent field will be increased by the amount in the remoteWorklog.getTimeSpent().

The following fields of remoteWorklog are ignored:

• id: generated by the system.
• author: derived from the authenticated user.
• updatedAuthor: derived from the authenticated user.
• created: derived from the current date.
• updated: derived from the current date.

Parameters:

token - the SOAP auth token.

issueKey - the key of the issue.

remoteWorklog - the worklog to add.

Returns:

Created worklog with the id set or null if no worklog was created.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

addWorklogAndRetainRemainingEstimate

RemoteWorklog addWorklogAndRetainRemainingEstimate(java.lang.String token,
                                                   java.lang.String issueKey,
                                                   RemoteWorklog remoteWorklog)
                                                   throws RemoteException,
                                                          RemotePermissionException,
                                                          RemoteValidationException

Adds a worklog to the given issue but leaves the issue's remaining estimate field unchanged. The issue's time spent field will be increased by the amount in the remoteWorklog.getTimeSpent().

The following fields of remoteWorklog are ignored:

• id: generated by the system.
• author: derived from the authenticated user.
• updatedAuthor: derived from the authenticated user.
• created: derived from the current date.
• updated: derived from the current date.

Parameters:

token - the SOAP auth token.

issueKey - the key of the issue.

remoteWorklog - the worklog to add.

Returns:

Created worklog with the id set or null if no worklog was created.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

getWorklogs

RemoteWorklog[] getWorklogs(java.lang.String token,
                            java.lang.String issueKey)
                            throws RemoteException,
                                   RemotePermissionException,
                                   RemoteValidationException

Returns all worklogs for the given issue.

Parameters:

token - the SOAP auth token.

issueKey - the key of the issue.

Returns:

all the worklogs of the issue.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

deleteWorklogWithNewRemainingEstimate

void deleteWorklogWithNewRemainingEstimate(java.lang.String token,
                                           java.lang.String worklogId,
                                           java.lang.String newRemainingEstimate)
                                           throws RemoteException,
                                                  RemotePermissionException,
                                                  RemoteValidationException

Deletes the worklog with the given id and sets the remaining estimate field on the isssue to the given value. The time spent field of the issue is reduced by the time spent amount on the worklog being deleted.

Parameters:

token - the SOAP auth token.

worklogId - the id of the worklog to delete.

newRemainingEstimate - the new value for the issue's remaining estimate as a duration string, eg 1d 2h.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

deleteWorklogAndAutoAdjustRemainingEstimate

void deleteWorklogAndAutoAdjustRemainingEstimate(java.lang.String token,
                                                 java.lang.String worklogId)
                                                 throws RemoteException,
                                                        RemotePermissionException,
                                                        RemoteValidationException

Deletes the worklog with the given id and updates the remaining estimate field on the isssue by increasing it by the time spent amount on the worklog being deleted. The time spent field of the issue is reduced by the time spent amount on the worklog being deleted.

Parameters:

token - the SOAP auth token.

worklogId - the id of the worklog to delete.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

deleteWorklogAndRetainRemainingEstimate

void deleteWorklogAndRetainRemainingEstimate(java.lang.String token,
                                             java.lang.String worklogId)
                                             throws RemoteException,
                                                    RemotePermissionException,
                                                    RemoteValidationException

Deletes the worklog with the given id but leaves the remaining estimate field on the isssue unchanged. The time spent field of the issue is reduced by the time spent amount on the worklog being deleted.

Parameters:

token - the SOAP auth token.

worklogId - the id of the worklog to delete.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

updateWorklogWithNewRemainingEstimate

void updateWorklogWithNewRemainingEstimate(java.lang.String token,
                                           RemoteWorklog remoteWorklog,
                                           java.lang.String newRemainingEstimate)
                                           throws RemoteException,
                                                  RemotePermissionException,
                                                  RemoteValidationException

Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog and sets the remaining estimate field on the relevant issue to the given value. The time spent field of the issue is changed by subtracting the previous value of the worklog's time spent amount and adding the new value in the given worklog.

The following fields of remoteWorklog are ignored:

• author: unchanged.
• updatedAuthor: derived from the authenticated user.
• created: unchanged.
• updated: derived from the current date.

Parameters:

token - the SOAP auth token.

remoteWorklog - the worklog to update.

newRemainingEstimate - the new value for the issue's remaining estimate as a duration string, eg 1d 2h.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

updateWorklogAndAutoAdjustRemainingEstimate

void updateWorklogAndAutoAdjustRemainingEstimate(java.lang.String token,
                                                 RemoteWorklog remoteWorklog)
                                                 throws RemoteException,
                                                        RemotePermissionException,
                                                        RemoteValidationException

Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog and changes the remaining estimate field on the relevant issue to the value obtained by adding the previous time spent amount of the worklog and subtracting the new time spent amount. The time spent field of the issue is changed by subtracting the previous value of the worklog's time spent amount and adding the new value in the given worklog.

The following fields of remoteWorklog are ignored:

• author: unchanged.
• updatedAuthor: derived from the authenticated user.
• created: unchanged.
• updated: derived from the current date.

Parameters:

token - the SOAP auth token.

remoteWorklog - the worklog to update.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

updateWorklogAndRetainRemainingEstimate

void updateWorklogAndRetainRemainingEstimate(java.lang.String token,
                                             RemoteWorklog remoteWorklog)
                                             throws RemoteException,
                                                    RemotePermissionException,
                                                    RemoteValidationException

Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog but leaves the remaining estimate field on the relevant issue unchanged. The time spent field of the issue is changed by subtracting the previous value of the worklog's time spent amount and adding the new value in the given worklog.

The following fields of remoteWorklog are ignored:

• author: unchanged.
• updatedAuthor: derived from the authenticated user.
• created: unchanged.
• updated: derived from the current date.

Parameters:

token - the SOAP auth token.

remoteWorklog - the worklog to update.

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the user is not permitted to perform this operation in this context.

RemoteValidationException - If the arguments and their properties are incomplete or malformed.

hasPermissionToCreateWorklog

boolean hasPermissionToCreateWorklog(java.lang.String token,
                                     java.lang.String issueKey)
                                     throws RemoteException,
                                            RemoteValidationException

Determines if the user has the permission to add worklogs to the specified issue, that timetracking is enabled in JIRA and that the specified issue is in an editable workflow state.

Parameters:

token - the SOAP auth token.

issueKey - the key of the issue.

Returns:

true if the user has permission to create a worklog on the specified issue, false otherwise

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemoteValidationException

hasPermissionToDeleteWorklog

boolean hasPermissionToDeleteWorklog(java.lang.String token,
                                     java.lang.String worklogId)
                                     throws RemoteException,
                                            RemoteValidationException

Determine whether the current user has the permission to delete the supplied worklog, that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state.

This method will return true if the user is a member of the worklog's group/role level (if specified) AND

• The user has the WORKLOG_DELETE_ALL permission; OR
• The user is the worklog author and has the WORKLOG_DELETE_OWN permission

and false otherwise.

Parameters:

token - the SOAP auth token.

worklogId - the id of the worklog wishes to delete.

Returns:

true if the user has permission to delete the supplied worklog, false otherwise

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemoteValidationException

hasPermissionToUpdateWorklog

boolean hasPermissionToUpdateWorklog(java.lang.String token,
                                     java.lang.String worklogId)
                                     throws RemoteException,
                                            RemoteValidationException

Determine whether the current user has the permission to update the supplied worklog, that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state.

This method will return true if the user is a member of the worklog's group/role level (if specified) AND

• The user has the WORKLOG_EDIT_ALL permission; OR
• The user is the worklog author and has the WORKLOG_EDIT_OWN permission

and false otherwise.

Parameters:

token - the SOAP authentication token.

worklogId - the ide of the worklog wishes to update.

Returns:

true if the user has permission to update the supplied worklog, false otherwise

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemoteValidationException

getSecurityLevel

RemoteSecurityLevel getSecurityLevel(java.lang.String token,
                                     java.lang.String issueKey)
                                     throws RemoteException,
                                            RemotePermissionException

Returns the current security level for given issue

Parameters:

token - the SOAP authentication token

issueKey - the issue key

Returns:

issue security level

Throws:

RemoteException - If there was some problem preventing the operation from working.

RemotePermissionException - If the JIRA instance is not Enterprise edition, the issue key is invalid or the user is not permitted to see this issue.

Since:

v3.13

getSecurityLevels

RemoteSecurityLevel[] getSecurityLevels(java.lang.String token,
                                        java.lang.String projectKey)
                                        throws RemoteException,
                                               RemotePermissionException

Returns an array of all security levels for a given project.

Parameters:

token - the SOAP authentication token

projectKey - the key for the project

Returns:

array of RemoteSecurityLevels for the project

Throws:

RemoteException - If the JIRA instance is not Enterprise edition or the project key is invalid

RemotePermissionException - If you do not have Browse permission for the project

Since:

v3.13

getProjectAvatars

RemoteAvatar[] getProjectAvatars(java.lang.String token,
                                 java.lang.String projectKey,
                                 boolean includeSystemAvatars)
                                 throws RemoteException,
                                        RemotePermissionException

Retrieves avatars for the given project. If the includeSystemAvatars parameter is true, this will include both system (built-in) avatars as well as custom (user-supplied) avatars for that project, otherwise it will include only the custom avatars. Project browse permission is required.

Parameters:

token - the SOAP authentication token

projectKey - the key for the project.

includeSystemAvatars - if false, only custom avatars will be included in the returned array.

Returns:

the avatars for the project, possibly empty.

Throws:

RemoteException - If the project key is invalid.

RemotePermissionException - If you do not have Browse permission for the project.

Since:

4.0

setNewProjectAvatar

void setNewProjectAvatar(java.lang.String token,
                         java.lang.String projectKey,
                         java.lang.String contentType,
                         java.lang.String base64ImageData)
                         throws RemoteException,
                                RemotePermissionException

Creates a new custom avatar for the given project and sets it to be current for the project. The image data must be provided as base64 encoded data and should be 48 pixels square. If the image is larger, the top left 48 pixels are taken, if it is smaller it is upscaled to 48 pixels. The small version of the avatar image (16 pixels) is generated automatically. Project administration permission is required.

Parameters:

token - the SOAP authentication token

projectKey - the key for the project.

contentType - the MIME type of the image provided, e.g. image/gif, image/jpeg, image/png.

base64ImageData - a base 64 encoded image, 48 pixels square.

Throws:

RemoteException - If the project key is invalid.

RemotePermissionException - If you do not have project admin permission for the project.

setProjectAvatar

void setProjectAvatar(java.lang.String token,
                      java.lang.String projectKey,
                      java.lang.Long avatarId)
                      throws RemoteException,
                             RemotePermissionException

Sets the current avatar for the given project to that with the given id. Project administration permission is required.

Parameters:

token - the SOAP authentication token

projectKey - the key for the project.

avatarId - the id of an existing avatar to use for the project or null for the default avatar.

Throws:

RemoteException - If the project key is invalid.

RemotePermissionException - If you do not have project admin permission for the project.

getProjectAvatar

RemoteAvatar getProjectAvatar(java.lang.String token,
                              java.lang.String projectKey)
                              throws RemoteException,
                                     RemotePermissionException

Retrieves the current avatar for the given project. Project browse permission is required.

Parameters:

token - the SOAP authentication token

projectKey - the key for the project.

Returns:

the current avatar for the project.

Throws:

RemoteException - If the project key is invalid.

RemotePermissionException - If you do not have Browse permission for the project.

Since:

4.0

deleteProjectAvatar

void deleteProjectAvatar(java.lang.String token,
                         long avatarId)
                         throws RemoteException

Deletes the given custom Avatar from the system. System avatars cannot be deleted. Project administration permission is required.

Parameters:

token - the SOAP authentication token

avatarId - id of the custom avatar to delete.

Throws:

RemoteException - if there is no avatar with the given id, or if it is a system avatar.

RemotePermissionException - If you do not have administer permission for the project.

Since:

4.0