Function: deleteIncidentById()

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

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

Delete the Incident data currently stored for the given ID.

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	{ incidentId: string; }	-
parameters.incidentId	string	The ID of the Incident to delete.
options?	RequestOptions	-

Returns

Promise<void>