Approvals - Update

リファレンス

サービス:: Release

API バージョン:: 7.1

承認の状態を更新する

PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/approvals/{approvalId}?api-version=7.1

URI パラメーター

名前	/	必須	型	説明
approvalId	path	True	integer (int32)	承認の ID。
organization	path	True	string	Azure DevOps 組織の名前。
project	path	True	string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使用する API のバージョン。このバージョンの API を使用するには、これを '7.1' に設定する必要があります。

要求本文

名前	型	説明
approvalType	ApprovalType	承認の種類を取得または設定します。
approvedBy	IdentityRef	承認した ID を取得します。
approver	IdentityRef	承認する必要がある ID を取得または設定します。
attempt	integer (int32)	どのデプロイ試行が属するかを指定する試行を取得または設定します。
comments	string	承認のコメントを取得または設定します。
createdOn	string (date-time)	作成日を取得します。
history	ReleaseApprovalHistory[]	この承認に関連付けられているすべての承認を指定する履歴を取得します。
id	integer (int32)	このフィールドの一意識別子を取得します。
isAutomated	boolean	承認が自動化されているかどうかを取得または設定します。
modifiedOn	string (date-time)	変更された日付を取得します。
rank	integer (int32)	承認の順序を指定するランクを取得または設定します。たとえば、同じランクは並列承認を表します。
release	ReleaseShallowReference	この承認が関連付けられているリリースの参照を指定する releaseReference を取得します。
releaseDefinition	ReleaseDefinitionShallowReference	この承認が関連付けられているリリース定義の参照を指定する releaseDefinitionReference を取得します。
releaseEnvironment	ReleaseEnvironmentShallowReference	この承認が関連付けられているリリース環境の参照を指定する releaseEnvironmentReference を取得します。
revision	integer (int32)	リビジョン番号を取得します。
status	ApprovalStatus	承認の状態を取得または設定します。
url	string	承認にアクセスするための URL を取得します。

応答

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

セキュリティ

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.release_manage	フォルダー、リリース、リリース定義、リリース環境など、リリース成果物の読み取り、更新、削除を行う機能と、新しいリリースをキューに登録して承認する機能を付与します。

例

Approve a release

要求のサンプル

HTTP

PATCH https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/approvals/{approvalId}?api-version=7.1

{
  "status": "approved",
  "comments": "Good to go!"
}

応答のサンプル

状態コード:: 200

{
  "id": 20,
  "revision": 1,
  "approver": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabfiber@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "approvedBy": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabfiber@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "approvalType": "preDeploy",
  "createdOn": "2017-05-31T18:07:40.45Z",
  "modifiedOn": "2017-05-31T18:08:09.577Z",
  "status": "approved",
  "comments": "Good to go!",
  "isAutomated": false,
  "isNotificationOn": true,
  "trialNumber": 1,
  "attempt": 1,
  "rank": 1,
  "history": [],
  "release": {
    "id": 3,
    "name": "Release-3",
    "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/3",
    "_links": {}
  },
  "releaseDefinition": {
    "id": 1,
    "name": "MyShuttle.CD",
    "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
    "_links": {}
  },
  "releaseEnvironment": {
    "id": 9,
    "name": "Dev",
    "_links": {}
  },
  "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/approvals/20"
}

定義

名前	説明
ApprovalStatus	承認の状態を取得または設定します。
ApprovalType	承認の種類を取得または設定します。
IdentityRef
ProjectReference
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
ReleaseApproval
ReleaseApprovalHistory
ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseShallowReference

ApprovalStatus

列挙

承認の状態を取得または設定します。

値	説明
approved	承認が承認されたことを示します。
canceled	承認が取り消されたことを示します。
pending	承認が保留中であることを示します。
reassigned	承認が再割り当てされたことを示します。
rejected	承認が拒否されたことを示します。
skipped	承認がスキップされたことを示します。
undefined	承認に状態が設定されていないことを示します。

ApprovalType

列挙

承認の種類を取得または設定します。

値	説明
all	すべての承認を示します。
postDeploy	デプロイ後に実行された承認を示します。
preDeploy	デプロイ前に実行された承認を示します。
undefined	承認の種類が設定されていないことを示します。

IdentityRef

Object

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する興味深いリンクが 0 個以上含まれています。これらのリンクを呼び出して、このグラフの件名に関する追加のリレーションシップや詳細情報を取得できます。
descriptor	string	記述子は、システムの実行中にグラフの件名を参照する主な方法です。このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias	string	非推奨 - IdentityRef "_links" ディクショナリの "自己" エントリで参照されている 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 は、このグラフの件名のソースリソースへの完全なルートです。

ProjectReference

Object

名前	型	説明
id	string (uuid)	このフィールドの一意識別子を取得します。
name	string	プロジェクトの名前を取得します。

ReferenceLinks

Object

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

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

ReleaseApproval

Object

名前	型	説明
approvalType	ApprovalType	承認の種類を取得または設定します。
approvedBy	IdentityRef	承認した ID を取得します。
approver	IdentityRef	承認する必要がある ID を取得または設定します。
attempt	integer (int32)	どのデプロイ試行が属するかを指定する試行を取得または設定します。
comments	string	承認のコメントを取得または設定します。
createdOn	string (date-time)	作成日を取得します。
history	ReleaseApprovalHistory[]	この承認に関連付けられているすべての承認を指定する履歴を取得します。
id	integer (int32)	このフィールドの一意識別子を取得します。
isAutomated	boolean	承認が自動化されているかどうかを取得または設定します。
modifiedOn	string (date-time)	変更された日付を取得します。
rank	integer (int32)	承認の順序を指定するランクを取得または設定します。たとえば、同じランクは並列承認を表します。
release	ReleaseShallowReference	この承認が関連付けられているリリースの参照を指定する releaseReference を取得します。
releaseDefinition	ReleaseDefinitionShallowReference	この承認が関連付けられているリリース定義の参照を指定する releaseDefinitionReference を取得します。
releaseEnvironment	ReleaseEnvironmentShallowReference	この承認が関連付けられているリリース環境の参照を指定する releaseEnvironmentReference を取得します。
revision	integer (int32)	リビジョン番号を取得します。
status	ApprovalStatus	承認の状態を取得または設定します。
url	string	承認にアクセスするための URL を取得します。

ReleaseApprovalHistory

Object

名前	型	説明
approver	IdentityRef	承認者の ID。
changedBy	IdentityRef	承認を変更したオブジェクトの ID。
comments	string	承認履歴のコメント。
createdOn	string (date-time)	この承認が作成された時刻。
modifiedOn	string (date-time)	この承認が変更された時刻。
revision	integer (int32)	承認履歴のリビジョン。

ReleaseDefinitionShallowReference

Object

名前	型	説明
_links	ReferenceLinks	リリース定義の関連リソース、API、およびビューへのリンクを取得します。
id	integer (int32)	リリース定義の一意識別子を取得します。
name	string	リリース定義の名前を取得または設定します。
path	string	リリース定義のパスを取得または設定します。
projectReference	ProjectReference	プロジェクト参照を取得または設定します。
url	string	リリース定義にアクセスするための REST API URL を取得します。

ReleaseEnvironmentShallowReference

Object

名前	型	説明
_links	ReferenceLinks	リリース環境の関連リソース、API、およびビューへのリンクを取得します。
id	integer (int32)	リリース環境の一意識別子を取得します。
name	string	リリース環境の名前を取得または設定します。
url	string	リリース環境にアクセスするための REST API URL を取得します。

ReleaseShallowReference

Object

名前	型	説明
_links	ReferenceLinks	リリースの関連リソース、API、およびビューへのリンクを取得します。
id	integer (int32)	リリースの一意識別子を取得します。
name	string	リリースの名前を取得または設定します。
url	string	リリースにアクセスするための REST API URL を取得します。