deleteDeploymentsByProperty method

Future<void> deleteDeploymentsByProperty({
  1. int? updateSequenceNumber,
})

Bulk delete all deployments that match the given request.

One or more query params must be supplied to specify the 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 (i.e. treated as AND). See the documentation for the submitDeployments operation for more details.

Example operation: DELETE /bulkByProperties?accountId=account-123&createdBy=user-456

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

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

Implementation

Future<void> deleteDeploymentsByProperty({int? updateSequenceNumber}) async {
  await _client.send(
    'delete',
    'rest/deployments/0.1/bulkByProperties',
    queryParameters: {
      if (updateSequenceNumber != null)
        '_updateSequenceNumber': '$updateSequenceNumber',
    },
  );
}