在 Powershell 中更新 VSTS WorkItem 的正确 Invoke-RestMethod 语法是什么 - 构造包含 Windows 路径的 JSON 字符串 [重复]

当尝试使用 Invoke-RestMethod 更新现有 VSTS 工作项时，我不断收到

您必须在请求正文中传递有效的补丁文档。

这是我要传递的内容

$Body = '[{ "op": "test", "path": "/rev", "value": 1},{ "op": "add", "path": "/fields/System.IterationPath", "value":"' + $caseIterationPath + '"},{ "op": "add", "path": "/fields/System.AreaPath", "value":"' + $caseAreaPath + '"}]'

Invoke-RestMethod -Uri "$rootUri/_apis/wit/workitems/$($case.id)?$apiVersion" -Method PATCH -ContentType application/json-patch+json -Headers @{Authorization= $authorization} -Body $Body

身体扩大到

"[{ "op": "test", "path": "/rev", "value": 1},{ "op": "add", "path": "/fields/System.IterationPath", "value":"Foo\Bar 2016.4\2016.4.02"},{ "op": "add", "path": "/fields/System.AreaPath", "value":"Foo\Apps\Bar Stool\Eating"}]"

任何帮助将不胜感激！

JSON uses \ as the 转义字符;例如，\t是 TAB 字符的转义序列（Unicode 代码点0x9).

所以，为了使用literal \- 例如在 Windows 路径中 - 您必须将其转义为\\.

You could手动转义所有变量值您可以按照以下方式合成 JSON 字符串$caseIterationPath -replace '\\', '\\' (sic).

However, it is easier to construct regular PowerShell data structures first, and then let ConvertTo-Json do any required escaping on conversion, which would also cover escaping verbatim " as \".^[1]

最简单的选择是使用哈希表文字，@{ ... };如果您关心在 JSON 转换过程中枚举条目的顺序，请使用ordered哈希表：[ordered] @{ ... }， 如下所示。

在手头的情况下：

# Sample values.
$caseIterationPath = 'c:\path\to\iteration'
$caseAreaPath = 'c:\path\to\area'

# Construct an array of hashtables to be converted to JSON later.
$Body = @(

  [ordered] @{
      op = 'test'
      path = '/rev'
      value = 1
  }

  [ordered] @{
      op = 'add'
      path = '/fields/System.IterationPath'
      value = $caseIterationPath
  }
 
  [ordered] @{
      op = 'add'
      path = '/fields/System.AreaPath'
      value = $caseAreaPath
  }

)

# Convert the array to a string containing JSON.
# ConvertTo-Json will perform any required escaping.
$jsonBody = ConvertTo-Json $Body

# Invoke the REST method.
Invoke-RestMethod -Uri "$rootUri/_apis/wit/workitems/$($case.id)?$apiVersion" `
  -Method PATCH -ContentType application/json-patch+json `
  -Headers @{Authorization= $authorization} `
  -Body $jsonBody

在上面的代码中，$jsonBody最终包含以下内容 - 请注意\实例被正确转义为\\:

[
  {
    "op": "test",
    "path": "/rev",
    "value": 1
  },
  {
    "op": "add",
    "path": "/fields/System.IterationPath",
    "value": "c:\\path\\to\\iteration"
  },
  {
    "op": "add",
    "path": "/fields/System.AreaPath",
    "value": "c:\\path\\to\\area"
  }
]

^{[1] More generally, not constructing the JSON directly as a string also saves you from having to escape syntactic " chars. inside an overall "..." string, if string interpolation is needed. E.g., @{ foo = "OS: $env:OS" } | ConvertTo-Json is simpler than directly constructing "{ `"foo`" = `"OS: $env:OS`" }"}