Interface JiraClient
public interface JiraClient
RESTEasy client proxy for the Jira REST endpoints used by the Jira readers and
JiraService; methods return the raw
JSON response.-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic classHolds a RESTEasy client and theJiraClientproxy created byJiraClient.Proxy.get(String, String, String); callJiraClient.JiraStub.close()to release the client.static classCreates Jira clients that authenticate with a username and API key. -
Method Summary
Modifier and TypeMethodDescriptioncreateIssue(JiraIssue jiraIssue) deleteIssue(String issueIdOrKey) Returns a page of the board's epics as JSON; a nulldoneomits the done filter.getIssueComments(String issueIdOrKey) getIssueStatus(String issueIdOrKey, String fields) Returns the issue as JSON, requesting only the givenfields(such asstatus).getIssueTransitions(String issueIdOrKey) getProjects(String expand, Integer recent, boolean includeArchived) Deprecated.getProjectsPaginated(int startAt, int maxResults, String orderBy, String query, String expand) Returns a page of projects as JSON, starting at the 0-basedstartAtoffset.getSprints(int boardId, int startAt, int maxResults, String state) Returns a page of the board's sprints as JSON; a nullstateomits the state filter.postIssueComment(String issueIdOrKey, String body) Adds a comment to the issue;bodyis the JSON request body, not the plain comment text.postRestSearchIssues(JiraSearch jiraSearch) Runs the JQL search and returns a page of matching issues as JSON.transitionIssue(String issueIdOrKey, JiraIssue jiraIssue) Performs the transition set on the given issue withJiraIssue.setTransition(int).updateIssue(String issueIdOrKey, JiraIssue jiraIssue)
-
Method Details
-
getProjects
Deprecated. -
getProjectsPaginated
String getProjectsPaginated(int startAt, int maxResults, String orderBy, String query, String expand) Returns a page of projects as JSON, starting at the 0-basedstartAtoffset. -
getSprints
Returns a page of the board's sprints as JSON; a nullstateomits the state filter. -
getEpics
Returns a page of the board's epics as JSON; a nulldoneomits the done filter. -
postRestSearchIssues
Runs the JQL search and returns a page of matching issues as JSON. -
createIssue
-
updateIssue
-
getIssueTransitions
-
getIssueStatus
Returns the issue as JSON, requesting only the givenfields(such asstatus). -
transitionIssue
Performs the transition set on the given issue withJiraIssue.setTransition(int). -
deleteIssue
-
getIssueComments
-
postIssueComment
Adds a comment to the issue;bodyis the JSON request body, not the plain comment text.
-