org.everit.atlassian.restclient.jiracloud.v2.api

Class IssuesApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.api.IssuesApi

public class IssuesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
IssuesApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<IssueArchivalSyncResponse>	archiveIssues(IssueArchivalSyncRequest issueArchivalSyncRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Archive issue(s) by issue ID/key Enables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) archived in the process and the errors encountered, if any.
io.reactivex.Single<String>	archiveIssuesAsync(ArchiveIssueAsyncRequest archiveIssueAsyncRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Archive issue(s) by JQL Enables admins to archive up to 100,000 issues in a single request using JQL, returning the URL to check the status of the submitted request.
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(Map<String,Object> 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(Map<String,Object> requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Bulk create issue Creates upto **50** 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, Map<String,Object> 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, Map<String,Object> requestBody, Optional<Boolean> notifyUsers, Optional<Boolean> overrideScreenSecurity, Optional<Boolean> overrideEditableFlag, Optional<Boolean> returnIssue, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Edit issue Edits an issue.
io.reactivex.Single<ExportArchivedIssuesTaskProgressResponse>	exportArchivedIssues(Map<String,Object> requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Export archived issue(s) Enables admins to retrieve details of all archived issues.
io.reactivex.Single<PageBeanChangelog>	getChangeLogs(String issueIdOrKey, Optional<Integer> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get changelogs Returns a [paginated](#pagination) list of all changelogs for an issue sorted by date, starting from the oldest.
io.reactivex.Single<PageOfChangelogs>	getChangeLogsByIds(String issueIdOrKey, IssueChangelogIds issueChangelogIds, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get changelogs by IDs Returns changelogs for an issue specified by a list of changelog IDs.
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<PageOfCreateMetaIssueTypes>	getCreateIssueMetaIssueTypes(String projectIdOrKey, Optional<Integer> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get create metadata issue types for a project Returns a page of issue type metadata for a specified project.
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<List<IssueEvent>>	getEvents(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get events Returns all issue events.
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, Map<String,Object> 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.
io.reactivex.Single<IssueArchivalSyncResponse>	unarchiveIssues(IssueArchivalSyncRequest issueArchivalSyncRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Unarchive issue(s) by issue keys/ID Enables admins to unarchive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) unarchived in the process and the errors encountered, if any.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IssuesApi

public IssuesApi(org.everit.http.restclient.RestClient restClient)

Method Detail

archiveIssues

public io.reactivex.Single<IssueArchivalSyncResponse> archiveIssues(IssueArchivalSyncRequest issueArchivalSyncRequest,
                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Archive issue(s) by issue ID/key Enables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) archived in the process and the errors encountered, if any. **Note that:** * you can't archive subtasks directly, only through their parent issues * you can only archive issues from software, service management, and business projects **[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg) **License required:** Premium or Enterprise **Signed-in users only:** This API can't be accessed anonymously.

Parameters:

issueArchivalSyncRequest - Contains a list of issue keys or IDs to be archived. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<IssueArchivalSyncResponse>

archiveIssuesAsync

public io.reactivex.Single<String> archiveIssuesAsync(ArchiveIssueAsyncRequest archiveIssueAsyncRequest,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Archive issue(s) by JQL Enables admins to archive up to 100,000 issues in a single request using JQL, returning the URL to check the status of the submitted request. You can use the [get task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get) and [cancel task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-cancel-post) APIs to manage the request. **Note that:** * you can't archive subtasks directly, only through their parent issues * you can only archive issues from software, service management, and business projects **[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg) **License required:** Premium or Enterprise **Signed-in users only:** This API can't be accessed anonymously. **Rate limiting:** Only a single request per user can be active at any given time.

Parameters:

archiveIssueAsyncRequest - A JQL query specifying the issues to archive. Note that subtasks can only be archived through their parent issues. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<String>

assignIssue

public io.reactivex.Single<Object> assignIssue(String issueIdOrKey,
                                               User user,
                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Assign issue Assigns an issue to a user. Use this operation when the calling user does not have the *Edit Issues* permission but has the *Assign issue* permission for the project that the issue is in. If `name` or `accountId` is set to: * `\"-1\"`, the issue is assigned to the default assignee for the project. * `null`, the issue is set to unassigned. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse Projects* and *Assign Issues* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.

Parameters:

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.

Returns:

Single<Object>

createIssue

public io.reactivex.Single<CreatedIssue> createIssue(Map<String,Object> 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. A transition may be applied, to move the issue or subtask to a workflow step other than the default start step, and issue properties set. The content of the issue or subtask is defined using `update` and `fields`. The fields that can be set in the issue or subtask are determined using the [ Get create issue metadata](#api-rest-api-2-issue-createmeta-get). These are the same fields that appear on the issue's create screen. Creating a subtask differs from creating an issue as follows: * `issueType` must be set to a subtask issue type (use [ Get create issue metadata](#api-rest-api-2-issue-createmeta-get) to find subtask issue types). * `parent` must contain the ID or key of the parent issue. **[Permissions](#permissions) required:** *Browse projects* and *Create issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project in which the issue or subtask is created.

Parameters:

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. When provided, the issue type and request type are added to the user's history for a project. These values are then used to provide defaults on the issue create screen. (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.

Returns:

Single<CreatedIssue>

createIssues

public io.reactivex.Single<CreatedIssues> createIssues(Map<String,Object> requestBody,
                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Bulk create issue Creates upto **50** issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue properties set. The content of each issue or subtask is defined using `update` and `fields`. The fields that can be set in the issue or subtask are determined using the [ Get create issue metadata](#api-rest-api-2-issue-createmeta-get). These are the same fields that appear on the issues' create screens. Creating a subtask differs from creating an issue as follows: * `issueType` must be set to a subtask issue type (use [ Get create issue metadata](#api-rest-api-2-issue-createmeta-get) to find subtask issue types). * `parent` the must contain the ID or key of the parent issue. **[Permissions](#permissions) required:** *Browse projects* and *Create issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project in which each issue or subtask is created.

Parameters:

requestBody - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<CreatedIssues>

deleteIssue

public io.reactivex.Completable deleteIssue(String issueIdOrKey,
                                            Optional<String> deleteSubtasks,
                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete issue Deletes an issue. An issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set `deleteSubtasks`. This causes the issue's subtasks to be deleted with the issue. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Delete issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.

Parameters:

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.

Returns:

Completable

doTransition

public io.reactivex.Single<Object> doTransition(String issueIdOrKey,
                                                Map<String,Object> 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. sortByCategory To update the fields on the transition screen, specify the fields in the `fields` or `update` parameters in the request body. Get details about the fields using [ Get transitions](#api-rest-api-2-issue-issueIdOrKey-transitions-get) with the `transitions.fields` expand. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Transition issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.

Parameters:

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.

Returns:

Single<Object>

editIssue

public io.reactivex.Single<Object> editIssue(String issueIdOrKey,
                                             Map<String,Object> requestBody,
                                             Optional<Boolean> notifyUsers,
                                             Optional<Boolean> overrideScreenSecurity,
                                             Optional<Boolean> overrideEditableFlag,
                                             Optional<Boolean> returnIssue,
                                             Optional<String> expand,
                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Edit issue Edits an issue. A transition may be applied and issue properties updated as part of the edit. The edits to the issue's fields are defined using `update` and `fields`. The fields that can be edited are determined using [ Get edit issue metadata](#api-rest-api-2-issue-issueIdOrKey-editmeta-get). The parent field may be set by key or ID. For standard issue types, the parent may be removed by setting `update.parent.set.none` to *true*. Connect apps having an app user with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), can override the screen security configuration using `overrideScreenSecurity` and `overrideEditableFlag`. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.

Parameters:

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 is overridden to enable hidden fields to be edited. Available to Connect app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, default to false)

overrideEditableFlag - Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, default to false)

returnIssue - Whether the response should contain the issue with fields edited in this request. The returned issue will have the same format as in the [Get issue API](#api-rest-api-3-issue-issueidorkey-get). (optional, default to false)

expand - The Get issue API expand parameter to use in the response if the `returnIssue` parameter is `true`. (optional, default to "")

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>

exportArchivedIssues

public io.reactivex.Single<ExportArchivedIssuesTaskProgressResponse> exportArchivedIssues(Map<String,Object> requestBody,
                                                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Export archived issue(s) Enables admins to retrieve details of all archived issues. Upon a successful request, the admin who submitted it will receive an email with a link to download a CSV file with the issue details. Note that this API only exports the values of system fields and archival-specific fields (`ArchivedBy` and `ArchivedDate`). Custom fields aren't supported. **[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg) **License required:** Premium or Enterprise **Signed-in users only:** This API can't be accessed anonymously. **Rate limiting:** Only a single request can be active at any given time.

Parameters:

requestBody - You can filter the issues in your request by the `projects`, `archivedBy`, `archivedDate`, `issueTypes`, and `reporters` fields. All filters are optional. If you don't provide any filters, you'll get a list of up to one million archived issues. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<ExportArchivedIssuesTaskProgressResponse>

getChangeLogs

public io.reactivex.Single<PageBeanChangelog> getChangeLogs(String issueIdOrKey,
                                                            Optional<Integer> startAt,
                                                            Optional<Integer> maxResults,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get changelogs Returns a [paginated](#pagination) list of all changelogs for an issue sorted by date, starting from the oldest. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.

Parameters:

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.

Returns:

Single<PageBeanChangelog>

getChangeLogsByIds

public io.reactivex.Single<PageOfChangelogs> getChangeLogsByIds(String issueIdOrKey,
                                                                IssueChangelogIds issueChangelogIds,
                                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get changelogs by IDs Returns changelogs for an issue specified by a list of changelog IDs. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.

Parameters:

issueIdOrKey - The ID or key of the issue. (required)

issueChangelogIds - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PageOfChangelogs>

getCreateIssueMeta

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)

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. Use the information to populate the requests in [ Create issue](#api-rest-api-2-issue-post) and [Create issues](#api-rest-api-2-issue-bulk-post). The request can be restricted to specific projects or issue types using the query parameters. The response will contain information for the valid projects, issue types, or project and issue type combinations requested. Note that invalid project, issue type, or project and issue type combinations do not generate errors. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects.

Parameters:

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.

Returns:

Single<IssueCreateMetadata>

getCreateIssueMetaIssueTypes

public io.reactivex.Single<PageOfCreateMetaIssueTypes> getCreateIssueMetaIssueTypes(String projectIdOrKey,
                                                                                    Optional<Integer> startAt,
                                                                                    Optional<Integer> maxResults,
                                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get create metadata issue types for a project Returns a page of issue type metadata for a specified project. Use the information to populate the requests in [ Create issue](#api-rest-api-2-issue-post) and [Create issues](#api-rest-api-2-issue-bulk-post). This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects.

Parameters:

projectIdOrKey - The ID or key of the project. (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 50)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PageOfCreateMetaIssueTypes>

getEditIssueMeta

public 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. Use the information to populate the requests in [Edit issue](#api-rest-api-2-issue-issueIdOrKey-put). This endpoint will check for these conditions: 1. Field is available on a field screen - through screen, screen scheme, issue type screen scheme, and issue type scheme configuration. `overrideScreenSecurity=true` skips this condition. 2. Field is visible in the [field configuration](https://support.atlassian.com/jira-cloud-administration/docs/change-a-field-configuration/). `overrideScreenSecurity=true` skips this condition. 3. Field is shown on the issue: each field has different conditions here. For example: Attachment field only shows if attachments are enabled. Assignee only shows if user has permissions to assign the issue. 4. If a field is custom then it must have valid custom field context, applicable for its project and issue type. All system fields are assumed to have context in all projects and all issue types. 5. Issue has a project, issue type, and status defined. 6. Issue is assigned to a valid workflow, and the current status has assigned a workflow step. `overrideEditableFlag=true` skips this condition. 7. The current workflow step is editable. This is true by default, but [can be disabled by setting](https://support.atlassian.com/jira-cloud-administration/docs/use-workflow-properties/) the `jira.issue.editable` property to `false`. `overrideEditableFlag=true` skips this condition. 8. User has [Edit issues permission](https://support.atlassian.com/jira-cloud-administration/docs/permissions-for-company-managed-projects/). 9. Workflow permissions allow editing a field. This is true by default but [can be modified](https://support.atlassian.com/jira-cloud-administration/docs/use-workflow-properties/) using `jira.permission.*` workflow properties. Fields hidden using [Issue layout settings page](https://support.atlassian.com/jira-software-cloud/docs/configure-field-layout-in-the-issue-view/) remain editable. Connect apps having an app user with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), can return additional details using: * `overrideScreenSecurity` When this flag is `true`, then this endpoint skips checking if fields are available through screens, and field configuration (conditions 1. and 2. from the list above). * `overrideEditableFlag` When this flag is `true`, then this endpoint skips checking if workflow is present and if the current step is editable (conditions 6. and 7. from the list above). This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Note: For any fields to be editable the user must have the *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the issue.

Parameters:

issueIdOrKey - The ID or key of the issue. (required)

overrideScreenSecurity - Whether hidden fields are returned. Available to Connect app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, default to false)

overrideEditableFlag - Whether non-editable fields are returned. Available to Connect app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (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.

Returns:

Single<IssueUpdateMetadata>

getEvents

public io.reactivex.Single<List<IssueEvent>> getEvents(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get events Returns all issue events. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<List<IssueEvent>>

getIssue

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)

Get issue Returns the details for an issue. The issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is **not** returned. The issue key returned in the response is the key of the issue found. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.

Parameters:

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.

Returns:

Single<IssueBean>

getTransitions

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)

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. Note, if a request is made for a transition that does not exist or cannot be performed on the issue, given its status, the response will return any empty transitions list. This operation can be accessed anonymously. **[Permissions](#permissions) required: A list or transition is returned only when the user has:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. However, if the user does not have the *Transition issues* [ project permission](https://confluence.atlassian.com/x/yodKLg) the response will not list any transitions.

Parameters:

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.

Returns:

Single<Transitions>

notify

public io.reactivex.Single<Object> notify(String issueIdOrKey,
                                          Map<String,Object> 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. **[Permissions](#permissions) required:** * *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.

Parameters:

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.

Returns:

Single<Object>

unarchiveIssues

public io.reactivex.Single<IssueArchivalSyncResponse> unarchiveIssues(IssueArchivalSyncRequest issueArchivalSyncRequest,
                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Unarchive issue(s) by issue keys/ID Enables admins to unarchive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) unarchived in the process and the errors encountered, if any. **Note that:** * you can't unarchive subtasks directly, only through their parent issues * you can only unarchive issues from software, service management, and business projects **[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg) **License required:** Premium or Enterprise **Signed-in users only:** This API can't be accessed anonymously.

Parameters:

issueArchivalSyncRequest - Contains a list of issue keys or IDs to be unarchived. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<IssueArchivalSyncResponse>