次の方法で共有


Approvals - Update

承認を更新します。

PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?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' に設定する必要があります。

要求本文

名前 説明
body

ApprovalUpdateParameters[]

応答

名前 説明
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_execute ビルドの結果、定義、要求など、ビルド成果物にアクセスする機能、ビルドのキューに登録する機能、ビルド プロパティを更新する機能、およびサービス フックを介してビルド イベントに関する通知を受け取る機能を付与します。
vso.pipelineresources_use 保護されたリソース (エージェント プール、環境、キュー、リポジトリ、セキュリティで保護されたファイル、サービス接続、変数グループ) を使用するパイプラインの要求を承認する機能を付与します。

Sample Request

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

[
  {
    "approvalId": "aab27959-a5be-4ee3-97ca-f19b3602cd2f",
    "comment": "Approving",
    "status": "approved"
  }
]

Sample Response

request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context
{
  "count": 1,
  "value": [
    {
      "id": "aab27959-a5be-4ee3-97ca-f19b3602cd2f",
      "steps": [
        {
          "assignedApprover": {
            "displayName": "User Name",
            "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
            "uniqueName": "uniqueName",
            "descriptor": "Descriptor"
          },
          "actualApprover": {
            "displayName": "User Name",
            "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
            "uniqueName": "uniqueName",
            "descriptor": "Descriptor"
          },
          "status": "approved",
          "comment": "Approving",
          "lastModifiedOn": "2020-11-19T09:57:54.252505Z",
          "order": 1,
          "lastModifiedBy": {
            "displayName": "User Name",
            "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
            "uniqueName": "uniqueName",
            "descriptor": "Descriptor"
          },
          "initiatedOn": "2020-11-19T09:51:16.7045043Z",
          "history": []
        }
      ],
      "status": "approved",
      "createdOn": "2020-11-19T09:51:16.703Z",
      "lastModifiedOn": "2020-11-19T09:57:54.252505Z",
      "executionOrder": "anyOrder",
      "minRequiredApprovers": 1,
      "blockedApprovers": [],
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/approvals/aab27959-a5be-4ee3-97ca-f19b3602cd2f"
        }
      }
    }
  ]
}

定義

名前 説明
Approval
ApprovalExecutionOrder

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

ApprovalPermissions

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

ApprovalStatus

承認の全体的な状態。

ApprovalStep

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

ApprovalStepHistory

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

ApprovalUpdateParameters

承認オブジェクトまたはその個々のステップを更新するデータ。

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[]

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

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

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

ApprovalUpdateParameters

承認オブジェクトまたはその個々のステップを更新するデータ。

名前 説明
approvalId

string

更新する承認の ID。

assignedApprover

IdentityRef

現在の承認者。

comment

string

コメントを取得または設定します。

reassignTo

IdentityRef

再割り当てされた承認者。

status

ApprovalStatus

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

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

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