Function: submitRemoteLinks()

function submitRemoteLinks(client, parameters): Promise<{
[key: string]: unknown;
  acceptedRemoteLinks?: string[];
  rejectedRemoteLinks?: Record<string, any>;
  unknownAssociations?: (
     | {
   [key: string]: unknown;
     associationType: string & object | "issueKeys" | "issueIdOrKeys";
     values: string[];
   }
     | {
   [key: string]: unknown;
     associationType: string & object | "serviceIdOrKeys";
     values: string[];
  })[];
}>;

Defined in: src/agile/api/remoteLinks.ts:22

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

Parameter	Type	Description
client	Client	-
parameters	{ properties?: Record<string, any>; providerMetadata?: { product?: string; }; remoteLinks: object[]; }	-
parameters.properties?	Record<string, any>	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 '_'.
parameters.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.
parameters.providerMetadata.product?	string	An optional name of the source of the Remote Links data.
parameters.remoteLinks	object[]	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.

Returns

Promise<{ [key: string]: unknown; acceptedRemoteLinks?: string[]; rejectedRemoteLinks?: Record<string, any>; unknownAssociations?: ( | { [key: string]: unknown; associationType: string & object | "issueKeys" | "issueIdOrKeys"; values: string[]; } | { [key: string]: unknown; associationType: string & object | "serviceIdOrKeys"; values: string[]; })[]; }>