Work Items - Create
建立單一工作專案。
POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?api-version=4.1
POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?validateOnly={validateOnly}&bypassRules={bypassRules}&suppressNotifications={suppressNotifications}&api-version=4.1
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps 組織的名稱。 |
project
|
path | True |
string |
專案識別碼或專案名稱 |
type
|
path | True |
string |
要建立之工作專案的工作專案類型 |
api-version
|
query | True |
string |
要使用的 API 版本。 這應該設定為 '4.1' 以使用此版本的 API。 |
bypass
|
query |
boolean |
請勿在此更新上強制執行工作專案類型規則 |
|
suppress
|
query |
boolean |
請勿引發此變更的任何通知 |
|
validate
|
query |
boolean |
指出您是否只想要驗證變更而不儲存工作專案 |
要求本文
Media Types: "application/json-patch+json"
名稱 | 類型 | Description |
---|---|---|
from |
string |
移動/複製作業要從中複製的路徑。 |
op |
修補作業 |
|
path |
string |
作業的路徑 |
value |
object |
作業的值。 這是基本類型或 JToken。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
成功的作業 |
安全性
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
名稱 | Description |
---|---|
vso.work_write | 授與讀取、建立和更新工作專案和查詢、更新面板中繼資料、讀取區域和反復專案路徑的其他工作專案追蹤相關中繼資料、執行查詢,以及透過服務勾點接收工作專案事件通知的能力。 |
範例
Create work item
Sample Request
POST https://dev.azure.com/fabrikam/{project}/_apis/wit/workitems/${type}?api-version=4.1
[
{
"op": "add",
"path": "/fields/System.Title",
"from": null,
"value": "Sample task"
}
]
Sample Response
{
"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": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
"System.ChangedDate": "2017-10-06T01:04:51.57Z",
"System.ChangedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
"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"
}
定義
名稱 | Description |
---|---|
Json |
JSON 修補作業的 JSON 模型 |
Operation |
修補作業 |
Reference |
表示 REST 參考連結集合的類別。 |
Work |
描述工作專案。 |
Work |
JsonPatchDocument
JSON 修補作業的 JSON 模型
名稱 | 類型 | Description |
---|---|---|
from |
string |
移動/複製作業要從中複製的路徑。 |
op |
修補作業 |
|
path |
string |
作業的路徑 |
value |
object |
作業的值。 這是基本類型或 JToken。 |
Operation
修補作業
名稱 | 類型 | Description |
---|---|---|
add |
string |
|
copy |
string |
|
move |
string |
|
remove |
string |
|
replace |
string |
|
test |
string |
ReferenceLinks
表示 REST 參考連結集合的類別。
名稱 | 類型 | Description |
---|---|---|
links |
object |
連結的唯讀檢視。 因為參考連結是唯讀的,所以我們只想要將它們公開為唯讀。 |
WorkItem
描述工作專案。
名稱 | 類型 | Description |
---|---|---|
_links |
連結相關 REST 資源的參考。 |
|
fields |
object |
工作專案的欄位和值對應。 |
id |
integer |
工作專案識別碼。 |
relations |
工作專案的關係。 |
|
rev |
integer |
工作專案的修訂編號。 |
url |
string |
WorkItemRelation
名稱 | 類型 | Description |
---|---|---|
attributes |
object |
連結屬性的集合。 |
rel |
string |
關聯性類型。 |
url |
string |
連結 URL。 |