PowerShell 无法识别提供的参数

Question

操作系统 - Windows 10

Powershell 版本 - 5.1.15063.1088

我正在使用 Windows PowerShell ISE（如果这有意义的话）。运行简单的 HTTP Post 函数时

Function MyBeautifulFunction {

  $myCredentials = Get-Credential

  $body = @{
          "query"="SELECT [System.Wheel],[System.SparkPlug],[System.EngineOil],[System.Headlight],[System.RadioButton] FROM JunkYard WHERE [System.Brand] = 'Ford' AND [System.Model] = 'GT' AND [System.Title] CONTAINS 'Rebuild'"
  } | ConvertTo-Json

  Invoke-RestMethod -Uri 'http://example.com//ford/parts/fuelpump/_apis/wit/wiql?api-version=2.0' `
    -Method Post `
    -Credential $myCredentials `
    -Body $body `
    -ContentType 'application/json' 

}

MyBeautifulFunction

^{编者注：Invoke-RestMethod 调用最初分散在 2 行中，没有续行，下面的 Adam's answer 部分将讨论。}

我在 PowerShell ISE 控制台窗口中收到以下错误消息：

"message":"The request indicated a Content-Type of \"application/x-www-form-urlencoded\" for method type \"POST\" which is not supported. Valid 
content types for this method are: application/json, application/json-patch+json.

很明显，我在参数中传递了'application/json'，但由于某种原因，PowerShell 仍然抱怨。有没有人遇到过这个错误？我应该向微软报告吗？感谢您的建议...

Answer 1

您需要将标头传递给 headers 参数

$headers = @{
    "Content-Type" = "application/json",
    "Accept" = "application/json"
}

Invoke-RestMethod -Uri 'http://example.com/123' -Method Post -Body $body -Headers $headers 

见 - https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/invoke-restmethod

Answer 2

几件事...

首先，我一直调用 REST 服务，内容类型为 application/json，我没有任何问题。例如，以下对我来说很好：

$url = 'https://jsonplaceholder.typicode.com/posts/1'
$response_from_webservice = Invoke-RestMethod -Uri $url -ContentType 'application/json' -Method 'Get'

jsonplaceholder... 是一项公共服务，可用于测试。如果您需要进行完整性检查，请随时在您的机器上运行 sn-p。

其次，你发送的这个示例代码有这个Accept参数：

Invoke-RestMethod -Uri 'http://example.com//ford/parts/fuelpump/_apis/wit/wiql?api-version=2.0' -Method Post -Credential $myCredentials 
-Body $body -ContentType 'application/json' -Accept 'application/json'  

我不相信我以前见过这种情况。我也在使用 Powershell v5.1.15063.1088 运行 Windows 10。我检查了docs。我检查了命令行开关的参数。没找到。

我分享这个是为了解释，我不能用那个调用签名重新创建你的场景。

如果您想在 HTTP 标头中添加 accept 条目，则必须直接执行此操作：

$h = new-object 'system.collections.generic.dictionary[[string],[string]]'
$h.add('accept', 'application/json')
$r = Invoke-RestMethod -Uri '...' -ContentType 'application/json' -Method 'Post' -Headers $h

第三，看起来您没有在 sn-p.xml 中指定内容类型。 sn-p 的 Invoke-RestMethod 与 body 和 contenttype 参数分开一行。只是要清楚，它不是包装。那里似乎有一个换行符。这意味着第二行-Body $body -ContentType 'application/json' -Accept 'application/json' 与它之前的调用无关；以下是您帖子的复制和粘贴：

Invoke-RestMethod -Uri 'http://example.com//ford/parts/fuelpump/_apis/wit/wiql?api-version=2.0' -Method Post -Credential $myCredentials 
-Body $body -ContentType 'application/json' -Accept 'application/json'  

如果要将参数放在单独的行上，只需使用反引号即可。

Invoke-RestMethod -Uri 'http://example.com//ford/parts/fuelpump/_apis/wit/wiql?api-version=2.0' `
-Method Post `
-Credential $myCredentials `
-Body $body `
-ContentType `
'application/json' 

现在，如果您不指定 ContentType（正如我建议的那样），它将默认为帖子上的“application/x-www-form-urlencoded”。据微软称：

-内容类型

指定网络请求的内容类型。

如果省略该参数且请求方式为POST， Invoke-RestMethod 将内容类型设置为 应用程序/x-www-form-urlencoded。否则，内容类型不是 在调用中指定。