Delete Comment

Delete Comment is available as both a pgutil command and an HTTP Request, and will delete a comment.

pgutil builds comments delete --project=myProject --build=1.2.3 --number=2

Command Specification (CLI)

The builds comments delete command is used to delete a comment in a project's build.

The --project, --build and --number options are always required.

Deleting a comment requires the project (e.g. myProject), the build version number (e.g. 1.2.3), and the comment number (e.g. 2)

pgutil builds comments delete --project=myProject --build=1.2.3 --number=2

HTTP Request Specification

To delete a comment, simply DELETE to the URL with an appropriate API Key.

DELETE /api/sca/comments?project=«projectName»&version=«releaseVersion»&number=«commentNumber»

HTTP Response Specification

A successful 200 response will indicate the comment was successfully deleted. A 403 response indicates a missing, unknown, or unauthorized API Key.

Delete all comments (Powershell)

This script deletes all comments in version 1.2.3 of project myProject:

$baseURL = "https://proget.corp.local"
$apiKey = "a1b2c3d4e5"
$projectName = "myProject"
$releaseVersion = "1.2.3"

$listEndpoint = "/api/sca/comments?project=$projectName&version=$releaseVersion"
function ListComments {
    $headers = @{
        "X-ApiKey" = $apiKey
    }
    return Invoke-RestMethod -Uri ($baseURL + $listEndpoint) -Headers $headers -Method Get
}
function DeleteComment($commentNumber) {
    $headers = @{
        "X-ApiKey" = $apiKey
    }
    $deleteEndpoint = "/api/sca/comments?project=$projectName&version=$releaseVersion&number=$commentNumber"
    return Invoke-RestMethod -Uri ($baseURL + $deleteEndpoint) -Headers $headers -Method Delete
}
$comments = ListComments
if ($comments.Count -gt 0) {
    Write-Host "Deleting all comments..."
    $comments | ForEach-Object {
        DeleteComment $_.number
        Write-Host "Comment number $($_.number) deleted."
    }
} else {
    Write-Host "No comments to delete."
}