Plans - Get

Service:

Work

API Version:

7.1-preview.1

指定したプランの情報を取得する

GET https://dev.azure.com/{organization}/{project}/_apis/work/plans/{id}?api-version=7.1-preview.1

URI パラメーター

名前	/	必須	型	説明
id	path	True	string	プランの識別子
organization	path	True	string	Azure DevOps 組織の名前です。
project	path	True	string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。

応答

名前	型	説明
200 OK	Plan	正常な操作

セキュリティ

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

定義

名前	説明
IdentityRef
Plan	プラン定義のデータ コントラクト
PlanType	作成するプランの種類。
PlanUserPermissions	ユーザーがプランに対して持っているアクセス許可のセットを示すビット フラグ。
ReferenceLinks	REST 参照リンクのコレクションを表す クラス。

IdentityRef

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。 これらのリンクを呼び出して、このグラフの主題に関する追加のリレーションシップや詳細情報を取得できます。
descriptor	string	記述子は、システムの実行中にグラフの件名を参照する主な方法です。 このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias	string	非推奨 - IdentityRef "_links" ディクショナリの "self" エントリで参照されている Graph ユーザーにクエリを実行することで取得できます
displayName	string	これは、グラフの件名の一意でない表示名です。 このフィールドを変更するには、ソース プロバイダーでその値を変更する必要があります。
id	string
imageUrl	string	非推奨 - IdentityRef "_links" ディクショナリの "アバター" エントリで使用できます
inactive	boolean	非推奨 - GraphUser "_links" ディクショナリの "membershipState" エントリで参照されている Graph メンバーシップの状態を照会することで取得できます
isAadIdentity	boolean	非推奨 - 記述子のサブジェクト型 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) から推論できます
isContainer	boolean	非推奨 - 記述子のサブジェクト型 (Descriptor.IsGroupType) から推論できます
isDeletedInOrigin	boolean
profileUrl	string	非推奨 - ToIdentityRef の既存のほとんどの実装では使用されていません
uniqueName	string	非推奨 - 代わりに Domain+PrincipalName を使用します
url	string	この URL は、このグラフの件名のソース リソースへの完全なルートです。

Plan

プラン定義のデータ コントラクト

名前	型	説明
createdByIdentity	IdentityRef	このプランを作成した ID。 ScaledAgileViewComponent4 にアップグレードする前のレコードの既定値は null です。
createdDate	string	プランが作成された日付
description	string	プランの説明
id	string	プランの ID
lastAccessed	string	プランが最後にアクセスされた日付。 既定値は Null です。
modifiedByIdentity	IdentityRef	このプランを最後に変更した ID。 ScaledAgileViewComponent4 にアップグレードする前のレコードの既定値は null です。
modifiedDate	string	プランが最後に変更された日付。 プランが最初に作成されるときに、既定で CreatedDate に設定されます。
name	string	プランの名前
properties	object	プランに関連付けられている PlanPropertyCollection インスタンス。 これらはプランの種類によって異なります。 たとえば、DeliveryTimelineView は DeliveryViewPropertyCollection 型になります。
revision	integer	プランの改訂。 ユーザーが互いの変更を上書きしないように保護するために使用されます。
type	PlanType	プランの種類
url	string	rest api を使用してプランを検索するリソース URL
userPermissions	PlanUserPermissions	ユーザーがプランに対して持っているアクセス許可のセットを示すビット フラグ。

PlanType

作成するプランの種類。

名前	型	説明
deliveryTimelineView	string

PlanUserPermissions

ユーザーがプランに対して持っているアクセス許可のセットを示すビット フラグ。

名前	型	説明
allPermissions	string	このプランのフル コントロールアクセス許可。
delete	string	このプランを削除するアクセス許可。
edit	string	このプランを更新するためのアクセス許可。
manage	string	このプランを管理するためのアクセス許可。
none	string	None
view	string	このプランを表示するアクセス許可。

ReferenceLinks

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

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