Approvals - Update

参考

服务:: Release

API 版本:: 7.1

更新审批状态

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

URI 参数

名称	在	必需	类型	说明
approvalId	path	True	integer (int32)	审批的 ID。
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1”才能使用此版本的 API。

请求正文

名称	类型	说明
approvalType	ApprovalType	获取或设置审批的类型。
approvedBy	IdentityRef	获取已批准的标识。
approver	IdentityRef	获取或设置应批准的身份。
attempt	integer (int32)	获取或设置指定其所属部署尝试的尝试。
comments	string	获取或设置审批的注释。
createdOn	string (date-time)	获取其创建日期。
history	ReleaseApprovalHistory[]	获取指定与此审批关联的所有审批的历史记录。
id	integer (int32)	获取此字段的唯一标识符。
isAutomated	boolean	获取或设置审批是自动化的。
modifiedOn	string (date-time)	获取修改日期。
rank	integer (int32)	获取或设置指定审批顺序的排名。例如，同一排名表示并行审批。
release	ReleaseShallowReference	获取 releaseReference，它指定与此审批关联的版本的引用。
releaseDefinition	ReleaseDefinitionShallowReference	获取 releaseDefinitionReference，它指定与此审批关联的发布定义的引用。
releaseEnvironment	ReleaseEnvironmentShallowReference	获取 releaseEnvironmentReference，它指定与此审批关联的发布环境的引用。
revision	integer (int32)	获取修订号。
status	ApprovalStatus	获取或设置审批的状态。
url	string	获取用于访问审批的 URL。

响应

名称	类型	说明
200 OK	ReleaseApproval	成功作

安全性

oauth2

类型: oauth2
流向: 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

作用域

名称	说明
vso.release_manage	授予读取、更新和删除发布项目（包括文件夹、发布、发布定义和发布环境）以及排队和批准新版本的功能。

示例

Approve a release

示例请求

HTTP

PATCH https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/approvals/{approvalId}?api-version=7.1

{
  "status": "approved",
  "comments": "Good to go!"
}

示例响应

状态代码:: 200

{
  "id": 20,
  "revision": 1,
  "approver": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabfiber@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "approvedBy": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabfiber@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "approvalType": "preDeploy",
  "createdOn": "2017-05-31T18:07:40.45Z",
  "modifiedOn": "2017-05-31T18:08:09.577Z",
  "status": "approved",
  "comments": "Good to go!",
  "isAutomated": false,
  "isNotificationOn": true,
  "trialNumber": 1,
  "attempt": 1,
  "rank": 1,
  "history": [],
  "release": {
    "id": 3,
    "name": "Release-3",
    "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/3",
    "_links": {}
  },
  "releaseDefinition": {
    "id": 1,
    "name": "MyShuttle.CD",
    "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
    "_links": {}
  },
  "releaseEnvironment": {
    "id": 9,
    "name": "Dev",
    "_links": {}
  },
  "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/approvals/20"
}

定义

名称	说明
ApprovalStatus	获取或设置审批的状态。
ApprovalType	获取或设置审批的类型。
IdentityRef
ProjectReference
ReferenceLinks	表示 REST 引用链接集合的类。
ReleaseApproval
ReleaseApprovalHistory
ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseShallowReference

ApprovalStatus

枚举

获取或设置审批的状态。

值	说明
approved	指示批准。
canceled	指示审批已取消。
pending	指示审批处于挂起状态。
reassigned	指示重新分配审批。
rejected	指示审批被拒绝。
skipped	指示跳过审批。
undefined	指示审批没有状态集。

ApprovalType

枚举

获取或设置审批的类型。

值	说明
all	指示所有审批。
postDeploy	指示部署后执行的审批。
preDeploy	指示在部署之前执行的审批。
undefined	指示未设置审批类型。

IdentityRef

Object

名称	类型	说明
_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	已弃用 - 可以从描述符的主题类型推断（Descriptor.IsAadUserType/Descriptor.IsAadGroupType）
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断（描述符.IsGroupType）
isDeletedInOrigin	boolean
profileUrl	string	已弃用 - 不在 ToIdentityRef 的大多数预先存在的实现中使用
uniqueName	string	已弃用 - 请改用 Domain+PrincipalName
url	string	此 URL 是指向此图形主题的源资源的完整路由。

ProjectReference

Object

名称	类型	说明
id	string (uuid)	获取此字段的唯一标识符。
name	string	获取项目的名称。

ReferenceLinks

Object

表示 REST 引用链接集合的类。

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

ReleaseApproval

Object

名称	类型	说明
approvalType	ApprovalType	获取或设置审批的类型。
approvedBy	IdentityRef	获取已批准的标识。
approver	IdentityRef	获取或设置应批准的身份。
attempt	integer (int32)	获取或设置指定其所属部署尝试的尝试。
comments	string	获取或设置审批的注释。
createdOn	string (date-time)	获取其创建日期。
history	ReleaseApprovalHistory[]	获取指定与此审批关联的所有审批的历史记录。
id	integer (int32)	获取此字段的唯一标识符。
isAutomated	boolean	获取或设置审批是自动化的。
modifiedOn	string (date-time)	获取修改日期。
rank	integer (int32)	获取或设置指定审批顺序的排名。例如，同一排名表示并行审批。
release	ReleaseShallowReference	获取 releaseReference，它指定与此审批关联的版本的引用。
releaseDefinition	ReleaseDefinitionShallowReference	获取 releaseDefinitionReference，它指定与此审批关联的发布定义的引用。
releaseEnvironment	ReleaseEnvironmentShallowReference	获取 releaseEnvironmentReference，它指定与此审批关联的发布环境的引用。
revision	integer (int32)	获取修订号。
status	ApprovalStatus	获取或设置审批的状态。
url	string	获取用于访问审批的 URL。

ReleaseApprovalHistory

Object

名称	类型	说明
approver	IdentityRef	审批者的标识。
changedBy	IdentityRef	更改审批的对象标识。
comments	string	审批历史记录注释。
createdOn	string (date-time)	创建此审批的时间。
modifiedOn	string (date-time)	此审批修改的时间。
revision	integer (int32)	审批历史记录修订。

ReleaseDefinitionShallowReference

Object

名称	类型	说明
_links	ReferenceLinks	获取指向发布定义的相关资源、API 和视图的链接。
id	integer (int32)	获取发布定义的唯一标识符。
name	string	获取或设置发布定义的名称。
path	string	获取或设置发布定义的路径。
projectReference	ProjectReference	获取或设置项目引用。
url	string	获取用于访问发布定义的 REST API URL。

ReleaseEnvironmentShallowReference

Object

名称	类型	说明
_links	ReferenceLinks	获取指向发布环境的相关资源、API 和视图的链接。
id	integer (int32)	获取发布环境的唯一标识符。
name	string	获取或设置发布环境的名称。
url	string	获取用于访问发布环境的 REST API URL。

ReleaseShallowReference

Object

名称	类型	说明
_links	ReferenceLinks	获取指向发布的相关资源、API 和视图的链接。
id	integer (int32)	获取发布的唯一标识符。
name	string	获取或设置发布的名称。
url	string	获取用于访问发布的 REST API URL。

通过

Approvals - Update

URI 参数

请求正文

响应

安全性

oauth2

作用域

示例

Approve a release

示例请求

示例响应

定义

ApprovalStatus

ApprovalType

IdentityRef

ProjectReference

ReferenceLinks

ReleaseApproval

ReleaseApprovalHistory

ReleaseDefinitionShallowReference

ReleaseEnvironmentShallowReference

ReleaseShallowReference