Approvals - Update

參考

服務:: Approvals And Checks

API 版本:: 7.1

更新核准。

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

URI 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
project	path	True	string	項目識別碼或項目名稱
api-version	query	True	string	要使用的 API 版本。這應該設定為『7.1』以使用此版本的 API。

要求本文

名稱	類型	Description
body	ApprovalUpdateParameters[]

回應

名稱	類型	Description
200 OK	Approval[]	成功作業

安全性

oauth2

類型: oauth2
Flow: accessCode
授權 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
權杖 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

範圍

名稱	Description
vso.build_execute	授與存取組建成品的能力，包括建置結果、定義和要求，以及能夠將組建排入佇列、更新組建屬性，以及透過服務攔截接收建置事件的相關通知的能力。
vso.pipelineresources_use	授與核准管線使用受保護資源的要求的能力：代理程式集區、環境、佇列、存放庫、安全檔案、服務聯機和變數群組

範例

範例要求

HTTP

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

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

範例回覆

狀態碼:: 200

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"
        }
      }
    }
  ]
}

定義

名稱	Description
Approval
ApprovalExecutionOrder	核准者可採取動作的順序。
ApprovalPermissions	核准物件的目前用戶權力。
ApprovalStatus	核准的整體狀態。
ApprovalStep	單一核准步驟的數據。
ApprovalStepHistory	單一核准步驟歷程記錄的數據。
ApprovalUpdateParameters	更新核准物件或其個別步驟的數據。
IdentityRef
ReferenceLinks	表示 REST 參考連結集合的類別。

Approval

Object

名稱	類型	Description
_links	ReferenceLinks	取得存取核准對象的連結。
blockedApprovers	IdentityRef[]	不允許核准的身分識別。
createdOn	string (date-time)	建立核准的日期。
executionOrder	ApprovalExecutionOrder	核准者可採取動作的順序。
id	string (uuid)	核准的唯一標識碼。
instructions	string	核准者的指示。
lastModifiedOn	string (date-time)	上次修改核准的日期。
minRequiredApprovers	integer (int32)	應核准整個核准的核准者數目下限，才會被視為已核准。
permissions	ApprovalPermissions	核准物件的目前用戶權力。
status	ApprovalStatus	核准的整體狀態。
steps	ApprovalStep[]	與核准相關聯的步驟清單。

ApprovalExecutionOrder

列舉型別

核准者可採取動作的順序。

值	Description
anyOrder	表示核准者可以依任何順序核准。
inSequence	表示核准者只能依循序核准（指派的順序）。

ApprovalPermissions

列舉型別

核准物件的目前用戶權力。

值	Description
none
queueBuild
reassign
resourceAdmin
update
view

ApprovalStatus

列舉型別

核准的整體狀態。

值	Description
all
approved	表示核准已核准。
canceled	表示核准已取消。
completed
failed
pending	表示核准為 [擱置]。
rejected	表示核准已拒絕。
skipped	表示已略過核准。
timedOut	表示核准已逾時。
undefined
uninitiated	表示核准未初始化。以順序執行時使用，其中指定的核准者尚無法採取動作。

ApprovalStep

Object

單一核准步驟的數據。

名稱	類型	Description
actualApprover	IdentityRef	已核准的身分識別。
assignedApprover	IdentityRef	應核准的身分識別。
comment	string	與此步驟相關聯的批注。
history	ApprovalStepHistory[]	核准步驟的歷程記錄
initiatedOn	string (date-time)	起始此步驟的時間戳。
lastModifiedBy	IdentityRef	上次修改此步驟的身分識別。
lastModifiedOn	string (date-time)	上次修改此步驟的時間戳。
order	integer (int32)	允許核准者核准的順序。
permissions	ApprovalPermissions	步驟的目前用戶權力。
status	ApprovalStatus	此步驟的目前狀態。

ApprovalStepHistory

Object

單一核准步驟歷程記錄的數據。

名稱	類型	Description
assignedTo	IdentityRef	獲指派此核准的身分識別
comment	string	與此步驟歷程記錄相關聯的批注。
createdBy	IdentityRef	建立此步驟歷程記錄的身分識別。
createdOn	string (date-time)	建立此步驟歷程記錄的時間戳。

ApprovalUpdateParameters

Object

更新核准物件或其個別步驟的數據。

名稱	類型	Description
approvalId	string (uuid)	要更新之核准的標識碼。
assignedApprover	IdentityRef	目前的核准者。
comment	string	取得或設定批注。
reassignTo	IdentityRef	重新指派核准者。
status	ApprovalStatus	取得或設定狀態。

IdentityRef

Object

名稱	類型	Description
_links	ReferenceLinks	此欄位包含圖表主旨的相關零或更多有趣連結。您可以叫用這些連結，以取得此圖表主題的其他關聯性或更詳細的資訊。
descriptor	string	描述元是在系統執行時參考圖表主旨的主要方式。此欄位會唯一識別帳戶和組織之間的相同圖表主題。
directoryAlias	string	已淘汰 - 查詢 IdentityRef “_links” 字典中參考的 Graph 使用者，即可擷取
displayName	string	這是圖形主體的非唯一顯示名稱。若要變更此欄位，您必須在來源提供者中變更其值。
id	string
imageUrl	string	已淘汰 - 可在 IdentityRef “_links” 字典的 “avatar” 專案中取得
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 參考連結集合的類別。

名稱	類型	Description
links	object	連結的只讀檢視。因為參考連結是只讀的，所以我們只想要將其公開為只讀。

共用方式為

Approvals - Update

URI 參數

要求本文

回應

安全性

oauth2

範圍

範例

範例要求

範例回覆

定義

Approval

ApprovalExecutionOrder

ApprovalPermissions

ApprovalStatus

ApprovalStep

ApprovalStepHistory

ApprovalUpdateParameters

IdentityRef

ReferenceLinks

其他資源