devops-rest APi - $expand 不适用于“Work Items - Get Work Items Batch”

Question

我想从选定的工作项中访问一些数据。
以下是我的工作代码。

function postApiData(ApiUrl, responseBody, token) {
            var res = '';
            $.ajax({
                type: 'POST',
                async: false,
                url: ApiUrl,
                contentType: 'application/json',
                data: JSON.stringify(responseBody),
                cache: false,
                dataType: 'json',
                beforeSend: function (xhr) {
                    xhr.setRequestHeader("Authorization", "Basic " + btoa("" + ":" + _token));
                },
            }).done(function (data) {
                res = data;
            });
        return res;
    };

 var d = {
                    "ids": itemlist,
                    "fields": ["System.Id", "System.WorkItemType", "System.Title", "System.AssignedTo", "System.State", "System.Tags", "cust.PID", "cust.Product", "cust.ReleasedToProduction"]
                };
                var itemdata = postApiData('https://dev.azure.com/COMP/products/_apis/wit/workitemsbatch?$expand=relations&api-version=5.1', d, '');

但是，$expand 不能在这里获取关系。查询给出结果并始终忽略 $expand。

我也尝试在请求正文中传递 $expand，但它也不起作用。有人可以在这里指导吗？

Answer 1

这是因为如果expand 的值为relations，则expand 参数不能与fields 参数一起使用。

您可以在 Postman 中使用您的请求正文执行此 api。您将收到明确的信息，说明您为什么不能应用它。

---

要使用您的 API，如果您在请求正文中指定 fields，则不应再使用 expand，反之亦然。这是按照设计的，并且已硬编码到我们的脚本中。如果不是None 或Links，我们不允许另一个$expand 值。

对于$expand(None、Relations、Fields、Links、All)这5个值，只有None和Links可以在API中成功使用fields .这是适用于所有 API 的通用规则，包括此 one。

---

另外，请在请求正文中使用$expand=Relations，而不是如文档所述的URI。这里如果你在 URI 中使用它，它不会被服务器脚本使用，因为这个 API 调用的方法没有这个参数。另一个可以在 URI 中使用 $expand 的 API（我们通常会提到并显示它是否可以在文档中的 URI 中使用），相应的脚本有参数可以访问这些通过 URI 传递的值.

所以，这里请在请求正文中使用$expand=Relations，然后您将获得包含所有字段及其所有关系的结果。