ATatlassian
Remote Links

Submit Remote Link data

Changed on

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.

post/rest/remotelinks/1.0/bulk

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/remotelinks/1.0/bulk
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: write:remote-link-info:jira

Request body

propertiesobject

Properties assigned to Remote Link data that can then be used for delete / query operations.

Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system.

Properties are supplied as key/value pairs, a maximum of 5 properties can be supplied, and keys must not contain ':' or start with '_'.

Example request

{
  "properties": {
    "accountId": "account-234",
    "projectId": "project-123"
  },
  "remoteLinks": [
    {
      "schemaVersion": "1.0",
      "id": "111-222-333",
      "updateSequenceNumber": 1523494301448,
      "displayName": "Remote Link #42",
      "type": "security",
      "description": "Remote Link #42 with more information in this description",
      "lastUpdated": "2018-01-20T23:27:25.000Z",
      "associations": [
        {
          "associationType": "issueIdOrKeys",
          "values": [
            "ABC-123",
            "ABC-456"
          ]
        }
      ],
      "status": {
        "appearance": "inprogress",
        "label": "ANOMALOUS"
      },
      "actionIds": [
        "action-111-222-333",
        "action-444-555-666"
      ]
    }
  ],
  "providerMetadata": {
    "product": "Opsgenie 6.10.2"
  }
}

Response

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.

acceptedRemoteLinksstring[]

The IDs of Remote Links that have been accepted for submission.

A Remote Link may be rejected if it was only associated with unknown issue keys, unknown service IDs, or if the submitted data for that Remote Link does not match the required schema.

Note that a Remote Link that isn't updated due to it's updateSequenceNumber being out of order is not considered a failed submission.

rejectedRemoteLinksobject

Details of Remote Links that have not been accepted for submission, usually due to a problem with the request data.

A Remote Link may be rejected if it was only associated with unknown issue keys, unknown service IDs, or if the submitted data for the Remote Link does not match the required schema.

The object (if present) will be keyed by Remote Link ID and include any errors associated with that Remote Link that have prevented it being submitted.

Example response

{
  "acceptedRemoteLinks": [
    "111-222-333",
    "444-555-666"
  ],
  "unknownAssociations": [
    {
      "associationType": "issueIdOrKeys",
      "values": [
        "ABC-123",
        "ABC-456"
      ]
    }
  ]
}

Changes

  • 4e108d54b990Revision changes
    • breaking

      removed subschema #1: IssueKeysAssociation from the /// request property anyOf list

    • info

      the endpoint scheme security OAuth2 was added to the API

    • info

      the endpoint scheme security basicAuth was added to the API

    • info

      added to the /// request property anyOf list

    • info

      added to the / response property anyOf list for the response status

    • info

      removed subschema #1: IssueKeysAssociation from the / response property anyOf list for the response status

  • ac057c9cf7e5Revision changes
    • info

      endpoint added