ADO：通过 HTTP REST 请求将附件上传到 Azure DevOps

Question

我们正在使用 ADO Server 2019，作为一个更大项目的一部分，我需要将一些电子邮件上传到 ADO 环境以附加到工作项。我已经知道您首先需要上传附件，将附件 ID 传递给工作项补丁请求，并从工作项端添加关系，但是我终生无法弄清楚的是在哪里选择要上传的实际电子邮件或任何项目。

MS 文档中给出的示例向您展示了如何 post 上传，但它没有上传任何内容，它只是创建了一个空白页面。

POST https://{instance}/fabrikam/_apis/wit/attachments?fileName=textAsFileAttachment.txt&api-version=5.0

需要构建请求的正文以定义我可以收集的附件的位置，但是没有任何类型的文档可以简单地通过 HTTP posting 它。

我们正在使用 Blue Prism，因此使用 C# 是一种选择，但并不理想。

提前致谢。

Answer 1

如果您创建新附件，您必须传递文件内容。 Upload a binary file

POST https://dev.azure.com/fabrikam/_apis/wit/attachments?fileName=imageAsFileAttachment.png&api-version=6.1-preview.3

"[BINARY FILE CONTENT]"

这里是一个通过 Powershell 的例子：

$user = ""
$token = "<personal access token>"

$base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $user,$token)))

$org = "org_name"
$teamProject = "teamproject"
$wiId = "work item Id"

$folderPath = "c:/temp"
$fileName = "some_file.zip"

$createAttachmetUrlTemplate = "https://dev.azure.com/$org/$teamProject/_apis/wit/attachments?fileName={fileName}&api-version=5.0"
$updateWIUrlTemplate = "https://dev.azure.com/$org/_apis/wit/workitems/{id}?api-version=5.0"

$wiBodyTemplate = "[{`"op`": `"add`",`"path`": `"/relations/-`",`"value`": {`"rel`": `"AttachedFile`",`"url`": `"{attUrl}`", `"attributes`": {`"comment`": `"Spec for the work`"}}}]"

function InvokePostRequest ($PostUrl, $body)
{   
    return Invoke-RestMethod -Uri $PostUrl -Method Post -ContentType "application/json" -Headers @{Authorization=("Basic {0}" -f $base64AuthInfo)}  -Body $body
}

function InvokePatchRequest ($PatchUrl, $body)
{   
    return Invoke-RestMethod -Uri $PatchUrl -Method Patch -ContentType "application/json-patch+json" -Headers @{Authorization=("Basic {0}" -f $base64AuthInfo)}  -Body $body
}

$bytes = [System.IO.File]::ReadAllBytes("$folderPath/$fileName")

$createAttachmetUrl = $createAttachmetUrlTemplate -replace "{filename}", $fileName

$resAtt = InvokePostRequest $createAttachmetUrl $bytes

$updateWIUrl = $updateWIUrlTemplate -replace "{id}", $wiId
$wiBody = $wiBodyTemplate -replace "{attUrl}", $resAtt.url

InvokePatchRequest $updateWIUrl $wiBody

Answer 2

请按照以下步骤操作：

1.Upload a text file

POST https://{instance}/fabrikam/_apis/wit/attachments?fileName=textAsFileAttachment.txt&api-version=5.0

请求正文："User text content to upload"

2.You 将得到如下响应：

{
  "id": "6b2266bf-a155-4582-a475-ca4da68193ef",
  "url": "https://fabrikam:8080/tfs/_apis/wit/attachments/6b2266bf-a155-4582-a475-ca4da68193ef?fileName=textAsFileAttachment.txt"
}

从回复中复制此 url。

3.Add an attachment to work items:

POST https://{instance}/fabrikam/_apis/wit/attachments?fileName=textAsFileAttachment.txt&api-version=5.0

请求正文：

[
  {
    "op": "add",
    "path": "/relations/-",
    "value": {
      "rel": "AttachedFile",
      "url": "https://fabrikam:8080/tfs/_apis/wit/attachments/6b2266bf-a155-4582-a475-ca4da68193ef?fileName=textAsFileAttachment.txt",
      "attributes": {
        "comment": "Spec for the work"
      }
    }
  }
]

替换请求正文的url。

ADO：通过 HTTP REST 请求将附件上传到 Azure DevOps

ADO: upload an attachment to Azure DevOps via HTTP REST request

json

azure-devops

azure-devops-rest-api