public class IssuesApi extends Object
| Constructor and Description |
|---|
IssuesApi(org.everit.http.restclient.RestClient restClient) |
| Modifier and Type | Method and Description |
|---|---|
io.reactivex.Single<Object> |
assignIssue(String issueIdOrKey,
User user,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Assign issue
Assigns an issue to a user.
|
io.reactivex.Single<CreatedIssue> |
createIssue(IssueUpdateDetails requestBody,
Optional<Boolean> updateHistory,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Create issue
Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask.
|
io.reactivex.Single<CreatedIssues> |
createIssues(IssuesUpdateBean requestBody,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Bulk create issue
Creates issues and, where the option to create subtasks is enabled in Jira, subtasks.
|
io.reactivex.Completable |
deleteIssue(String issueIdOrKey,
Optional<String> deleteSubtasks,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Delete issue
Deletes an issue.
|
io.reactivex.Single<Object> |
doTransition(String issueIdOrKey,
IssueUpdateDetails requestBody,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Transition issue
Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.
|
io.reactivex.Single<Object> |
editIssue(String issueIdOrKey,
IssueUpdateDetails requestBody,
Optional<Boolean> notifyUsers,
Optional<Boolean> overrideScreenSecurity,
Optional<Boolean> overrideEditableFlag,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Edit issue
Edits an issue.
|
io.reactivex.Single<PageBeanChangelog> |
getChangeLogs(String issueIdOrKey,
Optional<Integer> startAt,
Optional<Integer> maxResults,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get change logs
Returns a [paginated](#pagination) list of all changelogs for an issue sorted by date, starting from the oldest.
|
io.reactivex.Single<IssueCreateMetadata> |
getCreateIssueMeta(Optional<List<String>> projectIds,
Optional<List<String>> projectKeys,
Optional<List<String>> issuetypeIds,
Optional<List<String>> issuetypeNames,
Optional<String> expand,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get create issue metadata
Returns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user.
|
io.reactivex.Single<IssueUpdateMetadata> |
getEditIssueMeta(String issueIdOrKey,
Optional<Boolean> overrideScreenSecurity,
Optional<Boolean> overrideEditableFlag,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get edit issue metadata
Returns the edit screen fields for an issue that are visible to and editable by the user.
|
io.reactivex.Single<IssueBean> |
getIssue(String issueIdOrKey,
Optional<List<String>> fields,
Optional<Boolean> fieldsByKeys,
Optional<String> expand,
Optional<List<String>> properties,
Optional<Boolean> updateHistory,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get issue
Returns the details for an issue.
|
io.reactivex.Single<Transitions> |
getTransitions(String issueIdOrKey,
Optional<String> expand,
Optional<String> transitionId,
Optional<Boolean> skipRemoteOnlyCondition,
Optional<Boolean> includeUnavailableTransitions,
Optional<Boolean> sortByOpsBarAndStatus,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get transitions
Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.
|
io.reactivex.Single<Object> |
notify(String issueIdOrKey,
Notification requestBody,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Send notification for issue
Creates an email notification for an issue and adds it to the mail queue.
|
public io.reactivex.Single<Object> assignIssue(String issueIdOrKey, User user, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
issueIdOrKey - The ID or key of the issue to be assigned. (required)user - The request object with the user that the issue is assigned to. (required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<CreatedIssue> createIssue(IssueUpdateDetails requestBody, Optional<Boolean> updateHistory, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
requestBody - (required)updateHistory - Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. (optional, default to false)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<CreatedIssues> createIssues(IssuesUpdateBean requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
requestBody - (required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Completable deleteIssue(String issueIdOrKey, Optional<String> deleteSubtasks, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
issueIdOrKey - The ID or key of the issue. (required)deleteSubtasks - Whether the issue's subtasks are deleted when the issue is deleted. (optional, default to false)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<Object> doTransition(String issueIdOrKey, IssueUpdateDetails requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
issueIdOrKey - The ID or key of the issue. (required)requestBody - (required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<Object> editIssue(String issueIdOrKey, IssueUpdateDetails requestBody, Optional<Boolean> notifyUsers, Optional<Boolean> overrideScreenSecurity, Optional<Boolean> overrideEditableFlag, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
issueIdOrKey - The ID or key of the issue. (required)requestBody - (required)notifyUsers - Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored. (optional, default to true)overrideScreenSecurity - Whether screen security should be overridden to enable hidden fields to be edited. Available to Connect app users with admin permissions. (optional, default to false)overrideEditableFlag - Whether screen security should be overridden to enable uneditable fields to be edited. Available to Connect app users with admin permissions. (optional, default to false)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<PageBeanChangelog> getChangeLogs(String issueIdOrKey, Optional<Integer> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
issueIdOrKey - The ID or key of the issue. (required)startAt - The index of the first item to return in a page of results (page offset). (optional, default to 0)maxResults - The maximum number of items to return per page. (optional, default to 100)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<IssueCreateMetadata> getCreateIssueMeta(Optional<List<String>> projectIds, Optional<List<String>> projectKeys, Optional<List<String>> issuetypeIds, Optional<List<String>> issuetypeNames, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
projectIds - List of project IDs. This parameter accepts a comma-separated list. Multiple project IDs can also be provided using an ampersand-separated list. For example, `projectIds=10000,10001&projectIds=10020,10021`. This parameter may be provided with `projectKeys`. (optional, default to new ArrayList<>())projectKeys - List of project keys. This parameter accepts a comma-separated list. Multiple project keys can also be provided using an ampersand-separated list. For example, `projectKeys=proj1,proj2&projectKeys=proj3`. This parameter may be provided with `projectIds`. (optional, default to new ArrayList<>())issuetypeIds - List of issue type IDs. This parameter accepts a comma-separated list. Multiple issue type IDs can also be provided using an ampersand-separated list. For example, `issuetypeIds=10000,10001&issuetypeIds=10020,10021`. This parameter may be provided with `issuetypeNames`. (optional, default to new ArrayList<>())issuetypeNames - List of issue type names. This parameter accepts a comma-separated list. Multiple issue type names can also be provided using an ampersand-separated list. For example, `issuetypeNames=name1,name2&issuetypeNames=name3`. This parameter may be provided with `issuetypeIds`. (optional, default to new ArrayList<>())expand - Use [expand](#expansion) to include additional information about issue metadata in the response. This parameter accepts `projects.issuetypes.fields`, which returns information about the fields in the issue creation screen for each issue type. Fields hidden from the screen are not returned. Use the information to populate the `fields` and `update` fields in [Create issue](#api-rest-api-2-issue-post) and [Create issues](#api-rest-api-2-issue-bulk-post). (optional)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<IssueUpdateMetadata> getEditIssueMeta(String issueIdOrKey, Optional<Boolean> overrideScreenSecurity, Optional<Boolean> overrideEditableFlag, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
issueIdOrKey - The ID or key of the issue. (required)overrideScreenSecurity - Whether hidden fields should be returned. Available to connect app users with admin permissions. (optional, default to false)overrideEditableFlag - Whether non-editable fields should be returned. Available to connect app users with admin permissions. (optional, default to false)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<IssueBean> getIssue(String issueIdOrKey, Optional<List<String>> fields, Optional<Boolean> fieldsByKeys, Optional<String> expand, Optional<List<String>> properties, Optional<Boolean> updateHistory, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
issueIdOrKey - The ID or key of the issue. (required)fields - A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values: * `*all` Returns all fields. * `*navigable` Returns navigable fields. * Any issue field, prefixed with a minus to exclude. Examples: * `summary,comment` Returns only the summary and comments fields. * `-description` Returns all (default) fields except description. * `*navigable,-comment` Returns all navigable fields except comment. This parameter may be specified multiple times. For example, `fields=field1,field2& fields=field3`. Note: All fields are returned by default. This differs from [Search for issues using JQL (GET)](#api-rest-api-2-search-get) and [Search for issues using JQL (POST)](#api-rest-api-2-search-post) where the default is all navigable fields. (optional, default to new ArrayList<>())fieldsByKeys - Whether fields in `fields` are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID. (optional, default to false)expand - Use [expand](#expansion) to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include: * `renderedFields` Returns field values rendered in HTML format. * `names` Returns the display name of each field. * `schema` Returns the schema describing a field type. * `transitions` Returns all possible transitions for the issue. * `editmeta` Returns information about how each field can be edited. * `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * `versionedRepresentations` Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the `fields` parameter is ignored. (optional)properties - A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: * `*all` Returns all issue properties. * Any issue property key, prefixed with a minus to exclude. Examples: * `*all` Returns all properties. * `*all,-prop1` Returns all properties except `prop1`. * `prop1,prop2` Returns `prop1` and `prop2` properties. This parameter may be specified multiple times. For example, `properties=prop1,prop2& properties=prop3`. (optional, default to new ArrayList<>())updateHistory - Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. This also populates the [JQL issues search](#api-rest-api-2-search-get) `lastViewed` field. (optional, default to false)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<Transitions> getTransitions(String issueIdOrKey, Optional<String> expand, Optional<String> transitionId, Optional<Boolean> skipRemoteOnlyCondition, Optional<Boolean> includeUnavailableTransitions, Optional<Boolean> sortByOpsBarAndStatus, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
issueIdOrKey - The ID or key of the issue. (required)expand - Use [expand](#expansion) to include additional information about transitions in the response. This parameter accepts `transitions.fields`, which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate the `fields` and `update` fields in [Transition issue](#api-rest-api-2-issue-issueIdOrKey-transitions-post). (optional)transitionId - The ID of the transition. (optional)skipRemoteOnlyCondition - Whether transitions with the condition *Hide From User Condition* are included in the response. (optional, default to false)includeUnavailableTransitions - Whether details of transitions that fail a condition are included in the response (optional, default to false)sortByOpsBarAndStatus - Whether the transitions are sorted by ops-bar sequence value first then category order (Todo, In Progress, Done) or only by ops-bar sequence value. (optional, default to false)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
public io.reactivex.Single<Object> notify(String issueIdOrKey, Notification requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
issueIdOrKey - ID or key of the issue that the notification is sent for. (required)requestBody - The request object for the notification and recipients. (required)restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
Copyright © 2011–2021 Everit Kft.. All rights reserved.