Approvals - Query

Service:

Approvals And Checks

API Version:

7.1-preview.1

列出核准。 這可用來取得管線、用戶或資源的一組擱置核准。

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

With optional parameters:

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 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
project	path	True	string	項目識別碼或項目名稱
api-version	query	True	string	要使用的 API 版本。 這應該設定為 『7.1-preview.1』 以使用此版本的 API。
$expand	query		ApprovalDetailsExpandParameter	在傳回的物件中包含這些其他詳細數據。
approvalIds	query		string array (uuid)	要取得的核准標識碼清單。
state	query		ApprovalStatus	核准狀態。 如果未提供，則傳回任何狀態的核准
top	query		integer int32	要取得的核准數目上限。
userIds	query		string array (string)	指派給的使用者標識碼核准清單。 接受使用者識別碼或使用者描述項。

回應

名稱	類型	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	授與存取組建成品的能力，包括建置結果、定義和要求，以及透過服務勾點接收建置事件相關通知的能力。

範例

Sample Request

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

Sample Response

Status code:

200

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

Response Body

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

定義

名稱	Description
Approval
ApprovalDetailsExpandParameter	在傳回的物件中包含這些其他詳細數據。
ApprovalExecutionOrder	核准者可採取動作的順序。
ApprovalPermissions	核准物件的目前用戶權力。
ApprovalStatus	核准的整體狀態。
ApprovalStep	單一核准步驟的數據。
ApprovalStepHistory	單一核准步驟歷程記錄的數據。
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[]	與核准相關聯的步驟清單。

ApprovalDetailsExpandParameter

在傳回的物件中包含這些其他詳細數據。

名稱	類型	Description
none	string	沒有其他屬性。
permissions	string	包含核准物件的目前用戶權力。
steps	string	包含與核准相關聯的核准步驟。

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	表示核准為擱置中。
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	建立此步驟歷程記錄的時間戳。

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	已被取代 - 可以從描述元的主旨類型推斷 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	已被取代 - 可以從描述元的主旨類型推斷 (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	已淘汰 - 不在 ToIdentityRef 的大多數既有實作中使用
uniqueName	string	已淘汰 - 請改用 Domain+PrincipalName
url	string	此 URL 是此圖表主體來源資源的完整路由。

ReferenceLinks

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

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