Notifications - Create
发送测试通知。 这可用于验证更新或新服务挂钩订阅的配置。
POST https://dev.azure.com/{organization}/_apis/hooks/testnotifications?api-version=7.1POST https://dev.azure.com/{organization}/_apis/hooks/testnotifications?useRealData={useRealData}&api-version=7.1URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 组织的名称。 |
|
api-version
|
query | True |
string |
要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。 |
|
use
|
query |
boolean |
仅允许在现有订阅中使用实际数据进行测试。 |
请求正文
| 名称 | 类型 | 说明 |
|---|---|---|
| createdDate |
string (date-time) |
获取或设置创建此结果的日期和时间。 |
| details |
有关此通知的详细信息（如果可用） |
|
| eventId |
string (uuid) |
与此通知关联的事件 ID |
| id |
integer (int32) |
通知 ID |
| modifiedDate |
string (date-time) |
获取或设置上次修改此结果的日期和时间。 |
| result |
通知的结果 |
|
| status |
通知的状态 |
|
| subscriberId |
string (uuid) |
与此通知关联的订阅者 ID。 这是在订阅中接触的最后一个标识。 对于测试通知，如果尚未创建订阅，则它可以是测试人员。 |
| subscriptionId |
string (uuid) |
与此通知关联的订阅 ID |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
成功作 |
安全性
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.work | 授予读取工作项、查询、版块、区域和迭代路径以及其他工作项跟踪相关元数据的能力。 此外，还授予执行查询、搜索工作项以及通过服务挂钩接收有关工作项事件的通知的能力。 |
| vso.build | 授予访问生成项目（包括生成结果、定义和请求）的能力，以及通过服务挂钩接收有关生成事件的通知的能力。 |
| vso.code | 授予读取有关提交、更改集、分支和其他版本控制项目的源代码和元数据的能力。 此外，还可以通过服务挂钩搜索代码并获取有关版本控制事件的通知。 |
定义
| 名称 | 说明 |
|---|---|
| Event |
封装事件的属性。 |
|
Formatted |
提供事件消息的不同格式 |
| Notification |
定义处理订阅事件的结果的数据协定。 |
|
Notification |
定义通知详细信息的数据协定。 |
|
Notification |
通知的结果 |
|
Notification |
通知的状态 |
|
Resource |
所有资源容器的基类，即帐户、集合、项目 |
|
Session |
表示在事件中附加的会话令牌，供需要它的使用者作。 |
Event
封装事件的属性。
| 名称 | 类型 | 说明 |
|---|---|---|
| createdDate |
string (date-time) |
获取或设置创建此事件的基于 UTC 的日期和时间。 |
| detailedMessage |
获取或设置与此事件关联的详细消息。 |
|
| eventType |
string |
获取或设置此事件的类型。 |
| id |
string (uuid) |
获取或设置此事件的唯一标识符。 |
| message |
获取或设置与此事件关联的（简短）消息。 |
|
| publisherId |
string |
获取或设置引发此事件的发布服务器的标识符。 |
| resource |
object |
获取或设置与此事件关联的数据。 |
| resourceContainers |
<string,
Resource |
获取或设置资源容器。 |
| resourceVersion |
string |
获取或设置与此事件关联的数据的版本。 |
| sessionToken |
获取或设置可用于进一步交互的会话令牌 |
FormattedEventMessage
提供事件消息的不同格式
| 名称 | 类型 | 说明 |
|---|---|---|
| html |
string |
获取或设置邮件的 html 格式 |
| markdown |
string |
获取或设置消息的 markdown 格式 |
| text |
string |
获取或设置消息的原始文本 |
Notification
定义处理订阅事件的结果的数据协定。
| 名称 | 类型 | 说明 |
|---|---|---|
| createdDate |
string (date-time) |
获取或设置创建此结果的日期和时间。 |
| details |
有关此通知的详细信息（如果可用） |
|
| eventId |
string (uuid) |
与此通知关联的事件 ID |
| id |
integer (int32) |
通知 ID |
| modifiedDate |
string (date-time) |
获取或设置上次修改此结果的日期和时间。 |
| result |
通知的结果 |
|
| status |
通知的状态 |
|
| subscriberId |
string (uuid) |
与此通知关联的订阅者 ID。 这是在订阅中接触的最后一个标识。 对于测试通知，如果尚未创建订阅，则它可以是测试人员。 |
| subscriptionId |
string (uuid) |
与此通知关联的订阅 ID |
NotificationDetails
定义通知详细信息的数据协定。
| 名称 | 类型 | 说明 |
|---|---|---|
| completedDate |
string (date-time) |
获取或设置此通知完成的时间（从使用者收到的响应） |
| consumerActionId |
string |
获取或设置此通知详细信息的使用者作标识符。 |
| consumerId |
string |
获取或设置此通知详细信息的使用者标识符。 |
| consumerInputs |
object |
获取或设置此通知详细信息的使用者输入。 |
| dequeuedDate |
string (date-time) |
获取或设置取消排队处理此通知的时间 |
| errorDetail |
string |
获取或设置此通知详细信息的错误详细信息。 |
| errorMessage |
string |
获取或设置此通知详细信息的错误消息。 |
| event |
获取或设置此通知详细信息的事件内容。 |
|
| eventType |
string |
获取或设置此通知详细信息的事件类型。 |
| processedDate |
string (date-time) |
获取或设置此通知完成处理的时间（就在请求发送到使用者之前） |
| publisherId |
string |
获取或设置此通知详细信息的发布者标识符。 |
| publisherInputs |
object |
获取或设置此通知详细信息的发布者输入。 |
| queuedDate |
string (date-time) |
获取或设置此通知排队的时间（已创建） |
| request |
string |
获取或设置此通知详细信息的请求。 |
| requestAttempts |
integer (int32) |
尝试发送到使用者的请求数 |
| requestDuration |
number (double) |
向使用者请求的持续时间（以秒为单位） |
| response |
string |
获取或设置此通知详细信息的响应。 |
NotificationResult
通知的结果
| 值 | 说明 |
|---|---|
| failed |
通知未能成功发送到使用者 |
| filtered |
通知已按传递作业进行筛选 |
| pending |
通知尚未完成 |
| succeeded |
通知已成功发送 |
NotificationStatus
通知的状态
| 值 | 说明 |
|---|---|
| completed |
请求已完成 |
| processing |
通知已取消排队，并开始处理。 |
| queued |
通知已排队 |
| requestInProgress |
使用者作已处理通知。 请求正在进行中。 |
ResourceContainer
所有资源容器的基类，即帐户、集合、项目
| 名称 | 类型 | 说明 |
|---|---|---|
| baseUrl |
string |
获取或设置容器的基本 URL，即包含容器资源的主机（集合、应用程序或部署）的 URL。 |
| id |
string (uuid) |
获取或设置容器的特定 ID。 |
| name |
string |
获取或设置容器的名称。 |
| url |
string |
获取或设置容器的 REST API URL。 |
SessionToken
表示在事件中附加的会话令牌，供需要它的使用者作。
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
string |
出现错误时出现错误消息 |
| token |
string |
访问令牌 |
| validTo |
string (date-time) |
UTC 的到期日期 |