Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/jira/src/agile/models/getRemoteLinkById.ts>GetRemoteLinkById

A JavaScript/TypeScript wrapper for the JIRA Cloud, Service Desk and Agile REST API
Latest
interface GetRemoteLinkById
import { type GetRemoteLinkById } from "https://deno.land/x/jira@v3.0.2/src/agile/models/getRemoteLinkById.ts";

Data related to a single Remote Link.

Properties

optional
schemaVersion: string

The schema version used for this data.

Placeholder to support potential schema changes in the future.

id: string

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

updateSequenceNumber: number

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.

displayName: string

The human-readable name for the Remote Link.

Will be shown in the UI.

url: string

The URL to this Remote Link in your system.

type: string

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

optional
description: string

An optional description to attach to this Remote Link.

This may be anything that makes sense in your system.

lastUpdated: string

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

optional
associations: { }[]

The entities to associate the Remote Link information with.

optional
status: { appearance: string; label: string; }

The status of a Remote Link.

optional
actionIds: string[]

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.

optional
attributeMap: { }

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.