Work Items - Create
Tek bir iş öğesi oluşturur.
POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?api-version=7.1-preview.3
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 Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps kuruluşunun adı. |
project
|
path | True |
string |
Proje Kimliği veya proje adı |
type
|
path | True |
string |
Oluşturulacak iş öğesinin iş öğesi türü |
api-version
|
query | True |
string |
Kullanılacak API sürümü. Api'nin bu sürümünü kullanmak için bu değer '7.1-preview.3' olarak ayarlanmalıdır. |
$expand
|
query |
İş öğesi öznitelikleri için genişletme parametreleri. Olası seçenekler şunlardır: { Yok, İlişkiler, Alanlar, Bağlantılar, Tümü }. |
||
bypass
|
query |
boolean |
Bu güncelleştirmede iş öğesi türü kurallarını zorunlu kılma |
|
suppress
|
query |
boolean |
Bu değişiklik için hiçbir bildirim tetiklemayın |
|
validate
|
query |
boolean |
İş öğesini kaydetmeden yalnızca değişiklikleri doğrulamak isteyip istemediğinizi belirtin |
İstek Gövdesi
Media Types: "application/json-patch+json"
Name | Tür | Description |
---|---|---|
from |
string |
Taşıma/Kopyalama işlemi için kopyalamanın yolu. |
op |
Düzeltme eki işlemi |
|
path |
string |
İşlemin yolu. Dizi söz konusu olduğunda, dizideki konumu belirtmek için sıfır tabanlı bir dizin kullanılabilir (örn. /biscuits/0/name). Dizinin sonuna eklenecek dizin yerine "-" karakteri kullanılabilir (örn. /biscuits/-). |
value |
object |
İşlemin değeri. Bu bir ilkel veya JToken'dir. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
başarılı işlem |
Güvenlik
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
Name | Description |
---|---|
vso.work_write | İş öğelerini ve sorgularını okuma, oluşturma ve güncelleştirme, pano meta verilerini güncelleştirme, alan ve yineleme yollarını diğer iş öğesi izlemeyle ilgili meta verileri izleme, sorguları yürütme ve hizmet kancaları aracılığıyla iş öğesi olayları hakkında bildirim alma olanağı verir. |
Örnekler
Create work item
Sample Request
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
{
"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"
}
Tanımlar
Name | Description |
---|---|
Json |
JSON Düzeltme Eki İşlemleri için JSON modeli |
Operation |
Düzeltme eki işlemi |
Reference |
REST başvuru bağlantıları koleksiyonunu temsil eden sınıf. |
Work |
bir iş öğesini açıklar. |
Work |
İş Öğesindeki bir açıklamanın belirli bir sürümüne başvuruyu temsil eder. |
Work |
İş öğesi öznitelikleri için genişletme parametreleri. Olası seçenekler şunlardır: { Yok, İlişkiler, Alanlar, Bağlantılar, Tümü } |
Work |
JsonPatchDocument
JSON Düzeltme Eki İşlemleri için JSON modeli
Name | Tür | Description |
---|---|---|
from |
string |
Taşıma/Kopyalama işlemi için kopyalamanın yolu. |
op |
Düzeltme eki işlemi |
|
path |
string |
İşlemin yolu. Dizi söz konusu olduğunda, dizideki konumu belirtmek için sıfır tabanlı bir dizin kullanılabilir (örn. /biscuits/0/name). Dizinin sonuna eklenecek dizin yerine "-" karakteri kullanılabilir (örn. /biscuits/-). |
value |
object |
İşlemin değeri. Bu bir ilkel veya JToken'dir. |
Operation
Düzeltme eki işlemi
Name | Tür | Description |
---|---|---|
add |
string |
|
copy |
string |
|
move |
string |
|
remove |
string |
|
replace |
string |
|
test |
string |
ReferenceLinks
REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.
Name | Tür | Description |
---|---|---|
links |
object |
Bağlantıların salt okunur görünümü. Başvuru bağlantıları salt okunur olduğundan, bunları yalnızca salt okunur olarak göstermek istiyoruz. |
WorkItem
bir iş öğesini açıklar.
Name | Tür | Description |
---|---|---|
_links |
İlgili REST kaynaklarına bağlantı başvuruları. |
|
commentVersionRef |
Bu düzeltmede eklenen/düzenlenen/silinen açıklamanın belirli bir sürümüne başvuru. |
|
fields |
object |
İş öğesi için alan ve değerlerin haritası. |
id |
integer |
İş öğesi kimliği. |
relations |
İş öğesinin ilişkileri. |
|
rev |
integer |
İş öğesinin düzeltme numarası. |
url |
string |
WorkItemCommentVersionRef
İş Öğesindeki bir açıklamanın belirli bir sürümüne başvuruyu temsil eder.
Name | Tür | Description |
---|---|---|
commentId |
integer |
Açıklamaya atanan kimlik. |
createdInRevision |
integer |
[İç] Bu açıklamanın başlangıçta eklendiği iş öğesi düzeltmesi. |
isDeleted |
boolean |
[İç] Açıklamanın silinip silinmeyeceğini belirtir. |
text |
string |
[İç] Açıklama metni. |
url |
string |
|
version |
integer |
Sürüm numarası. |
WorkItemExpand
İş öğesi öznitelikleri için genişletme parametreleri. Olası seçenekler şunlardır: { Yok, İlişkiler, Alanlar, Bağlantılar, Tümü }
Name | Tür | Description |
---|---|---|
all |
string |
Tümünü genişletir. |
fields |
string |
Alanlar iş öğesini genişletir. |
links |
string |
Bağlantılar iş öğesini genişletir. |
none |
string |
Varsayılan davranış. |
relations |
string |
İlişkiler iş öğesi genişletildi. |
WorkItemRelation
Name | Tür | Description |
---|---|---|
attributes |
object |
Bağlantı öznitelikleri koleksiyonu. |
rel |
string |
İlişki türü. |
url |
string |
Bağlantı URL'si. |