Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1310566642.9 KB
Remote Links

Get a Remote Link by ID

Retrieve the currently stored Remote Link data for the given ID.

The result will be what is currently stored, ignoring any pending updates or deletes.

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

Path parameters

remoteLinkIdstring required

The ID of the Remote Link to fetch.

Response

The Remote Link data currently stored for the given ID.

schemaVersion'1.0'

The schema version used for this data.

Placeholder to support potential schema changes in the future.

idstring required

The identifier for the Remote Link. Must be unique for a given Provider.

updateSequenceNumberinteger required

An ID used to apply an ordering to updates for this Remote Link in the case of out-of-order receipt of update requests.

It must be a monotonically increasing number. For example, epoch time could be one way to generate the updateSequenceNumber.

Updates for a Remote Link that is received with an updateSqeuenceNumber less than or equal to what is currently stored will be ignored.

displayNamestring required

The human-readable name for the Remote Link.

Will be shown in the UI.

urlstring uri required

The URL to this Remote Link in your system.

type'document' | 'alert' | 'test' | 'security' | 'logFile' | 'prototype' | 'coverage' | 'bugReport' | 'other' required

The type of the Remote Link. The current supported types are 'document', 'alert', 'test', 'security', 'logFile', 'prototype', 'coverage', 'bugReport' and 'other'

descriptionstring

An optional description to attach to this Remote Link.

This may be anything that makes sense in your system.

lastUpdatedstring date-time required

The last-updated timestamp to present to the user as a summary of when Remote Link was last updated.

actionIdsstring[]

Optional list of actionIds. They are associated with the actions the provider is able to provide when they registered. Indicates which actions this Remote Link has.

If any actions have a templateUrl that requires string substitution, then attributeMap must be passed in.

attributeMapobject

Map of key/values (string to string mapping). This is used to build the urls for actions from the templateUrl the provider registered their available actions with.

Example response

{
  "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"
  ]
}