PR Summary

This PR adds the DateFormat parameter to the Invoke-RestMethod cmdlet, allowing users to control how date strings in JSON responses are parsed. This parameter mirrors the existing functionality already available in the ConvertFrom-Json cmdlet which has the same parameter.

The change preserves the exiting behavior, but extends the cmdlet functionnalities.

PR Context

The Invoke-RestMethod cmdlet automatically converts JSON responses using ConvertFrom-Json.

When a response contains string values corresponding to a date format, the default and only behavior is to convert the string to something similar to dd/MM/YYYY HH:mm:ss.

As a user, I want to preserve the string as it is, or at least convert it directly to UTC.
Example use case :

<#
Current host date : May 1st 2025 - 08:30:00

Raw JSON payload retrieved by Invoke-RestMethod -> { "createdDate" : "2025-05-01T12:00:00Z" }
#>

# Before : the date format is converted and if the time format ends with the character "Z" then the displayed time is UTC.

$response = Invoke-RestMethod @params

Write-Host response.createdDate

<# output : jeudi 1 mai 2025 12:00:00 #>

# After

params.Add("DateFormat",  "String")

# The output date string is as in the raw JSON

$response = Invoke-RestMethod @params

Write-Host response.createdDate

<# output : 2025-05-01T12:00:00Z #>

# Other possible use

params.Add("DateFormat",  "Local")

$response = Invoke-RestMethod @params

Write-Host response.createdDate

<# output : jeudi 1 mai 2025 08:30:00 #>

# The output time matches to the computer's timezone

PR Checklist

• PR has a meaningful title
  • Use the present tense and imperative mood when describing your changes
• Summarized changes
• Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
• This PR is ready to merge. If this PR is a work in progress, please open this as a Draft Pull Request and mark it as Ready to Review when it is ready to merge.
• Breaking changes
  • None
  • OR
  • Experimental feature(s) needed
    • Experimental feature name(s):
• User-facing changes
  • Not Applicable
  • OR
  • Documentation needed
    • Issue filed:
• Testing - New and feature
  • N/A or can only be tested interactively
  • OR
  • Make sure you've added a new test if existing tests do not effectively test the code changed