Interface SubmitRemoteLinks

interface SubmitRemoteLinks {
    properties?: {};
    providerMetadata?: {
        product?: string;
    };
    remoteLinks?: {
        actionIds?: string[];
        associations?: {}[];
        attributeMap?: {};
        description?: string;
        displayName: string;
        id: string;
        lastUpdated: string;
        schemaVersion?: string;
        status?: {
            appearance: string;
            label: string;
        };
        type: string;
        updateSequenceNumber: number;
        url: string;
    }[];
}

Properties

properties? providerMetadata? remoteLinks?

Properties

Optional properties

properties?: {}

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 '_'.

Type declaration

    Optional providerMetadata

    providerMetadata?: {
        product?: string;
    }

    Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. It is not considered private information. Hence, it may not contain personally identifiable information.

    Type declaration

    • Optional product?: string

      An optional name of the source of the Remote Links data.

    Optional remoteLinks

    remoteLinks?: {
        actionIds?: string[];
        associations?: {}[];
        attributeMap?: {};
        description?: string;
        displayName: string;
        id: string;
        lastUpdated: string;
        schemaVersion?: string;
        status?: {
            appearance: string;
            label: string;
        };
        type: string;
        updateSequenceNumber: number;
        url: string;
    }[]

    A list of Remote Links to submit to Jira.

    Each Remote Link may be associated with one or more Jira issue keys, and will be associated with any properties included in this request.

    Type declaration

    • 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 associations?: {}[]

      The entities to associate the Remote Link information with.

    • 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.

      • Optional description?: string

        An optional description to attach to this Remote Link.

        This may be anything that makes sense in your system.

      • displayName: string

        The human-readable name for the Remote Link.

        Will be shown in the UI.

      • id: string

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

      • lastUpdated: string

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

      • Optional schemaVersion?: string

        The schema version used for this data.

        Placeholder to support potential schema changes in the future.

      • Optional status?: {
            appearance: string;
            label: string;
        }

        The status of a Remote Link.

        • appearance: string

          Appearance is a fixed set of appearance types affecting the colour of the status lozenge in the UI. The colours they correspond to are equivalent to atlaskit's Lozenge component.

        • label: string

          The human-readable description for the Remote Link status.

          Will be shown in the UI.

      • type: string

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

      • 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.

      • url: string

        The URL to this Remote Link in your system.

      Settings

      Member Visibility

      Theme

      On This Page

      propertiesproviderMetadataremoteLinks