POST /rest/api/2/issue/{issueIdOrKey}/remotelink
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:
- Browse projects and Link issues project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Servers
- https://your-domain.atlassian.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
issueIdOrKey |
String | Yes |
The ID or key of the issue. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
globalId |
String | No |
An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: Setting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID. The maximum length is 255 characters. |
relationship |
String | No |
Description of the relationship between the issue and the linked item. If not set, the relationship description "links to" is used in Jira. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.