Reporting Work Item Revisions - Read Reporting Revisions Post
作業項目のリビジョンのバッチを取得します。 この要求は、フィールドのリストが長さの制限を超えて URL を実行できる十分な大きさの場合に使用できます。
POST https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemrevisions?api-version=4.1
POST https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemrevisions?continuationToken={continuationToken}&startDateTime={startDateTime}&$expand={$expand}&api-version=4.1
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps 組織の名前です。 |
project
|
path |
string |
プロジェクト ID またはプロジェクト名 |
|
api-version
|
query | True |
string |
使う API のバージョン。 このバージョンの API を使用するには、これを '4.1' に設定する必要があります。 |
$expand
|
query | |||
continuation
|
query |
string |
バッチを開始する基準値を指定します。 リビジョンの最初のバッチを取得するには、このパラメーターを省略します。 |
|
start
|
query |
string date-time |
リビジョンの開始点として使用する日付/時刻。すべてのリビジョンは、この日付/時刻より後に発生します。 'watermark' パラメーターと組み合わせて使用することはできません。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
fields |
string[] |
作業項目のリビジョンで返されるフィールドの一覧。 レポート可能なすべてのフィールドを取得するには、このパラメーターを省略します。 |
includeDeleted |
boolean |
削除された作業項目を結果に含めます。 |
includeIdentityRef |
boolean |
ID フィールドの文字列値ではなく、ID 参照を返します。 |
includeLatestOnly |
boolean |
作業項目の以前のすべてのリビジョンをスキップして、作業項目の最新バージョンのみを含めます。 |
includeTagRef |
boolean |
System.Tags フィールドの文字列値の代わりにタグ参照を含める |
types |
string[] |
結果を特定の作業項目の種類にフィルター処理する型の一覧。 すべての作業項目の種類の作業項目のリビジョンを取得するには、このパラメーターを省略します。 |
応答
名前 | 型 | 説明 |
---|---|---|
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 | 作業項目、クエリ、ボード、領域とイテレーションのパス、およびその他の作業項目追跡関連のメタデータを読み取る機能を付与します。 また、サービス フックを使用して、クエリを実行したり、作業項目イベントに関する通知を受信したりすることもできます。 |
例
Sample Request
POST https://dev.azure.com/fabrikam/_apis/wit/reporting/workitemrevisions?continuationToken=813;350;1&api-version=4.1
{
"types": [
"Bug",
"Task",
"Product Backlog Item"
],
"fields": [
"System.WorkItemType",
"System.Title",
"System.AreaPath"
],
"includeIdentityRef": true
}
Sample Response
{
"values": [
{
"id": 3,
"rev": 8,
"fields": {
"System.AreaPath": "Fabrikam-Fiber-Git",
"System.WorkItemType": "Product Backlog Item",
"System.Title": "Technician can submit invoices on Windows Phone"
}
}
],
"nextLink": "https://dev.azure.com/fabrikam/_apis/wit/reporting/workItemRevisions?continuationToken=842;5;3&api-version=2.0",
"isLastBatch": true
}
定義
名前 | 説明 |
---|---|
Reporting |
|
Reporting |
|
Reporting |
ReportingRevisionsExpand
名前 | 型 | 説明 |
---|---|---|
fields |
string |
|
none |
string |
ReportingWorkItemRevisionsBatch
名前 | 型 | 説明 |
---|---|---|
continuationToken |
string |
|
isLastBatch |
boolean |
|
nextLink |
string |
|
values |
string[] |
ReportingWorkItemRevisionsFilter
名前 | 型 | 説明 |
---|---|---|
fields |
string[] |
作業項目のリビジョンで返されるフィールドの一覧。 レポート可能なすべてのフィールドを取得するには、このパラメーターを省略します。 |
includeDeleted |
boolean |
削除された作業項目を結果に含めます。 |
includeIdentityRef |
boolean |
ID フィールドの文字列値ではなく、ID 参照を返します。 |
includeLatestOnly |
boolean |
作業項目の以前のすべてのリビジョンをスキップして、作業項目の最新バージョンのみを含めます。 |
includeTagRef |
boolean |
System.Tags フィールドの文字列値の代わりにタグ参照を含める |
types |
string[] |
結果を特定の作業項目の種類にフィルター処理する型の一覧。 すべての作業項目の種類の作業項目のリビジョンを取得するには、このパラメーターを省略します。 |