Function: deleteRemoteLinksByProperty()

function deleteRemoteLinksByProperty(
   client, 
   parameters, 
   options?
): Promise<void>;

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

Bulk delete all Remote Links data that match the given request.

One or more query params must be supplied to specify Properties to delete by. Optional param _updateSequenceNumber is no longer supported. If more than one Property is provided, data will be deleted that matches ALL of the Properties (e.g. treated as an AND).

See the documentation for the submitRemoteLinks operation for more details.

E.g. DELETE /bulkByProperties?accountId=account-123&repoId=repo-345

Deletion is performed asynchronously. The getRemoteLinkById operation can be used to confirm that data has been deleted successfully (if needed).

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ params?: Record<string, any>; }	-
parameters.params?	Record<string, any>	Free-form query parameters to specify which properties to delete by. Properties refer to the arbitrary information the provider tagged Remote Links with previously. For example, if the provider previously tagged a remote link with accountId: "properties": { "accountId": "account-123" } And now they want to delete Remote Links in bulk by that specific accountId as follows: e.g. DELETE /bulkByProperties?accountId=account-123
options?	RequestOptions	-

Returns

Promise<void>