次の方法で共有


Approvals - Query

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

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?api-version=7.1-preview.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-preview.1

URI パラメーター

名前 / 必須 説明
organization
path True

string

Azure DevOps 組織の名前です。

project
path True

string

プロジェクト ID またはプロジェクト名

api-version
query True

string

使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.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

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

Sample Request

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-preview.1

Sample Response

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

名前 説明
_links

ReferenceLinks

承認オブジェクトにアクセスするためのリンクを取得します。

blockedApprovers

IdentityRef[]

承認が許可されていない ID。

createdOn

string

承認が作成された日付。

executionOrder

ApprovalExecutionOrder

承認者が実行可能になる順序。

id

string

承認の一意識別子。

instructions

string

承認者向けの手順。

lastModifiedOn

string

承認が最後に変更された日付。

minRequiredApprovers

integer

承認全体を承認済みと見なすために承認する必要がある承認者の最小数。

permissions

ApprovalPermissions

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

status

ApprovalStatus

承認の全体的な状態。

steps

ApprovalStep[]

承認に関連付けられているステップの一覧。

ApprovalDetailsExpandParameter

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

名前 説明
none

string

追加のプロパティはありません。

permissions

string

承認オブジェクトの現在のユーザーアクセス許可を含めます。

steps

string

承認に関連付けられている承認手順を含めます。

ApprovalExecutionOrder

承認者が実行可能になる順序。

名前 説明
anyOrder

string

承認者が任意の順序で承認できることを示します。

inSequence

string

承認者が順番に承認できる (割り当てられた注文) ことを示します。

ApprovalPermissions

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

名前 説明
none

string

queueBuild

string

reassign

string

resourceAdmin

string

update

string

view

string

ApprovalStatus

承認の全体的な状態。

名前 説明
all

string

approved

string

承認が承認済みであることを示します。

canceled

string

承認が取り消されたことを示します。

completed

string

failed

string

pending

string

承認が保留中であることを示します。

rejected

string

承認が拒否されたことを示します。

skipped

string

承認がスキップされたことを示します。

timedOut

string

承認がタイムアウトであることを示します。

undefined

string

uninitiated

string

承認が未承認であることを示します。 指定された承認者がまだアクション可能でない場合に、 を順番に実行する場合に使用されます。

ApprovalStep

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

名前 説明
actualApprover

IdentityRef

承認した ID。

assignedApprover

IdentityRef

承認する必要がある ID。

comment

string

この手順に関連付けられているコメント。

history

ApprovalStepHistory[]

承認ステップの履歴

initiatedOn

string

このステップが開始されたタイムスタンプ。

lastModifiedBy

IdentityRef

この手順が最後に変更された ID。

lastModifiedOn

string

このステップが最後に変更されたタイムスタンプ。

order

integer

承認者が承認を許可される順序。

permissions

ApprovalPermissions

ステップの現在のユーザー アクセス許可。

status

ApprovalStatus

このステップの現在の状態。

ApprovalStepHistory

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

名前 説明
assignedTo

IdentityRef

この承認が割り当てられた ID

comment

string

このステップ履歴に関連付けられているコメント。

createdBy

IdentityRef

このステップ履歴が作成された ID。

createdOn

string

このステップ履歴が作成されたタイムスタンプ。

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

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

名前 説明
links

object

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