public class IssueApi extends Object
| Constructor and Description |
|---|
IssueApi(org.everit.http.restclient.RestClient restClient) |
| Modifier and Type | Method and Description |
|---|---|
io.reactivex.Single<Object> |
addVote(String issueIdOrKey,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Add vote
Adds the user's vote to an issue.
|
io.reactivex.Single<Object> |
addWatcher(String issueIdOrKey,
String body,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Add watcher
Adds a user as a watcher of an issue by passing the account ID of the user.
|
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.Single<RemoteIssueLinkIdentifies> |
createOrUpdateRemoteIssueLink(String issueIdOrKey,
RemoteIssueLinkRequest requestBody,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Create or update remote issue link
Creates or updates a remote issue link for an issue.
|
io.reactivex.Completable |
deleteIssue(String issueIdOrKey,
Optional<String> deleteSubtasks,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Delete issue
Deletes an issue.
|
io.reactivex.Completable |
deleteRemoteIssueLinkByGlobalId(String issueIdOrKey,
Optional<String> globalId,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Delete remote issue link by global id
Deletes the remote issue link from the issue using the link's global ID.
|
io.reactivex.Completable |
deleteRemoteIssueLinkById(String issueIdOrKey,
String linkId,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Delete remote issue link by id
Deletes a remote issue link from 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<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<IssuePickerSuggestions> |
getIssuePickerResource(Optional<String> query,
Optional<String> currentJQL,
Optional<String> currentIssueKey,
Optional<String> currentProjectId,
Optional<Boolean> showSubTasks,
Optional<Boolean> showSubTaskParent,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get issue picker suggestions
Returns lists of issues matching a query string.
|
io.reactivex.Single<Watchers> |
getIssueWatchers(String issueIdOrKey,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get issue watchers
Returns the watchers for an issue.
|
io.reactivex.Single<RemoteIssueLink> |
getRemoteIssueLinkById(String issueIdOrKey,
String linkId,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get remote issue link by id
Returns a remote issue link for an issue.
|
io.reactivex.Single<RemoteIssueLink> |
getRemoteIssueLinks(String issueIdOrKey,
Optional<String> globalId,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get remote issue links
Returns the remote issue links for an issue.
|
io.reactivex.Single<Transitions> |
getTransitions(String issueIdOrKey,
Optional<String> expand,
Optional<String> transitionId,
Optional<Boolean> skipRemoteOnlyCondition,
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<Votes> |
getVotes(String issueIdOrKey,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Get votes
Returns details about the votes on an issue.
|
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.
|
io.reactivex.Completable |
removeVote(String issueIdOrKey,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Delete vote
Deletes a user's vote from an issue.
|
io.reactivex.Completable |
removeWatcher(String issueIdOrKey,
Optional<String> username,
Optional<String> accountId,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Delete watcher
Deletes a user as a watcher of an issue.
|
io.reactivex.Single<Object> |
updateRemoteIssueLink(String issueIdOrKey,
String linkId,
RemoteIssueLinkRequest requestBody,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Update remote issue link
Updates a remote issue link for an issue.
|
public io.reactivex.Single<Object> addVote(String issueIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Adds the user's vote to an issue. This is the equivalent of the user clicking Vote on an issue in Jira.
This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.
Permissions required:
issueIdOrKey - The ID or key of the issue.
(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> addWatcher(String issueIdOrKey, String body, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Adds a user as a watcher of an issue by passing the account ID of the user. For example, "384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192". If no user is specified the calling user is added.
This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.
Permissions required:
issueIdOrKey - The ID or key of the issue.
(required)body - The account ID of the user. Note that username cannot be used due to privacy changes.
(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> assignIssue(String issueIdOrKey, User user, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
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 required:
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)
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. These are the same fields that appear on the issue's create screen. Note that the description, environment, and any textarea type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (textfield) accept a string and don't handle Atlassian Document Format content.
Creating a subtask differs from creating an issue as follows:
issueType must be set to a subtask issue type (use Get create issue metadata to find subtask issue types).parent MUST contain the ID or key of the parent issue.A parent MAY be supplied for any issue provided both parent and child are members of the same next-gen project. In a classic project the parent field is only valid for subtasks.
Permissions required: Browse projects and Create issues project permissions for the project in which the issue or subtask is created.
requestBody - (required)updateHistory - Indicates 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)
Creates 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. These are the same fields that appear on the issues' create screens. Note that the description, environment, and any textarea type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (textfield) accept a string and don't handle Atlassian Document Format content.
Creating a subtask differs from creating an issue as follows:
issueType must be set to a subtask issue type (use Get create issue metadata to find subtask issue types).parent the must contain the ID or key of the parent issue.Permissions required: Browse projects and Create issues project permissions for the project in which each issue or subtask is created.
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<RemoteIssueLinkIdentifies> createOrUpdateRemoteIssueLink(String issueIdOrKey, RemoteIssueLinkRequest requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Creates or updates a remote issue link for an issue.
If a globalId is provided and a remote issue link with that global ID is found it is updated. Any fields without values in the request are set to null. Otherwise, the remote issue link is created.
This operation requires issue linking to be active.
This operation can be accessed anonymously.
Permissions required:
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.Completable deleteIssue(String issueIdOrKey, Optional<String> deleteSubtasks, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
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 required:
issueIdOrKey - The ID or key of the issue.
(required)deleteSubtasks - Indicates 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.Completable deleteRemoteIssueLinkByGlobalId(String issueIdOrKey, Optional<String> globalId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Deletes the remote issue link from the issue using the link's global ID.
This operation requires issue linking to be active.
This operation can be accessed anonymously.
Permissions required:
issueIdOrKey - The ID or key of the issue.
(required)globalId - The global ID of a remote issue link.
(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.Completable deleteRemoteIssueLinkById(String issueIdOrKey, String linkId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Deletes a remote issue link from an issue.
This operation requires issue linking to be active.
This operation can be accessed anonymously.
Permissions required:
issueIdOrKey - The ID or key of the issue.
(required)linkId - The ID of a remote issue link.
(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> doTransition(String issueIdOrKey, IssueUpdateDetails requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.
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 with the transitions.fields expand.
This operation can be accessed anonymously.
Permissions required:
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)
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. Note that the description, environment, and any textarea type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (textfield) accept a string and don't handle Atlassian Document Format content.
Connect app users with admin permissions (from user permissions and app scopes) can override the screen security configuration using overrideScreenSecurity and overrideEditableFlag.
This operation can be accessed anonymously.
Permissions required:
issueIdOrKey - The ID or key of the issue.
(required)requestBody - (required)notifyUsers - Indicates 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 - Indicates 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 - Indicates 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<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)
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 and Create issues.
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 required: Create issues project permission in the requested projects.
projectIds - Comma-separated list of project IDs. This parameter may be specified multiple times. For example, projectIds=10000,10001&projectIds=10020,10021. This parameter may be provided with projectKeys.
projectKeys - Comma-separated list of project keys. This parameter may be specified multiple times. For example, projectKeys=proj1,proj2&projectKeys=proj3. This parameter may be provided with projectIds.
issuetypeIds - Comma-separated list of issue type IDs. This parameter may be specified multiple times. For example, issuetypeIds=10000,10001&issuetypeIds=10020,10021. This parameter may be provided with issuetypeNames.
issuetypeNames - Comma-separated list of issue type names. This parameter may be specified multiple times. For example, issuetypeNames=name1,name2&issuetypeNames=name3. This parameter may be provided with issuetypeIds.
expand - Use expand 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 and Create issues.
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)
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.
Connect app users with admin permissions (from user permissions and app scopes) can return additional details using:
overrideScreenSecurity Returns hidden fields.overrideEditableFlag Returns uneditable fields. For example, where an issue has a workflow status of closed none of its fields are editable.This operation can be accessed anonymously.
Permissions required:
Note: For any fields to be editable the user must have the Edit issues project permission for the issue.
issueIdOrKey - The ID or key of the issue.
(required)overrideScreenSecurity - Indicates whether hidden fields should be returned. Available to connect app users with admin permissions.
(optional, default to false)overrideEditableFlag - Indicates 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)
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 required:
issueIdOrKey - The ID or key of the issue.
(required)fields - A comma-separated list of fields to return for the issue. Use it to retrieve a subset of fields. Allowed values:
*all Returns all fields.*navigable Returns navigable fields.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) and Search for issues using JQL (POST) where the default is all navigable fields.
(optional, default to new ArrayList<>())fieldsByKeys - Indicates 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.
expand - Use expand to include additional information about the issues in the response. This parameter accepts multiple values separated by a comma:
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.properties - A comma-separated list of issue properties to return for the issue. Allowed values:
*all Returns all issue properties.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.
updateHistory - Indicates 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 lastViewed field.
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<IssuePickerSuggestions> getIssuePickerResource(Optional<String> query, Optional<String> currentJQL, Optional<String> currentIssueKey, Optional<String> currentProjectId, Optional<Boolean> showSubTasks, Optional<Boolean> showSubTaskParent, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.
This operation returns two lists:
History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.This operation can be accessed anonymously.
Permissions required: None.
query - A string to match against text fields in the issue such as title, description, or comments.
(optional)currentJQL - A JQL query defining a list of issues to search for the query term. Note that username and userkey cannot be used as search terms for this parameter, due to privacy reasons. Use accountId instead.
currentIssueKey - The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.
(optional)currentProjectId - The ID of a project that suggested issues must belong to.
(optional)showSubTasks - Indicate whether to include subtasks in the suggestions list.
(optional)showSubTaskParent - When currentIssueKey is a subtask, indicates whether to include the parent issue in the suggestions if it matches the query.
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<Watchers> getIssueWatchers(String issueIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Returns the watchers for an issue.
This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.
This operation can be accessed anonymously.
Permissions required:
issueIdOrKey - The ID or key of the issue.
(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<RemoteIssueLink> getRemoteIssueLinkById(String issueIdOrKey, String linkId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Returns a remote issue link for an issue.
This operation requires issue linking to be active.
This operation can be accessed anonymously.
Permissions required:
issueIdOrKey - The ID or key of the issue.
(required)linkId - The ID of the remote issue link.
(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<RemoteIssueLink> getRemoteIssueLinks(String issueIdOrKey, Optional<String> globalId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Returns the remote issue links for an issue. When a remote issue link global ID is provided the record with that global ID is returned, otherwise all remote issue links are returned.
This operation requires issue linking to be active.
This operation can be accessed anonymously.
Permissions required:
issueIdOrKey - The ID or key of the issue.
(required)globalId - The global ID of the remote issue link.
(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<Transitions> getTransitions(String issueIdOrKey, Optional<String> expand, Optional<String> transitionId, Optional<Boolean> skipRemoteOnlyCondition, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
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 required: A list or transition is returned only when the user has:
However, if the user does not have the Transition issues project permission the response will not list any transitions.
issueIdOrKey - The ID or key of the issue.
(required)expand - Use expand 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.
transitionId - The ID of the transition.
(optional)skipRemoteOnlyCondition - Indicates whether transitions with the condition Hide From User Condition are included in the response.
(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<Votes> getVotes(String issueIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Returns details about the votes on an issue.
This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.
This operation can be accessed anonymously.
Permissions required:
Note that users with the necessary permissions for this operation but without the View voters and watchers project permissions are not returned details in the voters field.
issueIdOrKey - The ID or key of the issue.
(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> notify(String issueIdOrKey, Notification requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Creates an email notification for an issue and adds it to the mail queue.
Permissions required:
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.
public io.reactivex.Completable removeVote(String issueIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Deletes a user's vote from an issue. This is the equivalent of the user clicking Unvote on an issue in Jira.
This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.
Permissions required:
issueIdOrKey - The ID or key of the issue.
(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 removeWatcher(String issueIdOrKey, Optional<String> username, Optional<String> accountId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Deletes a user as a watcher of an issue.
This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.
Permissions required:
issueIdOrKey - The ID or key of the issue.
(required)username - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
(optional)accountId - The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.
(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<Object> updateRemoteIssueLink(String issueIdOrKey, String linkId, RemoteIssueLinkRequest requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Updates a remote issue link for an issue.
Note: Fields without values in the request are set to null.
This operation requires issue linking to be active.
This operation can be accessed anonymously.
Permissions required:
issueIdOrKey - The ID or key of the issue.
(required)linkId - The ID of the remote issue link.
(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.
Copyright © 2011–2021 Everit Kft.. All rights reserved.