Deliverytimeline - Get
配信ビュー データを取得する
GET https://dev.azure.com/{organization}/{project}/_apis/work/plans/{id}/deliverytimeline?api-version=7.1GET https://dev.azure.com/{organization}/{project}/_apis/work/plans/{id}/deliverytimeline?revision={revision}&startDate={startDate}&endDate={endDate}&api-version=7.1URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
path | True |
string |
配信ビューの識別子 |
|
organization
|
path | True |
string |
Azure DevOps 組織の名前。 |
|
project
|
path | True |
string |
プロジェクト ID またはプロジェクト名 |
|
api-version
|
query | True |
string |
使用する API のバージョン。 このバージョンの API を使用するには、これを '7.1' に設定する必要があります。 |
|
end
|
query |
string (date-time) |
タイムラインの終了日 |
|
|
revision
|
query |
integer (int32) |
データが必要なプランの改訂。 現在のプランが別のリビジョンの場合は、ViewRevisionMismatchException 例外が発生します。 リビジョンを指定しない場合は、最新のリビジョンのデータが取得されます。 |
|
|
start
|
query |
string (date-time) |
タイムラインの開始日 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
成功した操作 |
セキュリティ
oauth2
型:
oauth2
フロー:
accessCode
Authorization URL (承認 URL):
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン 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
スコープ
| 名前 | 説明 |
|---|---|
| vso.work | 作業項目、クエリ、ボード、領域とイテレーションのパス、およびその他の作業項目追跡関連のメタデータを読み取る機能を付与します。 また、クエリを実行したり、作業項目を検索したり、サービス フックを介して作業項目イベントに関する通知を受信したりすることもできます。 |
定義
| 名前 | 説明 |
|---|---|
|
Backlog |
バックログ レベルを表すコントラクト |
|
Delivery |
配信ビューのデータのデータ コントラクト |
|
Parent |
|
|
Team |
1 つの TeamFieldValue を表します |
|
Timeline |
|
|
Timeline |
|
|
Timeline |
|
|
Timeline |
|
|
Timeline |
|
|
Timeline |
|
|
Timeline |
|
|
Timeline |
|
|
Work |
作業項目の色とアイコン。 |
BacklogLevel
バックログ レベルを表すコントラクト
| 名前 | 型 | 説明 |
|---|---|---|
| categoryReferenceName |
string |
対応する WIT カテゴリの参照名 |
| pluralName |
string |
バックログ レベルの複数形の名前 |
| workItemStates |
string[] |
プランに含まれる作業項目の状態のコレクション。 サーバーは、これらの作業項目の種類のみにフィルター処理します。 |
| workItemTypes |
string[] |
指定されたバックログ レベルの有効な作業項目型名のコレクション |
DeliveryViewData
配信ビューのデータのデータ コントラクト
| 名前 | 型 | 説明 |
|---|---|---|
| childIdToParentIdMap |
object |
作業項目の子 ID から親 ID へのマップ |
| criteriaStatus |
タイムラインのフィルター条件の状態 |
|
| endDate |
string (date-time) |
配信ビュー データの終了日 |
| id |
string (uuid) |
|
| maxExpandedTeams |
integer (int32) |
配信計画用に構成できるチームの最大数 |
| parentItemMaps |
親 ID、タイトル、およびすべての子作業項目 ID の間のマッピング |
|
| revision |
integer (int32) |
|
| startDate |
string (date-time) |
配信ビュー データの開始日 |
| teams |
すべてのチーム データ |
|
| workItemDependencies |
integer[] (int32) |
依存関係はあるが違反ではないすべての作業項目 ID の一覧 |
| workItemViolations |
integer[] (int32) |
違反があるすべての作業項目 ID の一覧 |
ParentChildWIMap
| 名前 | 型 | 説明 |
|---|---|---|
| childWorkItemIds |
integer[] (int32) |
|
| id |
integer (int32) |
|
| title |
string |
|
| workItemTypeName |
string |
TeamFieldValue
1 つの TeamFieldValue を表します
| 名前 | 型 | 説明 |
|---|---|---|
| includeChildren |
boolean |
|
| value |
string |
TimelineCriteriaStatus
| 名前 | 型 | 説明 |
|---|---|---|
| message |
string |
|
| type |
TimelineCriteriaStatusCode
| 値 | 説明 |
|---|---|
| invalidFilterClause |
フィルター句の 1 つが無効です。 |
| ok |
エラーなし - フィルターは適切です。 |
| unknown |
不明なエラー。 |
TimelineIterationStatus
| 名前 | 型 | 説明 |
|---|---|---|
| message |
string |
|
| type |
TimelineIterationStatusCode
| 値 | 説明 |
|---|---|
| isOverlapping |
このイテレーションは別のイテレーションと重複し、このイテレーションのデータは返されません。 |
| ok |
エラーなし - 反復データは適切です。 |
TimelineTeamData
| 名前 | 型 | 説明 |
|---|---|---|
| backlog |
このチームに関連付けられているマップされたバックログと一致するバックログ。 |
|
| fieldReferenceNames |
string[] |
作業項目データのフィールド参照名 |
| id |
string (uuid) |
チームの ID |
| isExpanded |
boolean |
このチームのイテレーションと作業項目のデータが取得されました。 IsExpanded false の Teams では、イテレーション、作業項目、フィールド関連のデータが照会されておらず、このデータは含まれません。 true の場合、これらの項目はクエリされ、クエリ対象の範囲内に項目がある場合はデータが存在します。 |
| iterations |
クエリ対象の日付範囲の作業項目を含むイテレーション データ。 |
|
| name |
string |
チームの名前 |
| orderByField |
string |
このチームのフィールド名別の順序 |
| partiallyPagedFieldReferenceNames |
string[] |
部分的にページングされた作業項目のフィールド参照名 (ID、WorkItemType など) |
| partiallyPagedWorkItems |
object[] |
|
| projectId |
string (uuid) |
チームが属しているプロジェクト ID |
| rollupWorkItemTypes |
string[] |
クライアント側でロールアップ データを収集する作業項目の種類 |
| status |
このチームの状態。 |
|
| teamFieldDefaultValue |
string |
チーム フィールドの既定値 |
| teamFieldName |
string |
このチームのチーム フィールド名 |
| teamFieldValues |
チーム フィールドの値 |
|
| workItemTypeColors |
作業項目の種類の色。 |
|
| workItems |
object[] |
チームのイテレーションの下にないチームに関連付けられている作業項目 |
TimelineTeamIteration
| 名前 | 型 | 説明 |
|---|---|---|
| cssNodeId |
string |
イテレーション CSS ノード ID |
| finishDate |
string (date-time) |
イテレーションの終了日 |
| name |
string |
イテレーション名 |
| partiallyPagedWorkItems |
object[] |
このイテレーションで部分的にページングされたすべての作業項目。 |
| path |
string |
反復パス |
| startDate |
string (date-time) |
イテレーションの開始日 |
| status |
このイテレーションの状態 |
|
| workItems |
object[] |
このイテレーションでページングされた作業項目 |
TimelineTeamStatus
| 名前 | 型 | 説明 |
|---|---|---|
| message |
string |
|
| type |
TimelineTeamStatusCode
| 値 | 説明 |
|---|---|
| backlogInError |
バックログが存在しないか、重要な情報が不足しています。 |
| doesntExistOrAccessDenied |
チームが存在しないか、アクセスが拒否されました。 |
| maxTeamFieldsExceeded |
チーム フィールドの最大数 (エリア パス) を超えました。 このチームのチーム データは返されません。 |
| maxTeamsExceeded |
チームの最大数を超えました。 このチームのチーム データは返されません。 |
| missingTeamFieldValue |
チーム フィールドの値は、このチームに対して設定されていません。 このチームのチーム データは返されません |
| noIterationsExist |
チームには、日付範囲を持つイテレーションが 1 つはありません。 |
| ok |
エラーなし - チームのすべてのデータが適切です。 |
WorkItemColor
作業項目の色とアイコン。
| 名前 | 型 | 説明 |
|---|---|---|
| icon |
string |
|
| primaryColor |
string |
|
| workItemTypeName |
string |