Iterations - List

サービス:

Work

API バージョン:

7.1

時間枠フィルターを使用してチームのイテレーションを取得する

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations?api-version=7.1

省略可能なパラメーターを含む:

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations?$timeframe={$timeframe}&api-version=7.1

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前。
project	path	True	string	プロジェクト ID またはプロジェクト名
team	path		string	チーム ID またはチーム名
api-version	query	True	string	使用する API のバージョン。 このバージョンの API を使用するには、これを '7.1' に設定する必要があります。
$timeframe	query		string	相対時間に基づいてイテレーションが返されるフィルター。 現在サポートされているのは Current のみです。

応答

名前	型	説明
200 OK	TeamSettingsIteration[]	成功した操作

セキュリティ

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	作業項目、クエリ、ボード、領域とイテレーションのパス、およびその他の作業項目追跡関連のメタデータを読み取る機能を付与します。 また、クエリを実行したり、作業項目を検索したり、サービス フックを介して作業項目イベントに関する通知を受信したりすることもできます。

例

Get a team's iterations using timeframe filter

要求のサンプル

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/work/teamsettings/iterations?$timeframe=current&api-version=7.1

応答のサンプル

状態コード:

200

{
  "values": [
    {
      "id": "a589a806-bf11-4d4f-a031-c19813331553",
      "name": "Sprint 2",
      "attributes": {
        "startDate": null,
        "finishDate": null
      },
      "url": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings/iterations/a589a806-bf11-4d4f-a031-c19813331553"
    }
  ]
}

定義

名前	説明
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
TeamIterationAttributes
TeamSettingsIteration	1 回の反復の浅い参照を表します。
TimeFrame	イテレーションの期間 (過去、現在、将来など)。

ReferenceLinks

Object

REST 参照リンクのコレクションを表すクラス。

名前	型	説明
links	object	リンクの読み取りビュー。 参照リンクは読み取り専用であるため、読み取り専用として公開する必要があります。

TeamIterationAttributes

Object

名前	型	説明
finishDate	string (date-time)	イテレーションの終了日。 日付のみ、UTC の午前 0 時に調整されていない修正。
startDate	string (date-time)	イテレーションの開始日。 日付のみ、UTC の午前 0 時に調整されていない修正。
timeFrame	TimeFrame	イテレーションの期間 (過去、現在、将来など)。

TeamSettingsIteration

Object

1 回の反復の浅い参照を表します。

名前	型	説明
_links	ReferenceLinks	リソースに関連するリンクのコレクション
attributes	TeamIterationAttributes	開始日や終了日などのイテレーションの属性。
id	string (uuid)	イテレーションの ID。
name	string	イテレーションの名前。
path	string	イテレーションの相対パス。
url	string	リソースへの完全な http リンク

TimeFrame

列挙

イテレーションの期間 (過去、現在、将来など)。

値	説明
current
future
past