Notifications - Query

Service:

Service Hooks

API Version:

4.1

查询通知。 通知包括有关事件、对 的请求以及来自使用者服务的响应的详细信息。

POST https://{instance}/{collection}/_apis/hooks/notificationsquery?api-version=4.1

URI 参数

名称	在	必需	类型	说明
collection	path	True	string	Team Foundation Server 集合的名称。
instance	path	True	string	TFS 服务器名称 ({server：port})
api-version	query	True	string	要使用的 API 版本。 这应设置为“4.1”才能使用此版本的 API。

请求正文

名称	类型	说明
associatedSubscriptions	Subscription[]	与从查询返回的通知关联的订阅
includeDetails	boolean	如果为 true，我们将返回所提供的查询的所有通知历史记录;否则返回摘要。
maxCreatedDate	string	创建通知的可选最大日期
maxResults	integer	要包括的总结果的最大可选数目
maxResultsPerSubscription	integer	每个订阅的最大结果数可选。 仅在查询中提供订阅 ID 列表时生效。
minCreatedDate	string	创建通知的可选最短日期
publisherId	string	用于将结果限制为的可选发布者 ID
resultType	NotificationResult	用于筛选结果的可选通知结果类型
results	Notification[]	查询的结果
status	NotificationStatus	用于筛选结果的可选通知状态
subscriptionIds	string[]	用于将结果限制为的订阅 ID 的可选列表
summary	NotificationSummary[]	通知摘要 - 每个结果类型 (成功、失败、的计数。) 。

响应

名称	类型	说明
200 OK	NotificationsQuery	成功的操作

安全性

accessToken

个人访问令牌。 将任何值用作用户名和令牌作为密码。

Type: basic

定义

名称	说明
Event	封装事件的属性。
FormattedEventMessage	提供事件消息的不同格式
IdentityRef
Notification	定义处理订阅事件的结果的数据协定。
NotificationDetails	定义通知详细信息的数据协定。
NotificationResult	通知的结果
NotificationResultsSummaryDetail	特定结果和计数的摘要。
NotificationsQuery	定义服务挂钩通知的查询。
NotificationStatus	通知的状态
NotificationSummary	订阅通知摘要。
ReferenceLinks	表示 REST 引用链接集合的类。
ResourceContainer	所有资源容器的基类，即 Account、Collection、Project
SessionToken	表示需要在使用者操作的事件中附加的会话令牌。
Subscription	封装事件订阅。
SubscriptionStatus

Event

封装事件的属性。

名称	类型	说明
createdDate	string	获取或设置创建此事件的基于 UTC 的日期和时间。
detailedMessage	FormattedEventMessage	获取或设置与此事件关联的详细消息。
eventType	string	获取或设置此事件的类型。
id	string	获取或设置此事件的唯一标识符。
message	FormattedEventMessage	获取或设置与此事件关联的 (简短) 消息。
publisherId	string	获取或设置引发此事件的发布者的标识符。
resource	object	获取或设置与此事件关联的数据。
resourceContainers	<string,  ResourceContainer>	获取或设置资源容器。
resourceVersion	string	获取或设置与此事件关联的数据版本。
sessionToken	SessionToken	获取或设置可用于进一步交互的会话令牌

FormattedEventMessage

提供事件消息的不同格式

名称	类型	说明
html	string	获取或设置消息的 html 格式
markdown	string	获取或设置消息的 markdown 格式
text	string	获取或设置消息的原始文本

IdentityRef

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个相关链接。 可以调用这些链接来获取有关此图主题的其他关系或更多详细信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方式。 此字段将跨“帐户”和“集合”唯一标识同一图形主题。
directoryAlias	string
displayName	string	这是图形主题的非唯一显示名称。 若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
profileUrl	string
uniqueName	string
url	string	此 URL 是此图主题的源资源的完整路由。

Notification

定义处理订阅事件的结果的数据协定。

名称	类型	说明
createdDate	string	获取或设置创建此结果的日期和时间。
details	NotificationDetails	有关此通知的详细信息（如果可用） ()
eventId	string	与此通知关联的事件 ID
id	integer	通知 ID
modifiedDate	string	获取或设置上次修改此结果的日期和时间。
result	NotificationResult	通知的结果
status	NotificationStatus	通知的状态
subscriberId	string	与此通知关联的订阅服务器 ID。 这是最后一个在订阅中接触的标识。 在测试通知的情况下，如果尚未创建订阅，它可以是测试人员。
subscriptionId	string	与此通知关联的订阅 ID

NotificationDetails

定义通知详细信息的数据协定。

名称	类型	说明
completedDate	string	获取或设置此通知的完成时间 (从使用者接收的响应)
consumerActionId	string	获取或设置此通知详细信息的使用者操作标识符。
consumerId	string	获取或设置此通知详细信息的使用者标识符。
consumerInputs	object	获取或设置此通知详细信息的使用者输入。
dequeuedDate	string	获取或设置取消此通知排队进行处理的时间
errorDetail	string	获取或设置此通知详细信息的错误详细信息。
errorMessage	string	获取或设置此通知详细信息的错误消息。
event	Event	获取或设置此通知详细信息的事件内容。
eventType	string	获取或设置此通知详细信息的事件类型。
processedDate	string	获取或设置在将请求发送到使用者之前 (完成此通知处理的时间)
publisherId	string	获取或设置此通知详细信息的发布者标识符。
publisherInputs	object	获取或设置此通知详细信息的发布者输入。
queuedDate	string	获取或设置此通知在创建) (排队的时间
request	string	获取或设置此通知详细信息的请求。
requestAttempts	integer	尝试发送到使用者的请求数
requestDuration	number	向使用者请求的持续时间（以秒为单位）
response	string	获取或设置此通知详细信息的响应。

NotificationResult

通知的结果

名称	类型	说明
failed	string	通知未能成功发送到使用者
pending	string	通知尚未完成
succeeded	string	通知已成功发送

NotificationResultsSummaryDetail

特定结果和计数的摘要。

名称	类型	说明
notificationCount	integer	发送并显示匹配结果的通知计数。
result	NotificationResult	通知的结果

NotificationsQuery

定义服务挂钩通知的查询。

名称	类型	说明
associatedSubscriptions	Subscription[]	与从查询返回的通知关联的订阅
includeDetails	boolean	如果为 true，我们将返回所提供的查询的所有通知历史记录;否则，返回摘要。
maxCreatedDate	string	创建通知的可选最大日期
maxResults	integer	要包括的总结果的最大可选数目
maxResultsPerSubscription	integer	每个订阅的可选最大结果数。 仅在查询中提供订阅 ID 列表时生效。
minCreatedDate	string	创建通知的可选最短日期
publisherId	string	用于将结果限制为的可选发布者 ID
resultType	NotificationResult	用于筛选结果的可选通知结果类型
results	Notification[]	查询的结果
status	NotificationStatus	用于筛选结果的可选通知状态
subscriptionIds	string[]	用于将结果限制为的订阅 ID 的可选列表
summary	NotificationSummary[]	通知摘要 - 每个结果类型的计数 (成功、失败、.) 。

NotificationStatus

通知的状态

名称	类型	说明
completed	string	请求已完成
processing	string	通知已取消排队并开始处理。
queued	string	通知已排队
requestInProgress	string	使用者操作已处理通知。 请求正在进行中。

NotificationSummary

订阅通知摘要。

名称	类型	说明
results	NotificationResultsSummaryDetail[]	此特定订阅的通知结果。
subscriptionId	string	与此通知关联的订阅 ID

ReferenceLinks

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

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

ResourceContainer

所有资源容器的基类，即 Account、Collection、Project

名称	类型	说明
baseUrl	string	获取或设置容器的基 URL，即主机 (集合、应用程序或包含容器资源的 deploument) 的 URL。
id	string	获取或设置容器的特定 ID。
name	string	获取或设置容器的名称。
url	string	获取或设置容器的 REST API URL。

SessionToken

表示需要在使用者操作的事件中附加的会话令牌。

名称	类型	说明
error	string	出错时出现错误消息
token	string	访问令牌
validTo	string	到期日期（UTC）

Subscription

封装事件订阅。

名称	类型	说明
_links	ReferenceLinks	参考链接
actionDescription	string
consumerActionId	string
consumerId	string
consumerInputs	object	使用者输入值
createdBy	IdentityRef
createdDate	string
eventDescription	string
eventType	string
id	string
modifiedBy	IdentityRef
modifiedDate	string
probationRetries	string
publisherId	string
publisherInputs	object	发布者输入值
resourceVersion	string
status	SubscriptionStatus
subscriber	IdentityRef
url	string

SubscriptionStatus

名称	类型	说明
disabledBySystem	string	订阅被系统禁用。
disabledByUser	string	订阅被用户禁用。
enabled	string	订阅已启用。
onProbation	string	订阅暂时受系统缓刑。