Projects - Update

Service:

Core

API Version:

7.1-preview.4

既存のプロジェクトの名前、省略形、説明を更新するか、プロジェクトを復元します。

PATCH https://dev.azure.com/{organization}/_apis/projects/{projectId}?api-version=7.1-preview.4

URI パラメーター

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

要求本文

名前	型	説明
_links	ReferenceLinks	このオブジェクトに関連する他のオブジェクトへのリンク。
abbreviation	string	プロジェクトの省略形。
capabilities	object	このプロジェクトが持つ一連の機能 (プロセス テンプレート & バージョン管理など)。
defaultTeam	WebApiTeamRef	既定のチームへの浅い参照。
defaultTeamImageUrl	string	既定のチーム ID イメージへの URL。
description	string	プロジェクトの説明 (存在する場合)。
id	string	プロジェクト識別子。
lastUpdateTime	string	プロジェクトの最終更新時刻。
name	string	プロジェクト名。
revision	integer	プロジェクトリビジョン。
state	ProjectState	プロジェクトの状態。
url	string	オブジェクトの完全なバージョンへの URL。
visibility	ProjectVisibility	プロジェクトの可視性。

応答

名前	型	説明
200 OK	OperationReference	成功した操作

セキュリティ

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.project_write	プロジェクトとチームの読み取りと更新を行う機能を付与します。

定義

名前	説明
OperationReference	非同期操作の参照。
OperationStatus	操作の現在の状態。
ProjectState	プロジェクトの現在の状態。
ProjectVisibility	プロジェクトが表示されるユーザーを示します。
ReferenceLinks	REST 参照リンクのコレクションを表す クラス。
TeamProject	Team Project オブジェクトを表します。
WebApiTeamRef

OperationReference

非同期操作の参照。

名前	型	説明
id	string	操作の一意識別子。
pluginId	string	プラグインの一意識別子。
status	OperationStatus	操作の現在の状態。
url	string	完全な操作オブジェクトを取得する URL。

OperationStatus

操作の現在の状態。

名前	型	説明
cancelled	string	操作はユーザーによって取り消されました。
failed	string	操作が失敗して完了しました。
inProgress	string	操作が進行中です。
notSet	string	操作に状態が設定されていません。
queued	string	操作はキューに登録されています。
succeeded	string	操作は正常に完了しました。

ProjectState

プロジェクトの現在の状態。

名前	型	説明
all	string	[削除済み] を除く状態に関係なく、すべてのプロジェクト。
createPending	string	プロジェクトは作成のためにキューに登録されていますが、プロセスはまだ開始されていません。
deleted	string	プロジェクトが削除されました。
deleting	string	プロジェクトは削除中です。
new	string	プロジェクトは作成中です。
unchanged	string	プロジェクトは変更されていません。
wellFormed	string	プロジェクトは完全に作成され、使用できる状態になります。

ProjectVisibility

プロジェクトが表示されるユーザーを示します。

名前	型	説明
private	string	プロジェクトは、明示的なアクセス権を持つユーザーにのみ表示されます。
public	string	プロジェクトはすべてのユーザーに表示されます。

ReferenceLinks

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

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

TeamProject

Team Project オブジェクトを表します。

名前	型	説明
_links	ReferenceLinks	このオブジェクトに関連する他のオブジェクトへのリンク。
abbreviation	string	プロジェクトの省略形。
capabilities	object	このプロジェクトが持つ一連の機能 (プロセス テンプレート & バージョン管理など)。
defaultTeam	WebApiTeamRef	既定のチームへの浅い参照。
defaultTeamImageUrl	string	既定のチーム ID イメージへの URL。
description	string	プロジェクトの説明 (存在する場合)。
id	string	プロジェクト識別子。
lastUpdateTime	string	プロジェクトの最終更新時刻。
name	string	プロジェクト名。
revision	integer	プロジェクトリビジョン。
state	ProjectState	プロジェクトの状態。
url	string	オブジェクトの完全なバージョンへの URL。
visibility	ProjectVisibility	プロジェクトの可視性。

WebApiTeamRef

名前	型	説明
id	string	チーム (ID) Guid。 Team Foundation ID。
name	string	チーム名
url	string	Team REST API Url