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 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。应将其设置为“7.1-preview.1”才能使用此版本的 API。
$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

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

定义

名称	说明
Approval
ApprovalDetailsExpandParameter	在返回的对象中包含这些附加详细信息。
ApprovalExecutionOrder	审批者可操作的顺序。
ApprovalPermissions	审批对象的当前用户权限。
ApprovalStatus	审批的总体状态。
ApprovalStep	单个审批步骤的数据。
ApprovalStepHistory	单个审批步骤历史记录的数据。
IdentityRef
ReferenceLinks	表示 REST 引用链接集合的类。

Approval

名称	类型	说明
_links	ReferenceLinks	获取用于访问审批对象的链接。
blockedApprovers	IdentityRef[]	不允许批准的标识。
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

单个审批步骤的数据。

名称	类型	说明
actualApprover	IdentityRef	批准者身份。
assignedApprover	IdentityRef	应批准的标识。
comment	string	与此步骤关联的注释。
history	ApprovalStepHistory[]	审批步骤的历史记录
initiatedOn	string	启动此步骤的时间戳。
lastModifiedBy	IdentityRef	上次修改此步骤所依据的标识。
lastModifiedOn	string	上次修改此步骤的时间戳。
order	integer	允许审批者批准的顺序。
permissions	ApprovalPermissions	步骤的当前用户权限。
status	ApprovalStatus	此步骤的当前状态。

ApprovalStepHistory

单个审批步骤历史记录的数据。

名称	类型	说明
assignedTo	IdentityRef	分配了此审批的标识
comment	string	与此步骤历史记录关联的注释。
createdBy	IdentityRef	创建此步骤历史记录时所依据的标识。
createdOn	string	创建此步骤历史记录的时间戳。

IdentityRef

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个相关链接。可以调用这些链接来获取有关此图主题的其他关系或更多详细信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方式。此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string	已弃用 - 可通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName	string	这是图形主题的非唯一显示名称。若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string	已弃用 - 在 IdentityRef“_links”字典的“头像”条目中可用
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 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读。

Share via