Work Items - Create

参考

Service:: Work Item Tracking

API Version:: 7.1-preview.3

创建单个工作项。

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?api-version=7.1-preview.3

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?validateOnly={validateOnly}&bypassRules={bypassRules}&suppressNotifications={suppressNotifications}&$expand={$expand}&api-version=7.1-preview.3

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
type	path	True	string	要创建的工作项的工作项类型
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1-preview.3”才能使用此版本的 API。
$expand	query		WorkItemExpand	工作项属性的展开参数。可能的选项包括 { None、Relations、Fields、Links、All }。
bypassRules	query		boolean	请勿对此更新强制实施工作项类型规则
suppressNotifications	query		boolean	请勿针对此更改触发任何通知
validateOnly	query		boolean	指示是否只想验证更改而不保存工作项

请求正文

Media Types: "application/json-patch+json"

名称	类型	说明
from	string	移动/复制操作的复制路径。
op	Operation	修补操作
path	string	操作的路径。对于数组，可以使用从零开始的索引来指定数组 (的位置，例如 /biscuits/0/name) 。可以使用“-”字符而不是索引来插入数组末尾 (例如 /biscuits/-) 。
value	object	操作的值。这是基元或 JToken。

响应

名称	类型	说明
200 OK	WorkItem	成功的操作

安全性

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

名称	说明
vso.work_write	授予读取、创建和更新工作项和查询、更新板元数据、读取区域和迭代路径、其他工作项跟踪相关元数据、执行查询以及通过服务挂钩接收有关工作项事件的通知的能力。

示例

Create work item

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/{project}/_apis/wit/workitems/${type}?api-version=7.1-preview.3

[
  {
    "op": "add",
    "path": "/fields/System.Title",
    "from": null,
    "value": "Sample task"
  }
]

Sample Response

Status code:: 200

{
  "id": 131489,
  "rev": 1,
  "fields": {
    "System.AreaPath": "CustomProcessPrj",
    "System.TeamProject": "CustomProcessPrj",
    "System.IterationPath": "CustomProcessPrj",
    "System.WorkItemType": "Task",
    "System.State": "New",
    "System.Reason": "New",
    "System.CreatedDate": "2017-10-06T01:04:51.57Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2017-10-06T01:04:51.57Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "Sample task",
    "Microsoft.VSTS.Common.StateChangeDate": "2017-10-06T01:04:51.57Z",
    "Microsoft.VSTS.Common.Priority": 2
  },
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489"
    },
    "workItemUpdates": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489/updates"
    },
    "workItemRevisions": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489/revisions"
    },
    "workItemHistory": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489/history"
    },
    "html": {
      "href": "https://dev.azure.com/fabrikam/web/wi.aspx?pcguid=20cda608-32f0-4e6e-9b7c-8def7b38d15a&id=131489"
    },
    "workItemType": {
      "href": "https://dev.azure.com/fabrikam/aaee31d9-14cf-48b9-a92b-3f1446c13f80/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489"
}

定义

名称	说明
JsonPatchDocument	JSON 修补操作的 JSON 模型
Operation	修补操作
ReferenceLinks	表示 REST 引用链接集合的类。
WorkItem	描述工作项。
WorkItemCommentVersionRef	表示对工作项上注释的特定版本的引用。
WorkItemExpand	工作项属性的展开参数。可能的选项包括 { None、Relations、Fields、Links、All }
WorkItemRelation

JsonPatchDocument

JSON 修补操作的 JSON 模型

名称	类型	说明
from	string	移动/复制操作的复制路径。
op	Operation	修补操作
path	string	操作的路径。对于数组，可以使用从零开始的索引来指定数组 (的位置，例如 /biscuits/0/name) 。可以使用“-”字符而不是索引来插入数组末尾 (例如 /biscuits/-) 。
value	object	操作的值。这是基元或 JToken。

Operation

修补操作

名称	类型	说明
add	string
copy	string
move	string
remove	string
replace	string
test	string

ReferenceLinks

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读。

WorkItem

描述工作项。

名称	类型	说明
_links	ReferenceLinks	链接对相关 REST 资源的引用。
commentVersionRef	WorkItemCommentVersionRef	对在此修订中添加/编辑/删除的特定版本的注释的引用。
fields	object	工作项的字段和值的映射。
id	integer	工作项 ID。
relations	WorkItemRelation[]	工作项的关系。
rev	integer	工作项的修订号。
url	string

WorkItemCommentVersionRef

表示对工作项上注释的特定版本的引用。

名称	类型	说明
commentId	integer	分配给注释的 ID。
createdInRevision	integer	[内部]最初添加此注释的工作项修订。
isDeleted	boolean	[内部]指定是否删除注释。
text	string	[内部]注释的文本。
url	string
version	integer	版本号。

WorkItemExpand

工作项属性的展开参数。可能的选项包括 { None、Relations、Fields、Links、All }

名称	类型	说明
all	string	全部展开。
fields	string	字段工作项展开。
links	string	展开“链接”工作项。
none	string	默认行为。
relations	string	关系工作项展开。

WorkItemRelation

名称	类型	说明
attributes	object	链接属性的集合。
rel	string	关系类型。
url	string	链接 URL。