Approvals - Query

リファレンス

サービス:: Approvals And Checks

API バージョン:: 7.1

承認を一覧表示します。これは、パイプライン、ユーザー、またはリソースの保留中の承認のセットを取得するために使用できます。

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?api-version=7.1

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

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?approvalIds={approvalIds}&$expand={$expand}&userIds={userIds}&state={state}&top={top}&api-version=7.1

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前。
project	path	True	string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使用する API のバージョン。このバージョンの API を使用するには、これを '7.1' に設定する必要があります。
$expand	query		ApprovalDetailsExpandParameter	返されるオブジェクトに、これらの追加の詳細を含めます。
approvalIds	query		string (array (uuid))	取得する承認 ID の一覧。
state	query		ApprovalStatus	承認の状態。指定されていない場合は、任意の状態の承認を返します
top	query		integer (int32)	取得する承認の最大数。
userIds	query		string (array (string))	割り当てられたユーザー ID 承認の一覧。ユーザー ID またはユーザー記述子を受け入れます。

応答

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

セキュリティ

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.build	ビルドの結果、定義、要求など、ビルド成果物にアクセスする機能と、サービスフックを介してビルドイベントに関する通知を受信する機能を付与します。

例

要求のサンプル

HTTP

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?approvalIds=ee14f612-6838-43c0-b445-db238ef14153,06239b11-a904-43a1-be6a-0d44026bd121&api-version=7.1

応答のサンプル

状態コード:: 200

request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context

{
  "count": 2,
  "value": [
    {
      "id": "ee14f612-6838-43c0-b445-db238ef14153",
      "steps": [],
      "status": "pending",
      "createdOn": "2020-11-19T08:14:49.58Z",
      "lastModifiedOn": "2020-11-19T08:14:49.5793622Z",
      "executionOrder": "anyOrder",
      "minRequiredApprovers": 1,
      "blockedApprovers": [],
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/approvals/ee14f612-6838-43c0-b445-db238ef14153"
        }
      }
    },
    {
      "id": "06239b11-a904-43a1-be6a-0d44026bd121",
      "steps": [],
      "status": "pending",
      "createdOn": "2020-11-19T09:39:35.28Z",
      "lastModifiedOn": "2020-11-19T09:39:35.2806001Z",
      "executionOrder": "anyOrder",
      "minRequiredApprovers": 1,
      "blockedApprovers": [],
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/approvals/06239b11-a904-43a1-be6a-0d44026bd121"
        }
      }
    }
  ]
}

定義

名前	説明
Approval
ApprovalDetailsExpandParameter	返されるオブジェクトに、これらの追加の詳細を含めます。
ApprovalExecutionOrder	承認者がアクション可能になる順序。
ApprovalPermissions	承認オブジェクトに対する現在のユーザーアクセス許可。
ApprovalStatus	承認の全体的な状態。
ApprovalStep	1 つの承認ステップのデータ。
ApprovalStepHistory	1 つの承認ステップ履歴のデータ。
IdentityRef
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。

Approval

Object

名前	型	説明
_links	ReferenceLinks	承認オブジェクトにアクセスするためのリンクを取得します。
blockedApprovers	IdentityRef[]	承認が許可されていない ID。
createdOn	string (date-time)	承認が作成された日付。
executionOrder	ApprovalExecutionOrder	承認者がアクション可能になる順序。
id	string (uuid)	承認の一意識別子。
instructions	string	承認者の指示。
lastModifiedOn	string (date-time)	承認が最後に変更された日付。
minRequiredApprovers	integer (int32)	承認全体が承認済みと見なされるために承認する必要がある承認者の最小数。
permissions	ApprovalPermissions	承認オブジェクトに対する現在のユーザーアクセス許可。
status	ApprovalStatus	承認の全体的な状態。
steps	ApprovalStep[]	承認に関連付けられているステップの一覧。

ApprovalDetailsExpandParameter

列挙

返されるオブジェクトに、これらの追加の詳細を含めます。

値	説明
none	追加のプロパティはありません。
permissions	承認オブジェクトの現在のユーザーアクセス許可を含めます。
steps	承認に関連付けられている承認手順を含めます。

ApprovalExecutionOrder

列挙

承認者がアクション可能になる順序。

値	説明
anyOrder	承認者が任意の順序で承認できることを示します。
inSequence	承認者が順次 (割り当てられた順序) でのみ承認できることを示します。

ApprovalPermissions

列挙

承認オブジェクトに対する現在のユーザーアクセス許可。

値	説明
none
queueBuild
reassign
resourceAdmin
update
view

ApprovalStatus

列挙

承認の全体的な状態。

値	説明
all
approved	承認が承認されたことを示します。
canceled	承認が取り消されたことを示します。
completed
failed
pending	承認が保留中であることを示します。
rejected	承認が拒否されたことを示します。
skipped	承認がスキップされたことを示します。
timedOut	承認がタイムアウトであることを示します。
undefined
uninitiated	承認が未承認であることを示します。特定の承認者がまだアクションを実行できない場合に、順番に実行する場合に使用されます。

ApprovalStep

Object

1 つの承認ステップのデータ。

名前	型	説明
actualApprover	IdentityRef	承認した ID。
assignedApprover	IdentityRef	承認する必要がある ID。
comment	string	この手順に関連付けられているコメント。
history	ApprovalStepHistory[]	承認ステップの履歴
initiatedOn	string (date-time)	このステップが開始されたタイムスタンプ。
lastModifiedBy	IdentityRef	この手順が最後に変更された ID。
lastModifiedOn	string (date-time)	このステップが最後に変更されたタイムスタンプ。
order	integer (int32)	承認者が承認を許可される順序。
permissions	ApprovalPermissions	ステップの現在のユーザーアクセス許可。
status	ApprovalStatus	この手順の現在の状態。

ApprovalStepHistory

Object

1 つの承認ステップ履歴のデータ。

名前	型	説明
assignedTo	IdentityRef	この承認が割り当てられた ID
comment	string	このステップ履歴に関連付けられているコメント。
createdBy	IdentityRef	このステップ履歴が作成された ID。
createdOn	string (date-time)	このステップ履歴が作成されたタイムスタンプ。

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 は、このグラフの件名のソースリソースへの完全なルートです。

ReferenceLinks

Object

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

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

次の方法で共有

Approvals - Query

URI パラメーター

応答

セキュリティ

oauth2

スコープ

例

要求のサンプル

応答のサンプル

定義

Approval

ApprovalDetailsExpandParameter

ApprovalExecutionOrder

ApprovalPermissions

ApprovalStatus

ApprovalStep

ApprovalStepHistory

IdentityRef

ReferenceLinks