Class IssueRemoteLinksService

This resource represents remote issue links, a way of linking Jira to information in other systems. Use it to get, create, update, and delete remote issue links either by ID or global ID. The global ID provides a way of accessing remote issue links using information about the item's remote system host and remote system identifier.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-remote-links

Hierarchy

CommonHttpService
- IssueRemoteLinksService

Index

Constructors

constructor

Methods

createOrUpdateRemoteIssueLink deleteRemoteIssueLinkByGlobalId deleteRemoteIssueLinkById getRemoteIssueLinkById getRemoteIssueLinks updateRemoteIssueLink initialize

Constructors

constructor

new IssueRemoteLinksService(getClientInstance): IssueRemoteLinksService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns IssueRemoteLinksService
Inherited from CommonHttpService.constructor

Methods

createOrUpdateRemoteIssueLink

createOrUpdateRemoteIssueLink(params): Promise<{
created: boolean;
remoteIssueLinkIdentifies: RemoteIssueLinkIdentifies;
}>
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.
Parameters
- params: {
  issueIdOrKey: string;
  remoteIssueLinkRequest: RemoteIssueLinkRequest;
  }
  - issueIdOrKey: string
    The ID or key of the issue.
  - remoteIssueLinkRequest: RemoteIssueLinkRequest
    Example
Returns Promise<{
created: boolean;
remoteIssueLinkIdentifies: RemoteIssueLinkIdentifies;
}>
- status: 200, mediaType: application/json
  
  Returned if the remote issue link is updated.
  
  example:
```
{
  "id": 10000,
  "self": "https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000"
}
```
- status: 201, mediaType: application/json
  
  Returned if the remote issue link is created.
  
  example:
```
{
  "id": 10000,
  "self": "https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000"
}
```
Path
POST /rest/api/3/issue/{issueIdOrKey}/remotelink @scopes-current write:jira-work @scopes-beta write:issue:jira, write:issue.remote-link:jira, read:issue.remote-link:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-remote-links#api-rest-api-3-issue-issueidorkey-remotelink-post

deleteRemoteIssueLinkByGlobalId

deleteRemoteIssueLinkByGlobalId(params): Promise<void>
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.

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 implemented, issue-level security permission to view the issue.
Parameters
- params: {
  globalId: string;
  issueIdOrKey: string;
  }
  - globalId: string
    The global ID of a remote issue link.
  - issueIdOrKey: string
    The ID or key of the issue.
Returns Promise<void>
Path
DELETE /rest/api/3/issue/{issueIdOrKey}/remotelink @scopes-current write:jira-work @scopes-beta delete:issue.remote-link:jira, write:issue:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-remote-links#api-rest-api-3-issue-issueidorkey-remotelink-delete

deleteRemoteIssueLinkById

deleteRemoteIssueLinkById(params): Promise<void>
Deletes a remote issue link from an issue.

This operation requires issue linking to be active.

This operation can be accessed anonymously.

Permissions required:
- Browse projects, Edit issues, 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.
Parameters
- params: {
  issueIdOrKey: string;
  linkId: string;
  }
  - issueIdOrKey: string
    The ID or key of the issue.
  - linkId: string
    The ID of a remote issue link.
Returns Promise<void>
Path
DELETE /rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId} @scopes-current write:jira-work @scopes-beta delete:issue.remote-link:jira, write:issue:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-remote-links#api-rest-api-3-issue-issueidorkey-remotelink-linkid-delete

getRemoteIssueLinkById

getRemoteIssueLinkById(params): Promise<RemoteIssueLink>

Returns a remote issue link for an issue.

This operation requires issue linking to be active.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

params: {
issueIdOrKey: string;
linkId: string;
}
- issueIdOrKey: string
  The ID or key of the issue.
- linkId: string
  The ID of the remote issue link.

Returns Promise<RemoteIssueLink>

Returned if the request is successful.

example:

{
  "application": {
    "name": "My Acme Tracker",
    "type": "com.acme.tracker"
  },
  "globalId": "system=http://www.mycompany.com/support&id=1",
  "id": 10000,
  "object": {
    "icon": {
      "title": "Support Ticket",
      "url16x16": "http://www.mycompany.com/support/ticket.png"
    },
    "status": {
      "icon": {
        "link": "http://www.mycompany.com/support?id=1&details=closed",
        "title": "Case Closed",
        "url16x16": "http://www.mycompany.com/support/resolved.png"
      },
      "resolved": true
    },
    "summary": "Customer support issue",
    "title": "TSTSUP-111",
    "url": "http://www.mycompany.com/support?id=1"
  },
  "relationship": "causes",
  "self": "https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000"
}

Path

GET /rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId} @scopes-current read:jira-work @scopes-beta read:issue.remote-link:jira, read:status:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-remote-links#api-rest-api-3-issue-issueidorkey-remotelink-linkid-get

getRemoteIssueLinks

getRemoteIssueLinks(params): Promise<RemoteIssueLink>

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.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

params: {
globalId?: string;
issueIdOrKey: string;
}
- OptionalglobalId?: string
  The global ID of the remote issue link.
- issueIdOrKey: string
  The ID or key of the issue.

Returns Promise<RemoteIssueLink>

Returned if the request is successful.

example:

[
  {
    "application": {
      "name": "My Acme Tracker",
      "type": "com.acme.tracker"
    },
    "globalId": "system=http://www.mycompany.com/support&id=1",
    "id": 10000,
    "object": {
      "icon": {
        "title": "Support Ticket",
        "url16x16": "http://www.mycompany.com/support/ticket.png"
      },
      "status": {
        "icon": {
          "link": "http://www.mycompany.com/support?id=1&details=closed",
          "title": "Case Closed",
          "url16x16": "http://www.mycompany.com/support/resolved.png"
        },
        "resolved": true
      },
      "summary": "Customer support issue",
      "title": "TSTSUP-111",
      "url": "http://www.mycompany.com/support?id=1"
    },
    "relationship": "causes",
    "self": "https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000"
  },
  {
    "application": {
      "name": "My Acme Tester",
      "type": "com.acme.tester"
    },
    "globalId": "system=http://www.anothercompany.com/tester&id=1234",
    "id": 10001,
    "object": {
      "icon": {
        "title": "Test Case",
        "url16x16": "http://www.anothercompany.com/tester/images/testcase.gif"
      },
      "status": {
        "icon": {
          "link": "http://www.anothercompany.com/tester/person?accountId=5b10a2844c20165700ede21g",
          "title": "Tested by Mia Krystof",
          "url16x16": "http://www.anothercompany.com/tester/images/person/mia.gif"
        },
        "resolved": false
      },
      "summary": "Test that the submit button saves the item",
      "title": "Test Case #1234",
      "url": "http://www.anothercompany.com/tester/testcase/1234"
    },
    "relationship": "is tested by",
    "self": "https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10001"
  }
]

Path

GET /rest/api/3/issue/{issueIdOrKey}/remotelink @scopes-current read:jira-work @scopes-beta read:issue.remote-link:jira, read:status:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-remote-links#api-rest-api-3-issue-issueidorkey-remotelink-get

updateRemoteIssueLink

updateRemoteIssueLink(params): Promise<void>
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:
- 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.
Parameters
- params: {
      issueIdOrKey: string;
      linkId: string;
      remoteIssueLinkRequest: RemoteIssueLinkRequest;
  }
  - issueIdOrKey: string
    The ID or key of the issue.
  - linkId: string
    The ID of the remote issue link.
  - remoteIssueLinkRequest: RemoteIssueLinkRequest
    Example
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId} @scopes-current write:jira-work @scopes-beta write:issue:jira, write:issue.remote-link:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-remote-links#api-rest-api-3-issue-issueidorkey-remotelink-linkid-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class IssueRemoteLinksService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns IssueRemoteLinksService

Methods

createOrUpdateRemoteIssueLink

Parameters

issueIdOrKey: string

remoteIssueLinkRequest: RemoteIssueLinkRequest

Example

Returns Promise<{ created: boolean; remoteIssueLinkIdentifies: RemoteIssueLinkIdentifies; }>

Path

See

deleteRemoteIssueLinkByGlobalId

Parameters

globalId: string

issueIdOrKey: string

Returns Promise<void>

Path

See

deleteRemoteIssueLinkById

Parameters

issueIdOrKey: string

linkId: string

Returns Promise<void>

Path

See

getRemoteIssueLinkById

Parameters

issueIdOrKey: string

linkId: string

Returns Promise<RemoteIssueLink>

Path

See

getRemoteIssueLinks

Parameters

OptionalglobalId?: string

issueIdOrKey: string

Returns Promise<RemoteIssueLink>

Path

See

updateRemoteIssueLink

Parameters

issueIdOrKey: string

linkId: string

remoteIssueLinkRequest: RemoteIssueLinkRequest

Example

Returns Promise<void>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

Returns Promise<{
created: boolean;
remoteIssueLinkIdentifies: RemoteIssueLinkIdentifies;
}>

`Optional`globalId?: string

`Protected` `Static`initialize