deleteRemoteLinksByProperty method

Future<void> deleteRemoteLinksByProperty({
  1. int? updateSequenceNumber,
  2. Map<String, dynamic>? params,
})

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

Only Connect apps that define the jiraRemoteLinkInfoProvider module, and on-premise integrations, can access this resource. This resource requires the 'DELETE' scope for Connect apps.

Implementation

Future<void> deleteRemoteLinksByProperty(
    {int? updateSequenceNumber, Map<String, dynamic>? params}) async {
  await _client.send(
    'delete',
    'rest/remotelinks/1.0/bulkByProperties',
    queryParameters: {
      if (updateSequenceNumber != null)
        '_updateSequenceNumber': '$updateSequenceNumber',
      if (params != null) 'params': '$params',
    },
  );
}