Class RemoteLinksService

APIs related to integrating remote link data with Jira Software.

These APIs are available to Atlassian Connect apps. To use these APIs you must have the jiraRemoteLinkInfoProvider module in your Connect app's descriptor. See https://developer.atlassian.com/cloud/jira/software/modules/remote-link/.

These APIs are available to Forge apps with the devops:remoteLinkInfoProvider module in the Forge app's manifest. See https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-software-remote-link-info/.

See

https://developer.atlassian.com/cloud/jira/software/rest/api-group-remote-links

Hierarchy

  • CommonHttpService
    • RemoteLinksService

Constructors

constructor

Methods

deleteRemoteLinkById deleteRemoteLinksByProperty getRemoteLinkById submitRemoteLinks initialize

Constructors

constructor

  • new RemoteLinksService(getClientInstance): RemoteLinksService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns RemoteLinksService

Methods

deleteRemoteLinkById

  • deleteRemoteLinkById(params): Promise<void>

  • Delete the Remote Link data currently stored for the given ID.

    Deletion is performed asynchronously. The getRemoteLinkById operation can be used to confirm that data has been deleted successfully (if needed).

    Parameters

    • params: {
          authorization: string;
          remoteLinkId: string;
          updateSequenceNumber?: number;
      }
      • authorization: string

        All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.

        If the Connect JWT token corresponds to an app that does not define jiraRemoteLinkInfoProvider module it will be rejected with a 403.

        See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.

      • remoteLinkId: string

        The ID of the Remote Link to fetch.

      • OptionalupdateSequenceNumber?: number

        This parameter usage is no longer supported.

        An optional _updateSequenceNumber to use to control deletion.

        Only stored data with an updateSequenceNumber less than or equal to that provided will be deleted. This can be used help ensure submit/delete requests are applied correctly if issued close together.

        Deprecated

    Returns Promise<void>

    Path

    DELETE /rest/remotelinks/1.0/remotelink/{remoteLinkId}

    See

    https://developer.atlassian.com/cloud/jira/software/rest/api-group-remote-links#api-rest-remotelinks-1-0-remotelink-remotelinkid-delete

deleteRemoteLinksByProperty

  • deleteRemoteLinksByProperty(params): Promise<void>

  • Bulk delete all Remote Links data that match the given request.

    One or more query params must be supplied to specify Properties to delete by. Optional param _updateSequenceNumber is no longer supported. If more than one Property is provided, data will be deleted that matches ALL of the Properties (e.g. treated as an AND).

    See the documentation for the submitRemoteLinks operation for more details.

    e.g. DELETE /bulkByProperties?accountId=account-123&repoId=repo-345

    Deletion is performed asynchronously. The getRemoteLinkById operation can be used to confirm that data has been deleted successfully (if needed).

    Parameters

    • params: {
          authorization: string;
          params?: {
              [key: string]: unknown;
          };
          updateSequenceNumber?: number;
      }
      • authorization: string

        All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.

        If the Connect JWT token corresponds to an app that does not define jiraRemoteLinkInfoProvider module it will be rejected with a 403.

        See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.

      • Optionalparams?: {
            [key: string]: unknown;
        }

        Free-form query parameters to specify which properties to delete by. Properties refer to the arbitrary information the provider tagged Remote Links with previously.

        For example, if the provider previously tagged a remote link with accountId:

        "properties": {
          "accountId": "account-123"
        }

        And now they want to delete Remote Links in bulk by that specific accountId as follows: e.g. DELETE /bulkByProperties?accountId=account-123

        • [key: string]: unknown
      • OptionalupdateSequenceNumber?: number

        This parameter usage is no longer supported.

        An optional _updateSequenceNumber to use to control deletion.

        Only stored data with an updateSequenceNumber less than or equal to that provided will be deleted. This can be used help ensure submit/delete requests are applied correctly if issued close together.

        If not provided, all stored data that matches the request will be deleted.

        Deprecated

    Returns Promise<void>

    Path

    DELETE /rest/remotelinks/1.0/bulkByProperties

    See

    https://developer.atlassian.com/cloud/jira/software/rest/api-group-remote-links#api-rest-remotelinks-1-0-bulkbyproperties-delete

getRemoteLinkById

submitRemoteLinks

  • submitRemoteLinks(params): Promise<{
        acceptedRemoteLinks?: string[];
        rejectedRemoteLinks?: {
            [key: string]: ({
                errorTraceId?: string;
                message: string;
            } & {
                [key: string]: unknown;
            })[];
        };
        unknownAssociations?: (IssueIdOrKeysAssociation | ServiceIdOrKeysAssociation)[];
    } & {
        [key: string]: unknown;
    }>

  • Update / insert Remote Link data.

    Remote Links are identified by their ID, existing Remote Link data for the same ID will be replaced if it exists and the updateSequenceId of existing data is less than the incoming data.

    Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are available within a short period of time, but may take some time during peak load and/or maintenance times. The getRemoteLinkById operation can be used to confirm that data has been stored successfully (if needed).

    In the case of multiple Remote Links being submitted in one request, each is validated individually prior to submission. Details of which Remote LInk failed submission (if any) are available in the response object.

    Parameters

    Returns Promise<{
        acceptedRemoteLinks?: string[];
        rejectedRemoteLinks?: {
            [key: string]: ({
                errorTraceId?: string;
                message: string;
            } & {
                [key: string]: unknown;
            })[];
        };
        unknownAssociations?: (IssueIdOrKeysAssociation | ServiceIdOrKeysAssociation)[];
    } & {
        [key: string]: unknown;
    }>

    Submission accepted. Each submitted Remote Link that is of a valid format will be eventually available in Jira.

    Details of which Remote Links were submitted and which failed submission (due to data format problems etc.) are available in the response object.

    Path

    POST /rest/remotelinks/1.0/bulk

    See

    https://developer.atlassian.com/cloud/jira/software/rest/api-group-remote-links#api-rest-remotelinks-1-0-bulk-post

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods