Work Items - Create
1 つの作業項目を作成します。
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 パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps 組織の名前です。 |
project
|
path | True |
string |
プロジェクト ID またはプロジェクト名 |
type
|
path | True |
string |
作成する作業項目の作業項目の種類 |
api-version
|
query | True |
string |
使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.3' に設定する必要があります。 |
$expand
|
query |
作業項目属性の展開パラメーター。 使用できるオプションは{なし、リレーション、フィールド、リンク、すべて}です。 |
||
bypass
|
query |
boolean |
この更新プログラムで作業項目の種類の規則を適用しないでください |
|
suppress
|
query |
boolean |
この変更に関する通知は一切発生しません |
|
validate
|
query |
boolean |
作業項目を保存せずに変更のみを検証するかどうかを指定する |
要求本文
Media Types: "application/json-patch+json"
名前 | 型 | 説明 |
---|---|---|
from |
string |
移動/コピー操作のコピー元のパス。 |
op |
パッチ操作 |
|
path |
string |
操作のパス。 配列の場合、0 から始まるインデックスを使用して、配列内の位置を指定できます (例: /menus/0/name)。 配列の末尾に挿入するインデックスの代わりに "-" 文字を使用できます (例: /biscuits/-)。 |
value |
object |
操作の値。 これはプリミティブまたは JToken です。 |
応答
名前 | 型 | 説明 |
---|---|---|
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
名前 | 説明 |
---|---|
vso.work_write | 作業項目とクエリの読み取り、作成、更新、ボード メタデータの更新、読み取り領域とイテレーション パス、関連するメタデータの追跡、クエリの実行、サービス フックを介した作業項目イベントに関する通知の受信を行う機能を付与します。 |
例
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"
}
定義
名前 | 説明 |
---|---|
Json |
JSON パッチ操作の JSON モデル |
Operation |
パッチ操作 |
Reference |
REST 参照リンクのコレクションを表す クラス。 |
Work |
作業項目について説明します。 |
Work |
作業項目のコメントの特定のバージョンへの参照を表します。 |
Work |
作業項目属性の展開パラメーター。 使用可能なオプションは{なし、リレーション、フィールド、リンク、すべて} です。 |
Work |
JsonPatchDocument
JSON パッチ操作の JSON モデル
名前 | 型 | 説明 |
---|---|---|
from |
string |
移動/コピー操作のコピー元のパス。 |
op |
パッチ操作 |
|
path |
string |
操作のパス。 配列の場合、0 から始まるインデックスを使用して、配列内の位置を指定できます (例: /menus/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 |
関連する REST リソースへの参照をリンクします。 |
|
commentVersionRef |
このリビジョンで追加/編集/削除されたコメントの特定のバージョンへの参照。 |
|
fields |
object |
作業項目のフィールドと値のマップ。 |
id |
integer |
作業項目 ID。 |
relations |
作業項目の関係。 |
|
rev |
integer |
作業項目のリビジョン番号。 |
url |
string |
WorkItemCommentVersionRef
作業項目のコメントの特定のバージョンへの参照を表します。
名前 | 型 | 説明 |
---|---|---|
commentId |
integer |
コメントに割り当てられた ID。 |
createdInRevision |
integer |
[Internal]このコメントが最初に追加された作業項目のリビジョン。 |
isDeleted |
boolean |
[Internal]コメントが削除されたかどうかを指定します。 |
text |
string |
[Internal]コメントのテキスト。 |
url |
string |
|
version |
integer |
バージョン番号。 |
WorkItemExpand
作業項目属性の展開パラメーター。 使用可能なオプションは{なし、リレーション、フィールド、リンク、すべて} です。
名前 | 型 | 説明 |
---|---|---|
all |
string |
すべて展開します。 |
fields |
string |
フィールド作業項目が展開されます。 |
links |
string |
作業項目の展開をリンクします。 |
none |
string |
既定の動作。 |
relations |
string |
リレーション作業項目が展開されます。 |
WorkItemRelation
名前 | 型 | 説明 |
---|---|---|
attributes |
object |
リンク属性のコレクション。 |
rel |
string |
関係の種類。 |
url |
string |
リンク URL。 |