Function: deleteComponentById()

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

Defined in: src/agile/api/devopsComponents.ts:112

Delete the Component data currently stored for the given ID.

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

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

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ componentId: string; }	-
parameters.componentId	string	The ID of the Component to delete.
options?	RequestOptions	-

Returns

Promise<void>