Function: deleteEntity()
ts
function deleteEntity(
client,
parameters,
options?
): Promise<void>;Defined in: src/agile/api/developmentInformation.ts:135
Deletes particular development information entity. Deletion is performed asynchronously.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { entityId: string; entityType: string & object | "commit" | "branch" | "pull_request"; repositoryId: string; updateSequenceId: number; } | - |
parameters.entityId | string | - |
parameters.entityType? | string & object | "commit" | "branch" | "pull_request" | - |
parameters.repositoryId? | string | - |
parameters.updateSequenceId? | number | An optional property to use to control deletion. Only stored data with an updateSequenceId less than or equal to that provided will be deleted. This can be used to help ensure submit/delete requests are applied correctly if they are issued close together. |
options? | RequestOptions | - |
Returns
Promise<void>