|
Generated by JDiff |
||||||||
| PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES | |||||||||
This file contains all the changes in documentation in the packagecom.atlassian.jira.rpc.soapas colored differences. Deletions are shownlike this, and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.
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. @param token the SOAP authentication token. @param issueKey the issue to attach to @param fileNames an array of filenames; each element names an attachment to be uploaded @param attachments an array of byte arrays; each element contains the data of the attachment to beClass JiraSoapService, boolean addBase64EncodedAttachmentsToIssue(String, String, String[], String[])uploadeduploaded @return true if attachments were successfully added; if the operation was not successful, an exception would bethrownthrown @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out @throws RemoteValidationException Ifthere is a problem with the group name, such as ifthegroup namedata cannot beexists.validated @deprecated since v4.0 please use .addBase64EncodedAttachmentsToIssue(String, String, String[], String[])
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. @param token the SOAP authentication token. @param issueKey the issue to attach to @param fileNames an array of filenames; each element names an attachment to be uploaded @param base64EncodedAttachmentData an array of Base 64 encoded Strings; each element contains the data of the attachment to beClass JiraSoapService, RemoteWorklog addWorklogAndAutoAdjustRemainingEstimate(String, String, RemoteWorklog)uploadeduploaded @return true if attachments were successfully added; if the operation was not successful, an exception would bethrownthrown @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out @throws RemoteValidationException Ifthere is a problem with the group name, such as ifthegroup namedata cannot beexists.validated @see #addAttachmentsToIssue(String, String, String[], byte[][])
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:Class JiraSoapService, RemoteWorklog addWorklogAndRetainRemainingEstimate(String, String, RemoteWorklog)@param token the SOAP
- 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.
authauthentication token. @param issueKey the key of the issue. @param remoteWorklog the worklog to add.@return 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. @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteValidationException If the arguments and their properties are incomplete or malformed.
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:Class JiraSoapService, RemoteWorklog addWorklogWithNewRemainingEstimate(String, String, RemoteWorklog, String)@param token the SOAP
- 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.
authauthentication token. @param issueKey the key of the issue. @param remoteWorklog the worklog to add.@return 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. @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteValidationException If the arguments and their properties are incomplete or malformed.
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:Class JiraSoapService, RemoteGroup createGroup(String, String, RemoteUser)@param token the SOAP
- 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.
authauthentication token. @param issueKey the key of the issue. @param remoteWorklog the worklog to add. @param newRemainingEstimate the new value for the issue's remaining estimate as a duration string, eg 1d 2h.@return 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. @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteValidationException If the arguments and their properties are incomplete or malformed.
Creates a group with the given name optionally adding the given user to it. @param token the SOAP authentication token. @param groupName the name of the group to create. @param firstUser the user to add to the group (if null, no user will be added).Class JiraSoapService, RemoteUser createUser(String, String, String, String, String)@return the group.@throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out @throws RemoteValidationException If there is a problem with the group name, such as if the group name exists.
Creates a user in JIRA with the specified user details. @param token the SOAP authentication token. @param username the user name to create @param password the password for the new user @param fullName the full name of the new user @param email the email of the newClass JiraSoapService, void deleteProjectAvatar(String, long)useruser @return the newly created RemoteUser@throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out @throws RemoteValidationException If the arguments and their properties are incomplete or malformed.
Deletes the given custom Avatar from the system. System avatars cannot be deleted. Project administration permission is required. @param token the SOAP authentication token @param avatarId id of the custom avatar to delete.Class JiraSoapService, void deleteUser(String, String)@throws RemoteException if there is no avatar with the given id, or if it is a system avatar. @throws RemotePermissionException If you do not have administer permission for the project. @since 4.0
Deletes a user in JIRA with the specified username. @param token the SOAP authentication token. @param username the user name toClass JiraSoapService, void deleteWorklogAndAutoAdjustRemainingEstimate(String, String)deletedelete @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timedoutout @throws RemoteValidationException If the arguments and their properties are incomplete or malformed.
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. @param token the SOAPClass JiraSoapService, void deleteWorklogAndRetainRemainingEstimate(String, String)authauthentication token. @param worklogId the id of the worklog to delete.@throws RemoteException If there was some problem preventing the operation from working. @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteValidationException If the arguments and their properties are incomplete or malformed.
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. @param token the SOAPClass JiraSoapService, void deleteWorklogWithNewRemainingEstimate(String, String, String)authauthentication token. @param worklogId the id of the worklog to delete.@throws RemoteException If there was some problem preventing the operation from working. @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteValidationException If the arguments and their properties are incomplete or malformed.
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. @param token the SOAPClass JiraSoapService, RemoteComponent[] getComponents(String, String)authauthentication token. @param worklogId the id of the worklog to delete. @param 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. @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteValidationException If the arguments and their properties are incomplete or malformed.
Returns an array of all the components for the specified project key. @param token the SOAP authentication token. @param projectKey the key of the requestedClass JiraSoapService, RemoteConfiguration getConfiguration(String)projectproject @return an array of RemoteComponentobjectsobjects @throws RemoteException If there was some problem preventing the operation from working. @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out
Returns information about the current configuration of JIRA. @param token theClass JiraSoapService, RemoteFilter[] getFavouriteFilters(String)authrSOAP authentication token. @return a com.atlassian.jira.rpc.soap.beans.RemoteConfiguration object which contains information about the current configuration of JIRA.@throws RemoteException If there was some problem preventing the operation from working. @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out
This retreives a list of the currently logged in user's favourite fitlers. @param token the SOAP authentication token.Class JiraSoapService, RemoteGroup getGroup(String, String)@return 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. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out @throws RemoteValidationException If there is a problem with the group name, such as if the group name exists.
Find the group with the specified name in JIRA. @param token the SOAP authentication token. @param groupName the name of the group to find.Class JiraSoapService, RemoteIssueType[] getIssueTypes(String)@return 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. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timedoutout @throws RemoteValidationException If the arguments and their properties are incomplete or malformed.
Returns an array of all the issue types for all projects in JIRA. @param token the SOAP authentication token.Class JiraSoapService, RemoteIssueType[] getIssueTypesForProject(String, String)@return an array of RemoteIssueTypeobjectsobjects @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out
Returns an array of all the (non-sub task) issue types for the specified project id. @param token the SOAP authentication token. @param projectId id of theClass JiraSoapService, RemoteIssue[] getIssuesFromFilter(String, String)projectproject @return an array of RemoteIssueTypeobjectsobjects @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out
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. @param token the SOAP authentication token. @param filterId identifies the saved filter to use for the search.Class JiraSoapService, RemoteIssue[] getIssuesFromFilterWithLimit(String, String, int, int)@return issues matching the savedfilterfilter @throws RemoteException If there was some problem preventing the operation from working. @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. @param token the SOAP authentication token. @param filterId identifies the saved filter to use for the search. @param offSet the place in the result set to use as the first result returned @param maxNumResults the maximum number of results that this method will return.Class JiraSoapService, RemoteIssue[] getIssuesFromJqlSearch(String, String, int)@return issues matching the savedfilterfilter @throws RemoteException If there was some problem preventing the operation from working.
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. @param token the SOAP authentication token @param jqlSearch JQL query string to execute @param maxNumResults the maximum number of results that this method willClass JiraSoapService, RemoteIssue[] getIssuesFromTextSearch(String, String)returnreturn @return issues matching the JQLqueryquery @throws RemoteException If there was a JQL parse error or an error occurs during the search
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. @param token the SOAP authentication token. @param searchTerms searchClass JiraSoapService, RemoteIssue[] getIssuesFromTextSearchWithLimit(String, String, int, int)termsterms @return issues matching the searchtermsterms @throws RemoteException If there was some problem preventing the operation from working. @see #getIssuesFromJqlSearch(String, String, int) @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 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. @param token the SOAP authentication token. @param searchTerms search terms @param offSet the place in the result set to use as the first result returned @param maxNumResults the maximum number of results that this method will return.Class JiraSoapService, RemoteIssue[] getIssuesFromTextSearchWithProject(String, String[], String, int)@return issues matching the searchtermsterms @throws RemoteException If there was some problem preventing the operation from working. @see #getIssuesFromJqlSearch(String, String, int)
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. @param token the SOAP authentication token. @param projectKeys an array of project keys to search within @param searchTerms search terms @param maxNumResults the maximum number of results that this method will return.Class JiraSoapService, RemotePriority[] getPriorities(String)@return issues matching the searchtermsterms @throws RemoteException If there was some problem preventing the operation from working. @see #getIssuesFromJqlSearch(String, String, int)
Returns an array of all the issue priorities in JIRA. @param token the SOAP authentication token.Class JiraSoapService, RemoteAvatar getProjectAvatar(String, String)@return an array of RemotePriorityobjectsobjects @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out
Retrieves the current avatar for the given project. Project browse permission is required. @param token the SOAP authentication token @param projectKey the key for the project.Class JiraSoapService, RemoteAvatar[] getProjectAvatars(String, String, boolean)@return the current avatar for the project.@throws RemoteException If the project key is invalid. @throws RemotePermissionException If you do not have Browse permission for the project. @since 4.0
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. @param token the SOAP authentication token @param projectKey the key for the project. @param includeSystemAvatars if false, only custom avatars will be included in the returned array.Class JiraSoapService, RemoteProject getProjectById(String, Long)@return the avatars for the project, possibly empty.@throws RemoteException If the project key is invalid. @throws RemotePermissionException If you do not have Browse permission for the project. @since 4.0
Returns the Project with the matching id (if the user has permission to browse it). @param token the SOAP authentication token. @param projectId the id of the requestedClass JiraSoapService, RemoteProject getProjectByKey(String, String)projectproject @return the RemoteProject object specified by the key, if it exists and the user has the BROWSE permission foritit @throws RemotePermissionException if the User does not have permission to BROWSE the project. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out
Returns the Project with the matching key (if the user has permission to browse it). @param token the SOAP authentication token. @param projectKey the key of the requestedClass JiraSoapService, RemoteProject getProjectWithSchemesById(String, Long)projectproject @return the RemoteProject object specified by the key, if it exists and the user has the BROWSE permission foritit @throws RemotePermissionException if the User does not have permission to BROWSE the project. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out @throws RemoteException if something dramatic happens during this operation
Returns the Project with the matching id (if the user has permission to browse it) with notification, issue security and permission schemes attached. @param token the SOAP authentication token. @param projectId the id of the requestedClass JiraSoapService, RemoteProject[] getProjectsNoSchemes(String)projectproject @return the RemoteProject object specified by the key, if it exists and the user has the BROWSE permission foritit @throws RemotePermissionException if the User does not have permission to BROWSE the project. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timedoutout @throws RemoteException if something dramatic happens during this operation
Returns an array of all the Projects defined in JIRA. @param token the SOAP authentication token.Class JiraSoapService, Date getResolutionDateById(String, Long)@return an array of com.atlassian.jira.rpc.soap.beans.RemoteProject objects.@throws RemoteException If there was some problem preventing the operation from working. @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out
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. @param token the SOAP authentication token @param issueId the id of theClass JiraSoapService, Date getResolutionDateByKey(String, String)issueissue @return The resolution date of the issue. May benullnull @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out @since 4.0
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. @param token the SOAP authentication token @param issueKey the key of theClass JiraSoapService, RemoteResolution[] getResolutions(String)issueissue @return The resolution date of the issue. May benullnull @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out @since 4.0
Returns an array of all the issue resolutions in JIRA. @param token the SOAP authentication token.Class JiraSoapService, RemoteFilter[] getSavedFilters(String)@return an array of RemoteResolutionobjectsobjects @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out
ThisClass JiraSoapService, RemoteSecurityLevel getSecurityLevel(String, String)retreivesretrieves a list of the currently logged in user's favourite fitlers. @param token the SOAP authentication token.@return 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. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out @throws RemoteValidationException If there is a problem with the group name, such as if the group name exists. @deprecated since v3.13. Please use .getFavouriteFilters(String)
Returns the current security level for given issue @param token the SOAP authentication token @param issueKey the issueClass JiraSoapService, RemoteSecurityLevel[] getSecurityLevels(String, String)keykey @return issue securitylevellevel @throws RemoteException If there was some problem preventing the operation from working. @throws RemotePermissionException If theJIRA instance is not Enterprise edition, theissue key is invalid orthethe user is not permitted to see this issue. @since v3.13
Returns an array of all security levels for a given project. @param token the SOAP authentication token @param projectKey the key for theClass JiraSoapService, RemoteServerInfo getServerInfo(String)projectproject @return array of RemoteSecurityLevels for theprojectproject @throws RemoteException If theJIRA instance is not Enterprise edition or theproject key is invalid @throws RemotePermissionException If you do not have Browse permission for the project @since v3.13
Returns information about the server JIRA is running on including build number and base URL. @param token the SOAP authentication token.Class JiraSoapService, RemoteStatus[] getStatuses(String)@return a RemoteServerInfo object
Returns an array of all the issue statuses in JIRA. @param token the SOAP authentication token.Class JiraSoapService, RemoteIssueType[] getSubTaskIssueTypes(String)@return an array of RemoteStatusobjectsobjects @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out
Returns an array of all the sub task issue types in JIRA. @param token the SOAP authentication token.Class JiraSoapService, RemoteIssueType[] getSubTaskIssueTypesForProject(String, String)@return an array of RemoteIssueTypeobjectsobjects @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out
Returns an array of all the sub task issue types for the specified project id. @param token the SOAP authentication token. @param projectId id of theClass JiraSoapService, RemoteUser getUser(String, String)projectproject @return an array of RemoteIssueTypeobjectsobjects @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out
Returns information about a user defined to JIRA. @param token the SOAP authentication token. @param username the user name to lookClass JiraSoapService, RemoteVersion[] getVersions(String, String)upup @return a RemoteUser or null if it cant befoundfound @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out
Returns an array of all the versions for the specified project key. @param token the SOAP authentication token. @param projectKey the key of the requestedClass JiraSoapService, RemoteWorklog[] getWorklogs(String, String)projectproject @return an array of RemoteVersionobjectsobjects @throws RemoteException If there was some problem preventing the operation from working. @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteAuthenticationException If the token is invalid or the SOAP session has timed out
Returns all worklogs for the given issue. @param token the SOAPClass JiraSoapService, boolean hasPermissionToCreateWorklog(String, String)authauthentication token. @param issueKey the key of the issue.@return all the worklogs of the issue.@throws RemoteException If there was some problem preventing the operation from working. @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteValidationException If the arguments and their properties are incomplete or malformed.
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. @param token the SOAPClass JiraSoapService, boolean hasPermissionToDeleteWorklog(String, String)authauthentication token. @param issueKey the key of the issue.@return true if the user has permission to create a worklog on the specified issue, falseotherwiseotherwise @throws RemoteValidationException If the arguments and their properties are incomplete or malformed. @throws RemoteException If there was some problem preventing the operation from working.
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) ANDClass JiraSoapService, boolean hasPermissionToUpdateWorklog(String, String)
and false otherwise. @param token the SOAP
- The user has the WORKLOG_DELETE_ALL permission; OR
- The user is the worklog author and has the WORKLOG_DELETE_OWN permission
authauthentication token. @param worklogId the id of the worklog wishes to delete.@return true if the user has permission to delete the supplied worklog, falseotherwiseotherwise @throws RemoteValidationException If the arguments and their properties are incomplete or malformed. @throws RemoteException If there was some problem preventing the operation from working.
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) ANDClass JiraSoapService, String login(String, String)
and false otherwise. @param token the SOAP authentication token. @param worklogId the ide of the worklog wishes to update.
- The user has the WORKLOG_EDIT_ALL permission; OR
- The user is the worklog author and has the WORKLOG_EDIT_OWN permission
@return true if the user has permission to update the supplied worklog, falseotherwiseotherwise @throws RemoteValidationException If the arguments and their properties are incomplete or malformed. @throws RemoteException If there was some problem preventing the operation from working.
This will authenticate the user in JIRA and returned a authentication token that can then be used on all other SOAP methods. @param username the JIRA user name to authenticate @param password the password of the JIRAClass JiraSoapService, boolean logout(String)useruser @return a authentication token that can then be used on further SOAP calls.@throws RemoteException If there was some problem preventing the operation from working. @throws RemoteAuthenticationException If the username and password is an invalid combination
Cleans up an authentication token that was previously created with a call to JiraSoapService.login(String, String) @param token the SOAP authenticationClass JiraSoapService, RemoteIssue progressWorkflowAction(String, String, String, RemoteFieldValue[])tokentoken @return true if the logout succeeded
This will progress an issue through a workflow. @param token the SOAP authentication token. @param issueKey the issue to update. @param actionIdString the workflow action to progress to @param actionParams the list of issue fields to change in this workflowClass JiraSoapService, void setNewProjectAvatar(String, String, String, String)stepstep @return the updatedRemoteIssueRemoteIssue @throws RemoteException if the issue cannot be updated
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. @param token the SOAP authentication token @param projectKey the key for the project. @param contentType the MIME type of the image provided, e.g. image/gif, image/jpeg, image/png. @param base64ImageData a base 64 encoded image, 48 pixels square.Class JiraSoapService, void setProjectAvatar(String, String, Long)@throws RemoteException If the project key is invalid. @throws RemotePermissionException If you do not have project admin permission for the project.
Sets the current avatar for the given project to that with the given id. Project administration permission is required. @param token the SOAP authentication token @param projectKey the key for the project. @param avatarId the id of an existing avatar to use for the project or null for the default avatar.Class JiraSoapService, RemoteIssue updateIssue(String, String, RemoteFieldValue[])@throws RemoteException If the project key is invalid. @throws RemotePermissionException If you do not have project admin permission for the project.
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. If you are updating Select or Multi-Select custom fields, note that you should be passing in the Option Ids, as opposed to the actual Option values. If you pass in the Option values, we will attempt to do an automatic conversion from Option value to an Option Id if we find that none of the values passed in can be parsed to an Option Id for the field. In the case where an Option has a value that is also a valid Option Id for the field, and the supplied value matches this Option value, we assume the supplied value is an OptionId. If any automatic conversion fails, the original values are passed through and cause an exception with the valid Option Ids for the field to be thrown. @param token the SOAP authentication token. @param issueKey the issue to update. @param actionParams the list of issue fields toClass JiraSoapService, void updateWorklogAndAutoAdjustRemainingEstimate(String, RemoteWorklog)changechange @return the updatedRemoteIssueRemoteIssue @throws RemoteException if the issue cannot be updated
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:Class JiraSoapService, void updateWorklogAndRetainRemainingEstimate(String, RemoteWorklog)@param token the SOAP
- author: unchanged.
- updatedAuthor: derived from the authenticated user.
- created: unchanged.
- updated: derived from the current date.
authauthentication token. @param remoteWorklog the worklog to update.@throws RemoteException If there was some problem preventing the operation from working. @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteValidationException If the arguments and their properties are incomplete or malformed.
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:Class JiraSoapService, void updateWorklogWithNewRemainingEstimate(String, RemoteWorklog, String)@param token the SOAP
- author: unchanged.
- updatedAuthor: derived from the authenticated user.
- created: unchanged.
- updated: derived from the current date.
authauthentication token. @param remoteWorklog the worklog to update.@throws RemoteException If there was some problem preventing the operation from working. @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteValidationException If the arguments and their properties are incomplete or malformed.
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:@param token the SOAP
- author: unchanged.
- updatedAuthor: derived from the authenticated user.
- created: unchanged.
- updated: derived from the current date.
authauthentication token. @param remoteWorklog the worklog to update. @param 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. @throws RemotePermissionException If the user is not permitted to perform this operation in this context. @throws RemoteValidationException If the arguments and their properties are incomplete or malformed.
This ability to resolve a token into a user name is used by the JIRA logging and is not exposed on the SOAP service interface itself but rather via com.atlassian.jira.soap.axis.JiraSoapTokenResolver. @param token the given out previously via .login(String, String) @return the user name behind that token or null if the token is not valid