org.everit.atlassian.restclient.jiracloud.v3.api

Class IssueRemoteLinksApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.IssueRemoteLinksApi

public class IssueRemoteLinksApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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	deleteRemoteIssueLinkByGlobalId(String issueIdOrKey, 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<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<Object>	updateRemoteIssueLink(String issueIdOrKey, String linkId, RemoteIssueLinkRequest requestBody, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update remote issue link by ID Updates a remote issue link for an issue.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueRemoteLinksApi

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

Method Detail

createOrUpdateRemoteIssueLink

public 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. 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](https://confluence.atlassian.com/x/yoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Link 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<RemoteIssueLinkIdentifies>

deleteRemoteIssueLinkByGlobalId

public io.reactivex.Completable deleteRemoteIssueLinkByGlobalId(String issueIdOrKey,
                                                                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. Where the global ID includes reserved URL characters these must be escaped in the request. For example, pass `system=http://www.mycompany.com/support&id=1` as `system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1`. This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Link 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 implemented, issue-level security permission to view the issue.

Parameters:

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

globalId - The global 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.

Returns:

Completable

deleteRemoteIssueLinkById

public 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. This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects*, *Edit issues*, and *Link 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)

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.

Returns:

Completable

getRemoteIssueLinkById

public 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. This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM). 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)

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.

Returns:

Single<RemoteIssueLink>

getRemoteIssueLinks

public 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. When a remote issue link global ID is provided the record with that global ID is returned, otherwise all remote issue links are returned. Where a global ID includes reserved URL characters these must be escaped in the request. For example, pass `system=http://www.mycompany.com/support&id=1` as `system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1`. This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM). 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)

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.

Returns:

Single<RemoteIssueLink>

updateRemoteIssueLink

public io.reactivex.Single<Object> updateRemoteIssueLink(String issueIdOrKey,
                                                         String linkId,
                                                         RemoteIssueLinkRequest requestBody,
                                                         Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update remote issue link by ID 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](https://confluence.atlassian.com/x/yoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Link 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)

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.

Returns:

Single<Object>