Function: deleteDeploymentsByProperty()

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

Defined in: src/agile/api/deployments.ts:61

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

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ accountId: string; createdBy?: string; }	-
parameters.accountId	string	Property key used to select which submitted deployments to delete. Must match a key previously sent in submitDeployments properties (string values, max 5 properties, keys cannot contain ':' or start with '_'). Example: accountId=account-123.
parameters.createdBy?	string	Optional additional property filter combined with accountId (AND). Must match a key previously supplied in submitDeployments properties. Example: createdBy=user-456.
options?	RequestOptions	-

Returns

Promise<void>