Function: deleteEntityByProperty()

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

Defined in: src/agile/api/operations.ts:150

Bulk delete all Entties that match the given request.

One or more query params must be supplied to specify Properties to delete by. 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 submitEntity operation for more details.

E.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456

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

Only Connect apps that define the jiraOperationsInfoProvider module can access this resource. This resource requires the 'DELETE' scope for Connect apps.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ accountId: string; createdBy?: string; }	-
parameters.accountId	string	Property key used to select which submitted incidents or reviews to delete. Must match a key previously sent in submitEntity 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 submitEntity properties. Example: createdBy=user-456.
options?	RequestOptions	-

Returns

Promise<void>