Approvals - Update

參考

Service:: Approvals And Checks

API Version:: 7.1-preview.1

更新核准。

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

URI 參數

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

要求本文

名稱	類型	Description
body	ApprovalUpdateParameters[]

回應

名稱	類型	Description
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

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

範例

Sample Request

HTTP

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

Status code:: 200

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

Response Body

{
  "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

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

ApprovalExecutionOrder

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

名稱	類型	Description
anyOrder	string	表示核准者可以依任何順序核准。
inSequence	string	表示核准者只能依順序 (指派順序) 核准。

ApprovalPermissions

核准物件的目前使用者權限。

名稱	類型	Description
none	string
queueBuild	string
reassign	string
resourceAdmin	string
update	string
view	string

ApprovalStatus

核准的整體狀態。

名稱	類型	Description
all	string
approved	string	指出核准已核准。
canceled	string	表示核准已取消。
completed	string
failed	string
pending	string	表示核准為 Pending。
rejected	string	表示核准已拒絕。
skipped	string	表示已略過核准。
timedOut	string	表示核准已逾時。
undefined	string
uninitiated	string	表示核准未初始化。在依循序執行時使用，其中指定的核准者尚無法採取動作。

ApprovalStep

單一核准步驟的資料。

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

ApprovalStepHistory

單一核准步驟歷程記錄的資料。

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

ApprovalUpdateParameters

更新核准物件或其個別步驟的資料。

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

IdentityRef

名稱	類型	Description
_links	ReferenceLinks	此欄位包含圖表主旨的相關零或更多有趣連結。您可以叫用這些連結來取得其他關聯性，或取得此圖表主體的詳細資訊。
descriptor	string	描述項是在系統執行時參考圖形主旨的主要方式。此欄位可唯一識別帳戶和組織之間的相同圖表主旨。
directoryAlias	string	已被取代 - 您可以藉由查詢 IdentityRef 「_links」字典的「self」專案中參考的 Graph 使用者來擷取
displayName	string	這是圖形主體的非唯一顯示名稱。若要變更此欄位，您必須變更來源提供者中的值。
id	string
imageUrl	string	已淘汰 - 可在 IdentityRef 「_links」字典的「avatar」專案中使用
inactive	boolean	已被取代 - 您可以藉由查詢 GraphUser 「_links」字典的「membershipState」專案中所參考的 Graph 成員資格狀態來擷取
isAadIdentity	boolean	已被取代 - 可以從描述元的主旨類型推斷 (描述元.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	已被取代 - 可以從描述元的主旨類型推斷 (描述元.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	已被取代 - 不在 ToIdentityRef 的大部分預先存在實作中使用
uniqueName	string	已被取代 - 請改用 Domain+PrincipalName
url	string	此 URL 是此圖形主體來源資源的完整路由。

ReferenceLinks

表示 REST 參考連結集合的類別。

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

共用方式為