|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface XmlRpcService
The XmlRpcService provides an XML-RPC interface into JIRA. All available methods are documented here. For the latest on the plugin, visit http://confluence.atlassian.com/display/JIRAEXT/JIRA+RPC+plugin
Method Summary | |
---|---|
boolean |
addComment(java.lang.String token,
java.lang.String issueKey,
java.lang.String comment)
Adds a comment to an issue |
java.util.Hashtable |
createIssue(java.lang.String token,
java.util.Hashtable rIssueStruct)
Creates an issue in JIRA from a Hashtable object. |
java.util.Vector |
getComments(java.lang.String token,
java.lang.String issueKey)
Returns all comments associated with the issue |
java.util.Vector |
getComponents(java.lang.String token,
java.lang.String projectKey)
Returns all components available in the specified project |
java.util.Vector |
getFavouriteFilters(java.lang.String token)
Gets all favourite filters available for the currently logged in user |
java.util.Hashtable |
getIssue(java.lang.String token,
java.lang.String issueKey)
Gets an issue from a given issue key. |
java.util.Vector |
getIssuesFromFilter(java.lang.String token,
java.lang.String filterId)
Executes a saved filter |
java.util.Vector |
getIssuesFromTextSearch(java.lang.String token,
java.lang.String searchTerms)
Find issues using a free text search |
java.util.Vector |
getIssuesFromTextSearchWithProject(java.lang.String token,
java.util.Vector projectKeys,
java.lang.String searchTerms,
int maxNumResults)
Find issues using a free text search, limited to certain projects |
java.util.Vector |
getIssueTypes(java.lang.String token)
Returns all visible issue types in the system |
java.util.Vector |
getIssueTypesForProject(java.lang.String token,
java.lang.String projectId)
Returns all visible (non-sub task) issue types for the specified project id |
java.util.Vector |
getPriorities(java.lang.String token)
Returns all priorities in the system |
java.util.Vector |
getProjectsNoSchemes(java.lang.String token)
Returns a list of projects available to the user |
java.util.Vector |
getResolutions(java.lang.String token)
Returns all resolutions in the system |
java.util.Vector |
getSavedFilters(java.lang.String token)
Deprecated. since v3.13. Please use getFavouriteFilters(String) |
java.util.Hashtable |
getServerInfo(java.lang.String token)
Returns the Server information such as baseUrl, version, edition, buildDate, buildNumber. |
java.util.Vector |
getStatuses(java.lang.String token)
Returns all statuses in the system |
java.util.Vector |
getSubTaskIssueTypes(java.lang.String token)
Returns all visible subtask issue types in the system |
java.util.Vector |
getSubTaskIssueTypesForProject(java.lang.String token,
java.lang.String projectId)
Returns all visible sub task issue types for the specified project id. |
java.util.Hashtable |
getUser(java.lang.String token,
java.lang.String username)
Returns a user's information given a username |
java.util.Vector |
getVersions(java.lang.String token,
java.lang.String projectKey)
Returns all versions available in the specified project |
java.lang.String |
login(java.lang.String username,
java.lang.String password)
Logs the user into JIRA. |
boolean |
logout(java.lang.String token)
Logs the user out of JIRA |
java.util.Hashtable |
updateIssue(java.lang.String token,
java.lang.String issueKey,
java.util.Hashtable fieldValues)
Updates an issue in JIRA from a Hashtable object. |
Method Detail |
---|
java.lang.String login(java.lang.String username, java.lang.String password) throws java.lang.Exception
username
- username of the person logged in in aspassword
- the appropriate password
java.lang.Exception
boolean logout(java.lang.String token)
token
-
java.util.Hashtable getServerInfo(java.lang.String token)
token
-
RemoteServerInfo
.java.util.Vector getProjectsNoSchemes(java.lang.String token) throws java.lang.Exception
token
-
RemoteProject
java.lang.Exception
java.util.Vector getVersions(java.lang.String token, java.lang.String projectKey) throws java.lang.Exception
token
- projectKey
- The key of project
RemoteVersion
java.lang.Exception
java.util.Vector getComponents(java.lang.String token, java.lang.String projectKey) throws java.lang.Exception
token
- projectKey
- The key of the project
RemoteComment
java.lang.Exception
java.util.Vector getIssueTypesForProject(java.lang.String token, java.lang.String projectId) throws java.lang.Exception
token
- projectId
-
RemoteIssueType
java.lang.Exception
java.util.Vector getSubTaskIssueTypesForProject(java.lang.String token, java.lang.String projectId) throws java.lang.Exception
token
- projectId
-
RemoteIssueType
java.lang.Exception
java.util.Vector getIssueTypes(java.lang.String token) throws java.lang.Exception
token
-
RemoteIssueType
java.lang.Exception
java.util.Vector getSubTaskIssueTypes(java.lang.String token) throws java.lang.Exception
token
-
RemoteIssueType
java.lang.Exception
java.util.Vector getPriorities(java.lang.String token) throws java.lang.Exception
token
-
RemotePriority
java.lang.Exception
java.util.Vector getStatuses(java.lang.String token) throws java.lang.Exception
token
-
RemoteStatus
java.lang.Exception
java.util.Vector getResolutions(java.lang.String token) throws java.lang.Exception
token
-
RemoteResolution
java.lang.Exception
java.util.Hashtable getUser(java.lang.String token, java.lang.String username) throws java.lang.Exception
token
- username
- the username of the user being retrieved
RemoteUser
java.lang.Exception
java.util.Vector getSavedFilters(java.lang.String token) throws java.lang.Exception
getFavouriteFilters(String)
token
-
RemoteFilter
java.lang.Exception
java.util.Vector getFavouriteFilters(java.lang.String token) throws java.lang.Exception
token
-
RemoteFilter
java.lang.Exception
java.util.Hashtable getIssue(java.lang.String token, java.lang.String issueKey) throws java.lang.Exception
token
- issueKey
- the key of an issue (e.g. JRA-111)
RemoteIssue
.
This has nested Hashtables for components RemoteComponent
, affectsVersions, fixVersions RemoteVersion
and customFieldValues RemoteCustomFieldValue
.
java.lang.Exception
java.util.Hashtable createIssue(java.lang.String token, java.util.Hashtable rIssueStruct) throws java.lang.Exception
createIssue(String, Hashtable)
. That is components, affectsVersions, fixVersions and customFieldValues must
be blank or be Hashtables with the appropriate data structures. Issues must not have the fields id, key or reporter set,
in addition to any standard rules of issue creation (e.g. permissions, not null summary)
token
- rIssueStruct
- Hashtable of issue fields with the appropriate structure for RemoteIssue
.
java.lang.Exception
java.util.Hashtable updateIssue(java.lang.String token, java.lang.String issueKey, java.util.Hashtable fieldValues) throws java.lang.Exception
createIssue(String, Hashtable)
. That is components, affectsVersions, fixVersions and customFieldValues must
be blank or be Hashtables with the appropriate data structures. Issues must not have the fields id, key or reporter set,
in addition to any standard rules of issue creation (e.g. permissions, not null summary)
token
- fieldValues
- Hashtable of issue fields with the appropriate structure for RemoteIssue
.
java.lang.Exception
boolean addComment(java.lang.String token, java.lang.String issueKey, java.lang.String comment) throws java.lang.Exception
token
- issueKey
- he key of an issue (e.g. JRA-111)comment
- the text string for the comment
java.lang.Exception
java.util.Vector getIssuesFromFilter(java.lang.String token, java.lang.String filterId) throws java.lang.Exception
token
- filterId
- id of the saved filter
java.lang.Exception
java.util.Vector getIssuesFromTextSearch(java.lang.String token, java.lang.String searchTerms) throws java.lang.Exception
token
- searchTerms
- The terms to search for
java.lang.Exception
java.util.Vector getIssuesFromTextSearchWithProject(java.lang.String token, java.util.Vector projectKeys, java.lang.String searchTerms, int maxNumResults) throws java.lang.Exception
token
- projectKeys
- searchTerms
-
java.lang.Exception
java.util.Vector getComments(java.lang.String token, java.lang.String issueKey) throws java.lang.Exception
token
- issueKey
- the key of an issue (e.g. JRA-111)
RemoteComment
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |