Notifications - Query
查询通知。 通知包括有关事件的详细信息、对使用者服务的请求和响应。
POST https://dev.azure.com/{organization}/_apis/hooks/notificationsquery?api-version=7.1URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 组织的名称。 |
|
api-version
|
query | True |
string |
要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。 |
请求正文
| 名称 | 类型 | 说明 |
|---|---|---|
| associatedSubscriptions |
与从查询返回的通知关联的订阅 |
|
| includeDetails |
boolean |
如果为 true，我们将返回所提供的查询的所有通知历史记录;否则，将返回摘要。 |
| maxCreatedDate |
string (date-time) |
创建通知的可选最大日期 |
| maxResults |
integer (int32) |
要包括的总结果的最大可选数目 |
| maxResultsPerSubscription |
integer (int32) |
每个订阅的可选最大结果数。 仅在查询中提供订阅 ID 列表时生效。 |
| minCreatedDate |
string (date-time) |
创建通知的可选最小日期 |
| publisherId |
string |
可选发布者 ID，用于将结果限制为 |
| resultType |
用于筛选结果到的可选通知结果类型 |
|
| results |
来自查询的结果 |
|
| status |
要筛选结果的可选通知状态 |
|
| subscriptionIds |
string[] (uuid) |
用于将结果限制为的订阅 ID 的可选列表 |
| summary |
通知摘要 - 每个结果类型（成功、失败、..）的计数。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 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 |
提供事件消息的不同格式 |
|
Identity |
|
| Notification |
定义处理订阅事件的结果的数据协定。 |
|
Notification |
定义通知详细信息的数据协定。 |
|
Notification |
通知的结果 |
|
Notification |
特定结果和计数的摘要。 |
|
Notifications |
定义服务挂钩通知的查询。 |
|
Notification |
通知的状态 |
|
Notification |
订阅通知摘要。 |
|
Reference |
表示 REST 引用链接集合的类。 |
|
Resource |
所有资源容器的基类，即帐户、集合、项目 |
|
Session |
表示在事件中附加的会话令牌，供需要它的使用者作。 |
| Subscription |
封装事件订阅。 |
|
Subscription |
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 |
获取或设置消息的原始文本 |
IdentityRef
| 名称 | 类型 | 说明 |
|---|---|---|
| _links |
此字段包含有关图形主题的零个或多个有趣的链接。 可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。 |
|
| 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 是指向此图形主题的源资源的完整路由。 |
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 |
通知已成功发送 |
NotificationResultsSummaryDetail
特定结果和计数的摘要。
| 名称 | 类型 | 说明 |
|---|---|---|
| notificationCount |
integer (int32) |
通过匹配结果发送的通知计数。 |
| result |
通知的结果 |
NotificationsQuery
定义服务挂钩通知的查询。
| 名称 | 类型 | 说明 |
|---|---|---|
| associatedSubscriptions |
与从查询返回的通知关联的订阅 |
|
| includeDetails |
boolean |
如果为 true，我们将返回所提供的查询的所有通知历史记录;否则，将返回摘要。 |
| maxCreatedDate |
string (date-time) |
创建通知的可选最大日期 |
| maxResults |
integer (int32) |
要包括的总结果的最大可选数目 |
| maxResultsPerSubscription |
integer (int32) |
每个订阅的可选最大结果数。 仅在查询中提供订阅 ID 列表时生效。 |
| minCreatedDate |
string (date-time) |
创建通知的可选最小日期 |
| publisherId |
string |
可选发布者 ID，用于将结果限制为 |
| resultType |
用于筛选结果到的可选通知结果类型 |
|
| results |
来自查询的结果 |
|
| status |
要筛选结果的可选通知状态 |
|
| subscriptionIds |
string[] (uuid) |
用于将结果限制为的订阅 ID 的可选列表 |
| summary |
通知摘要 - 每个结果类型（成功、失败、..）的计数。 |
NotificationStatus
通知的状态
| 值 | 说明 |
|---|---|
| completed |
请求已完成 |
| processing |
通知已取消排队，并开始处理。 |
| queued |
通知已排队 |
| requestInProgress |
使用者作已处理通知。 请求正在进行中。 |
NotificationSummary
订阅通知摘要。
| 名称 | 类型 | 说明 |
|---|---|---|
| results |
此特定订阅的通知结果。 |
|
| subscriptionId |
string (uuid) |
与此通知关联的订阅 ID |
ReferenceLinks
表示 REST 引用链接集合的类。
| 名称 | 类型 | 说明 |
|---|---|---|
| links |
object |
链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。 |
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 的到期日期 |
Subscription
封装事件订阅。
| 名称 | 类型 | 说明 |
|---|---|---|
| _links |
参考链接 |
|
| actionDescription |
string |
|
| consumerActionId |
string |
|
| consumerId |
string |
|
| consumerInputs |
object |
使用者输入值 |
| createdBy | ||
| createdDate |
string (date-time) |
|
| eventDescription |
string |
|
| eventType |
string |
|
| id |
string (uuid) |
|
| lastProbationRetryDate |
string (date-time) |
|
| modifiedBy | ||
| modifiedDate |
string (date-time) |
|
| probationRetries |
string (byte) |
|
| publisherId |
string |
|
| publisherInputs |
object |
发布者输入值 |
| resourceVersion |
string |
|
| status | ||
| subscriber | ||
| url |
string |
SubscriptionStatus
| 值 | 说明 |
|---|---|
| disabledByInactiveIdentity |
由于所有者处于非活动状态或缺少权限，订阅被禁用。 |
| disabledBySystem |
系统禁用订阅。 |
| disabledByUser |
用户禁用订阅。 |
| enabled |
已启用订阅。 |
| onProbation |
订阅暂时由系统进行缓刑。 |