Modify a wiki page in azure devops in powershell using rest api

Hi Thomas Murnane

Could you please check the following things:

• Ensure that the URL you are using is correct and properly formatted. The URI for updating a page should include the path parameter and use the correct API version.

    https://dev.azure.com/{org}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path=/Releases/29.2&api-version=7.0
  

• For updating a wiki page, Azure DevOps expects a PATCH request, not PUT. PUT is typically used for creating resources, while PATCH modifies existing ones. $params = @{ 'Uri' = $uri 'Headers' = $Headers 'Method' = 'Patch'
• Ensure that the body variable contains valid JSON.
• Also, include the version object in the request body, specifically the current version.id of the page and use the correct Content-Type
  • Retrieve version.id from the existing page.
  • Include version in the PUT body, e.g.:

    {
      "content": "new content here",
      "version": { "id": "xxxxx" }
    }
  

Hope this helps!

Please Let me know if you have any queries.

I can't seem to get this to work. I'm trying to add a simple TOSP on the "Release" page. I'm trying to do this simple process. I know the PAT is correct because I can get the Page ID "6108" during the regular test script

$Headers = @{
Authorization = "Basic " + [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(":$PAT"))
}

$uri = "https://dev.azure.com/${org}/${project}/_apis/wiki/wikis/${wikiIdentifier}/pages?path=/Releases&api-version=7.0"
$body = @{
content = "New stuff"
version = @{ id = "6108" }
} | ConvertTo-Json

Invoke-RestMethod -Uri $uri -Headers $Headers -Method PATCH -ContentType "application/json; charset=utf-8" -Body $body

When I run this, it throws the following:
Invoke-RestMethod : {"count":1,"value":{"Message":"The requested resource does not support http method 'PATCH'."}}

And trying to use a PUT instead throws a webException that the page exists trying to add a new page.

I've also tried to update the page with the page id uri as well:
$response = Invoke-RestMethod -Uri $uri -Headers $Headers -Method Get
$newUri = "https://dev.azure.com/${org}/${project}/_apis/wiki/wikis/${wikiName}/pages/$($response.id)?api-version=7.1-preview.1"

and that gave me a "(500) Internal Server Error" with a PATCH method and a "(405) Method Not Allowed." trying to use "PUT"

and I did print out the uri's and was able to see the contents in the current release page.

Here is the function I'm using:
function Set-PageContent {
param(
[Parameter(Mandatory=$true)][string]$uri,
[Parameter(Mandatory=$true)]$content,
[string]$pageId
)
$Headers = @{
'Authorization' = 'Basic ' + [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(":$accessToken"))
}
Write-Host "Updating: $uri" -ForegroundColor Yellow
# Build request body and method
if ($pageId) {
$requestBody = @{
content = $content
version = @{ id = $pageId }
} | ConvertTo-Json
$method = 'PATCH'
} else {
$requestBody = @{ content = $content } | ConvertTo-Json
$method = 'PUT'
}

$params = @{
Uri = $uri
Headers = $Headers
Method = $method
ContentType = 'application/json; charset=utf-8'
Body = $requestBody
}
try {
$result = Invoke-RestMethod @params
Write-Host "✅ $method succeeded for $uri"

return $result
} catch {
Write-Host "❌ $method failed for $uri" -ForegroundColor Red
Write-Host $_.Exception.Message -ForegroundColor Red
if ($_.Exception.Response -ne $null) {
$reader = New-Object System.IO.StreamReader($_.Exception.Response.GetResponseStream())
$responseBody = $reader.ReadToEnd()
Write-Host "Response: $responseBody" -ForegroundColor DarkMagenta
}
return $null
}
}

This is called like this:

$response = Get-WikiPageContent -uri $releasesPageUri
$newContent = Set-ReleaseTOSP -existingContent $response.content -releaseVersion $releaseVersion
Set-PageContent -uri $response.uri -content $newContent -pageId $response.pageId

Get-WikiPageContent returns:
return [pscustomobject]@{
content = $null
pageId = $null
uri = $uri
}

I added the "uri = $uri" when testing adding in the wiki page "id" and tried to use that form of the wiki page with the Id instead of the actual page name to no avail:
$newUri = "https://dev.azure.com/${org}/${project}/_apis/wiki/wikis/${wikiName}/pages/$($response.id)?api-version=7.1-preview.1"

Hi Thomas Murnane

The version.id is not the pageId like 6108, but rather the GUID returned in the version block when you GET the page.

When you run: version = @{ id = "6108" }, you’re passing the page id, but the API expects the version id - a GUID like d774f7a2-bd2f-4c71-8d8e-b26e04654c29.

PUT creates if the page doesn’t exist and updates if it does, but to update, you must send the latest version.id to avoid conflicts.

This is the GUID you actually need - $versionId = $page.page.version.id

When you run this

$Headers = @{
    Authorization = "Basic " + [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(":$PAT"))
}
$pageUri = "https://dev.azure.com/${org}/${project}/_apis/wiki/wikis/${wikiIdentifier}/pages?path=/Releases&includeContent=true&api-version=7.0"
$page = Invoke-RestMethod -Uri $pageUri -Headers $Headers -Method GET
$page | ConvertTo-Json -Depth 10

You will get Json format, there you can find the id in GUID Format.

Hope this helps!

Please Let me know if you have any queries.

yah, that is not the way to get the version, the eTag is the version you are talking about which is in the Headers so I had to use "Invoke-WebRequest" Not Invoke-RestMethod - at least I could not find a way to do that. Crazy its this difficult. Having said that, this is the function I'm using trying to set the contents of a page, I would expect it would create the page if it didn't exist and update it if it does exist.

function Set-PageContent {

param(

[Parameter(Mandatory=$true)][string]$pagePath,

[Parameter(Mandatory=$true)]$content,

[string]$commitId

)

$uri = "https://dev.azure.com/${org}/${project}/_apis/wiki/wikis/${wikiName}/pages?path=${pagePath}&api-version=7.1-preview.1"

Write-Host "Updating: $uri" -ForegroundColor Yellow

# Build request body and method

if ($commitId) {

$requestBody = @{

content = $content

version = @{ id = $commitId }

} | ConvertTo-Json

$method = 'PATCH'

} else {

$requestBody = @{ content = $content } | ConvertTo-Json

$method = 'PUT'

}

$params = @{

Uri = $uri

Headers = $Headers

Method = $method

ContentType = 'application/json; charset=utf-8'

Body = $requestBody

}

# display parameters

$params.GetEnumerator() | ForEach-Object { "$($_.Key) = $($_.Value)" }

try {

$result = Invoke-RestMethod @params

Write-Host "✅ $method succeeded for $uri"

return $result

} catch {

Write-Host "❌ $method failed for $uri" -ForegroundColor Red

Write-Host $_.Exception.Message -ForegroundColor Red

if ($_.Exception.Response -ne $null) {

$reader = New-Object System.IO.StreamReader($_.Exception.Response.GetResponseStream())

$responseBody = $reader.ReadToEnd()

Write-Host "Response: $responseBody" -ForegroundColor DarkMagenta

}

return $null

}

}

Printing out the $params: