通过

Azure Boards Analytics 的元数据参考

  • 项目

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Analytics 服务收集通过Azure Boards定义和更新的所有工作跟踪活动。 分析将所有工作跟踪字段（HTML/富文本字段和历史记录字段除外）存储为属性。 自定义字段的自定义属性会自动添加到 Analytics。

本文介绍可用于为工作跟踪生成 Analytics 报表的大多数属性。 可以使用属性的组合来筛选查询、聚合数据或生成报表。 可以直接在浏览器中运行这些查询。 有关详细信息，请参阅 使用 OData Analytics 定义基本查询。 如果你不熟悉工作跟踪和Azure Boards，建议查看以下文章：

注意

提供了分析数据模型支持的实体、属性和枚举类型的说明。 这是一个早期的草案。 请提供有关希望获取详细信息的区域的反馈。 若要查询数据模型，请参阅 为 Analytics 构造 OData 查询。

实体集概述

查询 Analytics 的工作跟踪数据时，请使用以下实体类型或实体集之一。

  • 用于生成状态和汇总报告的查询WorkItems
  • 用于生成趋势、进度和烧毁报表的查询WorkItemSnapshot

使用其他实体类型（如 Area、Iteration、ProjectTeam、 或其他实体）筛选数据或选择要报告的属性。 有关示例报表的摘要，请参阅 示例报表和快速参考索引。

注意

若要生成有关测试特定工作项类型的状态和趋势报告，请查询 WorkItems 和 WorkItemSnapshot 实体类型，并根据工作项类型进行筛选。 有关测试运行、测试结果或其他测试数据的信息，请查询 TestRuns、TestPoints、 TestResultsDailyTestSuite 或 TestPointHistorySnapshot 实体类型。 有关详细信息，请参阅 Azure DevOps 的测试元数据参考。

EntitySet EntityType 说明
地区 区域 工作项 “区域路径”，具有用于按区域层次结构分组和筛选的属性。
日期 CalendarDate 用于使用关系筛选和分组其他实体的日期。
迭代 迭代 工作项 迭代路径，具有用于按迭代层次结构分组和筛选的属性。
BoardLocations BoardLocation 板单元位置（由板柱、泳道和拆分标识）包括历史板设置。 有关每个板字段的说明，请参阅 “工作流”和“板”字段。
进程 处理 用于展开或筛选工作项和工作项类型的积压工作信息。 有关使用 进程 筛选报表的示例，请参阅 要求跟踪示例报表。 支持 Analytics v2.0 及更高版本。
项目 Project 为组织定义的所有项目 (云) 或项目集合 (本地) 。
标记 标记 每个项目的所有工作项标记。 有关使用 标记 筛选报表的示例，请参阅 发布进度示例报表。
Teams 团队 为项目定义的所有团队。 有关使用 Teams 筛选报表的示例，请参阅 向 Power BI 报表添加团队切片器。
用户 用户 用于展开或筛选各种工作项属性的用户信息，例如 “分配到”和 “创建者”。
WorkItemBoardSnapshot WorkItemBoardSnapshot （复合）每个日历日期（包括板位置）上每个工作项的状态，用于生成趋势报告。 有关示例报表，请参阅 (CFD) 示例报表的累积流程图。
WorkItemLinks WorkItemLink 工作项之间的链接，例如， Child、 Parent 和 Related。 仅包含最新修订的链接，不包含历史记录。 不包括超链接。
WorkItemRevisions WorkItemRevision 所有历史工作项修订，包括当前修订。 不包括已删除的工作项。
WorkItemSnapshot WorkItemSnapshot (复合) 每个日历日期上每个工作项的状态，用于支持趋势报告。 有关示例报告，请参阅 Bug 趋势示例报告。
WorkItems WorkItem 工作项的当前状态。 用于支持状态报告。 有关示例报表，请参阅 将子工作项值汇总到父示例报表。
WorkItemTypeFields WorkItemTypeField 每个工作项类型和进程的工作项属性。 用于支持生成报表。

关于快照

有两个工作跟踪快照实体集： WorkItemSnapshot 和 WorkItemBoardSnapshot。

快照提供每天为工作项定义的值的记录。 记录每天在同一时间写入 Analytics 一次。 如果要生成趋势报告，请使用快照。 默认情况下，所有快照表都建模为每日快照事实数据表。 如果查询某个时间范围，它将获取每天的值。 较长的时间范围会导致大量记录。 如果不需要如此高的精度，可以使用每周甚至每月快照。

有关详细信息，请参阅 OData 查询指南，请对跨较长时间段的趋势查询使用每周或每月快照。

关于工作项修订

每次更新工作项时，系统都会创建一个新的修订，并在 字段中记录此操作 System.RevisedDate ，这使得它可用于指定历史记录筛选器。 修订日期由 RevisedDate (DateTime) 和 RevisedDateSK (Int32) 属性表示。 为获得最佳性能，请使用后一个日期代理键。 它表示修订的创建日期，或者对于活动修订或不完整修订，该日期为 null。

如果需要自 （含）以来 {startDate} 的所有日期，请将以下筛选器添加到查询。

RevisedDateSK eq null or RevisedDateSK gt {startDateSK}

使用 WorkItemRevisions 实体集加载给定工作项的所有修订。 该查询返回筛选工作项的所有历史工作项修订，包括当前修订。 它不包括已删除的工作项。

跨多个实体类型的共享属性

可以在 分析视图中 选择的属性对应于常规工作跟踪字段，并选择分析属性，例如 “周期时间天数 ”和 “提前期天数”。 除非另行指定，否则下表中列出了其中大多数属性并对其进行了说明，这些属性是针对以下实体类型定义的。

  • WorkItem
  • WorkItemRevision
  • WorkItemSnapshot
  • WorkItemBoardSnapshot

注意

Analytics 服务不存储分配给 HTML 或格式文本数据类型的长文本字段的任何数据。 这包括 “说明” 和 “历史记录” 字段。 分析也不会存储链接或附加文件计数。 有关默认流程模板中定义的字段的完整列表，请参阅 工作项字段索引。 有关每种数据类型的说明，请参阅 查询字段、运算符和宏。
下表中并未包含与 Scrum 和 CMMI 进程特定的字段关联的所有属性。 有关这些字段的列表，请参阅 进程模板中使用的默认字段和工作项字段的字段说明、用于跟踪 CMMI 工作项的字段。

许多属性基于日期或基于用户。 这些属性与 Calendar 日期、项目和用户元数据引用中所述的 CalendarDate和 User 实体集相关联。

显示名称
Property name		 数据类型 描述
Reference name
接受者
Microsoft_VSTS_CodeReview_AcceptedBy		 UserSK 对代码评审做出响应的人员的姓名。 (CMMI 进程)
Microsoft.VSTS.CodeReview.AcceptedBy
接受日期
AcceptedDate		 DateTime 人员响应代码评审的日期和时间。 (CMMI 进程)
Microsoft.VSTS.CodeReview.AcceptedDate
激活者
ActivatedBy
ActivatedByUserSK		 UserSK 激活或重新激活工作项的团队成员的姓名。
Microsoft.VSTS.Common.ActivatedBy
激活日期
ActivatedDate		 DateTime 团队成员激活或重新激活 bug 或工作项的日期和时间。
Microsoft.VSTS.CodeReview.ActivatedDate
活动
Activity		 String 执行任务所需的活动类型。
Microsoft.VSTS.Common.Activity

分配给任务的活动或专业类型。 允许的值为： Deployment、 Design、 Development、 Documentation、 Requirements 和 Testing。 （敏捷、Scrum 和基本流程）
Microsoft.VSTS.Common.Activity
AnalyticsUpdatedDate DateTimeOffset 上次更新实体的数据和时间。
应用程序类型 字符串 利益干系人会针对其提供反馈的应用程序的类型。 默认值为 Web 应用程序、 远程计算机和 客户端应用程序。 有效类型在进程配置文件中为使用本地 XML 进程的项目指定。
Microsoft_VSTS_Feedback_ApplicationType
区域路径
AreaPath
AreaSK		 String 将工作项分组为产品功能或团队区域。 区域必须是项目层次结构中的有效节点。
System.AreaPath
分配到
AssignedTo
AssignedToUserSK		 UserSK 当前拥有该工作项的团队成员的名称。
System.AssignedTo
自动测试 ID
AutomatedTestId		 字符串 可自动化测试用例的测试的 ID。
Microsoft.VSTS.TCM.AutomatedTestId
自动测试名称
AutomatedTestName		 字符串 激活或重新激活工作项的团队成员的姓名。
Microsoft.VSTS.TCM.AutomatedTestName
自动测试存储
AutomatedTestStorage		 字符串 包含可自动化测试用例的测试的程序集。
Microsoft.VSTS.TCM.AutomatedTestStorage
自动测试类型
AutomatedTestType		 字符串 可自动化测试用例的测试的类型。
Microsoft.VSTS.TCM.AutomatedTestType
自动化状态
AutomatedStatus		 字符串 具有以下接受值的测试用例的状态： Automated、 Not Automated 或 Planned。
Microsoft.VSTS.TCM.AutomationStatus
积压工作优先级
BacklogPriority		 Double 由系统后台进程分配的数字，用于在积压工作或板上堆叠排名或跟踪项目序列。 （Scrum 进程）
Microsoft.VSTS.Common.BacklogPriority
被阻止
Blocked		 字符串 指示不能对工作项执行进一步的工作。 有效值为 “是” 或 “否”。 (CMMI 进程)
Microsoft.VSTS.CMMI.Blocked
业务价值
BusinessValue		 Double 捕获与相同类型的其他项比较的产品积压工作项或功能的相对业务价值的主观度量单位。 将分配较高数字的项具有的业务价值视为高于分配较低数字的项。
Microsoft.VSTS.Common.BusinessValue
更改者
ChangedBy
ChangedByUserSK		 UserSK 最近修改工作项的人员的姓名。
System.ChangedBy
更改日期
ChangedDate		 DateTime 修改工作项的日期和时间。
System.ChangedDate
ChangedDateSK Int32 修改工作项的日期，以为组织定义的时区表示 YYYYMMDD 。 由外部工具用于联接相关实体。
ChangedOn 导航 在为组织定义的时区中，修改工作项的日期的实体的导航属性 Date 。 通常用于在 语句中引用实体中的Dategroupby属性。
关闭者
ClosedBy
ClosedByUserSK		 UserSK 关闭工作项的用户的名称。
Microsoft.VSTS.Common.ClosedBy
关闭日期
ClosedDate
ClosedDateSK
ClosedOn		 DateTime 关闭工作项的日期和时间。
Microsoft.VSTS.Common.ClosedDate
批注计数
CommentCount		 Int32 添加到工作项的 “讨论 ”部分的批注数。
System.CommentCount
承诺
Committed		 字符串 指示是否在项目中提交要求。 有效值为 “是” 或 “否”。 (CMMI 进程)
Microsoft.VSTS.CMMI.Committed
CompletedDateSK Int32 分析捕获的导航属性日期，用于存储工作项进入与已完成工作流状态类别关联的工作流状态的时间。
CompletedOn 导航 在为组织定义的时区中，工作项输入与已完成工作流状态类别关联的工作流状态的日期实体的导航属性Date。 通常用于在 语句中引用实体的属性Dategroupby。
已完成工作
CompletedWork		 Double 度量在某个任务上所投入的工作量。
Microsoft.VSTS.Scheduling.CompletedWork
创建者
CreatedBy
CreatedByUserSK		 UserSK 创建工作项的人员的姓名。
Microsoft.VSTS.Common.CreatedBy
创建日期
CreatedDate
CreatedDateSK		 DateTime 创建工作项的日期，以 为组织定义的时区表示。 通常用于筛选和显示。
Microsoft.VSTS.Common.CreatedDate
CreatedDateSK Int32 创建工作项的日期，以 YYYYMMDD 为组织定义的时区表示。 由外部工具用于联接相关实体。
CreatedOn 导航 在为组织定义的时区中创建工作项的实体的导航属性 Date 。 通常用于在 语句中引用实体的属性Dategroupby。
周期时间天数
CycleTimeDays		 Double 周期时间是从首先输入 “正在进行” 或“ 已解决 ”状态类别到进入 “已完成 ”状态类别计算的。 有关详细信息，请参阅 “潜在顾客时间和周期时间”小组件。
规则
Discipline		 字符串 分配给任务的活动或专业类型。 允许的值为： Analysis*、 Development、 Test、 User Education 和 User Experience。 （CMMI 进程）
Microsoft.VSTS.Common.Activity
截止日期
DueDate		 DateTime 解决问题或工作项的预测截止日期。 (敏捷流程)
Microsoft.VSTS.Scheduling.DueDate
工作量
Effort		 Double 估计产品积压工作项 (Scrum 流程) 或发布 (基本流程) 实现所需的工作量。
Microsoft.VSTS.Scheduling.Effort
完成日期
FinishDate		 DateTime 计划指示将完成工作项的日期和时间。
Microsoft.VSTS.Scheduling.FinishDate
发现版本
FoundIn		 字符串 产品生成号，也称为修订（发现 Bug 的位置）。
Microsoft.VSTS.Build.FoundIn
InProgress Date
InProgressDate		 DateTime 分析存储的日期，用于捕获将工作项移动到属于“正在进行”状态类别的“状态”的日期时间。
InProgressDateSK Int32 工作项移动到属于“正在进行”状态类别的“状态”的日期，以为组织定义的时区表示YYYYMMDD。 由外部工具用于联接相关实体。
集成版本
IntegrationBuild		 String 集成代码或修复 Bug 的产品生成号。
Microsoft.VSTS.Build.IntegrationBuild
是否为最新
IsCurrent		 布尔值 通过将 值设置为 True，支持筛选数据以查看筛选的工作项集的最新快照。
对于以下实体类型有效： WorkItemRevision、 WorkItemBoardSnapshot和 BoardLocation。
是当天的最后一次修订
IsLastRevisionOfDay		 布尔值 指示快照表示设置为 True时当天的最后一个修订。
是期间的最后一次修订
IsLastRevisionOfPeriod		 布尔值 指示快照表示设置为 True时期间的最后一个修订。
问题
Issue		 String 指示与预期结果相关联的共享步骤。 允许的值为 “是” 和 “否”。
Microsoft.VSTS.Common.Issue
提前期天数
LeadTimeDays		 Double 提前期是从创建工作项或输入 建议 状态类别到进入 已完成 状态类别计算的。 有关详细信息，请参阅 “潜在顾客时间和周期时间”小组件。
原始估算
OriginalEstimate		 Double 度量完成某个任务所需的工作量。
Microsoft.VSTS.Scheduling.OriginalEstimate
父工作项 ID
ParentWorkItemId		 Int32 标识作为父级链接到的工作项的唯一 ID。 可用于生成汇总报告。 父字段可从 Azure DevOps Server 2020 及更高版本获取。 对于以下实体类型有效： WorkItemRevision 和 WorkItem。
System.Parent
优先级
Priority		 Int32 与业务相关的 Bug、问题、任务或测试用例的主观分级。 值包括： - 1、 2 或 3。
Microsoft.VSTS.Common.Priority
项目名称
ProjectName		 导航 工作项所属的项目的名称。 有关详细信息，请参阅 日历日期、项目和用户元数据参考、项目属性。
System.TeamProject
ProjectSK GUID 分配给工作项所属项目的 GUID。
评级
Reason		 字符串 某个项从基于星号的分级系统中的审阅者收到的星号数量。 (反馈响应) 数字存储在系统中，并按如下方式编写：- 0 - 未评级， 1 - 差， 2 - 公平， 3 - 良好， 4 - 非常好， 5 - 优秀。 对于以下实体类型有效： WorkItemRevision 和 WorkItem。
Microsoft.VSTS.Common.Rating
原因
Reason		 String 工作项处于当前状态的原因。 从一个工作流状态到另一个工作流状态的每次转换都与相应的原因相关联。
System.Reason
剩余工作
RemainingWork		 Double 度量完成某个任务所需的剩余工作量。
Microsoft.VSTS.Scheduling.RemainingWork
解决者
ResolvedBy
ResolvedByUserSK		 UserSK 解决了 Bug 或用户情景的团队成员的名称。
Microsoft.VSTS.Common.ResolvedBy
解决日期
ResolvedDate		 DateTime 解决了 Bug 或用户情景时的日期和时间。
Microsoft.VSTS.Common.ResolvedDate
ResolvedDateSK Int32 解决工作项的日期，以为组织定义的时区表示 YYYYMMDD 。 由外部工具用于联接相关实体。
ResolvedOn 导航 在为组织定义的时区中，工作项解析日期的实体的导航属性 Date 。 通常用于在 语句中引用实体中的Dategroupby属性。
解决原因
ResolvedReason		 String 已解决该 Bug 的原因（例如，已解决它）。
Microsoft.VSTS.Common.ResolvedReason
修订
Revision		 Int32 为工作项的历史记录修订分配的编号。
System.Rev
修订日期
RevisedDate		 DateTime 修改或更新工作项的日期和时间。
RevisedDateSK Int32 修改工作项的日期，以为组织定义的时区表示 YYYYMMDD 。 由外部工具用于联接相关实体。
RevisedOn 导航 在为组织定义的时区中，修改工作项的日期的实体的导航属性 Date 。 通常用于在 语句中引用实体中的Dategroupby属性。
风险
Risk		 Double 有关成功完成用户情景的相对不确定性的主观分级。 有效值包括： 1 - 高、 2 - 中和 3 - 低。
Microsoft.VSTS.Common.Risk
严重性
Severity		 Double Bug、问题或风险对项目的影响的主观分级。 有效值包括： 1 - 严重、 2 - 高、 3 - 中和 4 - 低。
Microsoft.VSTS.Common.Severity
大小
Size		 Double CMMI 过程) (要求实现的工作量的估计值。
Microsoft.VSTS.Scheduling.Size
堆栈级别
StackRank		 Double 由系统后台进程分配的数字，用于在积压工作或板上堆叠排名或跟踪项目序列。 （敏捷、Scrum 和基本流程）
Microsoft.VSTS.Common.StackRank
开始日期
StartDate		 DateTime 分配给工作项以便开始工作的日期和时间。
Microsoft.VSTS.Scheduling.StartDate
State
State		 字符串 工作项的当前状态。 状态的有效值特定于每种类型的工作项和对其进行的自定义。
System.State
状态类别
StateCategory		 字符串 状态类别确定Azure Boards和选择仪表板小组件如何处理每个工作流状态。 正在使用的状态类别包括：“建议”、“正在进行”、“已解决”、“已删除”和“已完成”。 有关详细信息，请参阅 如何使用工作流状态和状态类别。 仅对 WorkItemRevision 实体类型有效。
状态更改日期
StateChangeDate		 DateTime “状态”字段的值更改的日期和时间。
Microsoft.VSTS.Common.StateChangeDate
StateChangeSK Int32 工作项的“状态”更改日期，以为组织定义的时区表示 YYYYMMDD 。 由外部工具用于联接相关实体。
StateChangeOn 导航 在为组织定义的时区中，工作项的“状态”更改日期的实体的导航属性 Date 。 通常用于在 语句中引用实体中的Dategroupby属性。
故事点
StoryPoints		 Double 用户情景 (敏捷过程) 实现所需的工作量的估计值，通常聚合为总和。
Microsoft.VSTS.Scheduling.StoryPoints
标记
TagNames		 String 分配给一个或多个工作项以分号分隔的标记列表，用于筛选或查询。
System.Tags
目标日期
TargetDate		 DateTime 问题或其他工作项将解决或完成的预测截止日期。
Microsoft.VSTS.Scheduling.TargetDate
测试套件类型 字符串 指定测试套件的类型。 有效值包括：“基于查询”、“基于要求”和“静态”。
Microsoft_VSTS_TCM_TestSuiteType
测试套件类型 ID Int64 系统分配的编号，对应于测试套件类别，仅适用于测试套件。 分配的值包括：1 (静态) 、2 个基于查询的 () 和 3 (基于要求的) 。
Microsoft_VSTS_TCM_TestSuiteTypeId
时间关键性
TimeCriticality		 Double 一个主观度量单位，用于捕获业务价值如何随时间推移而减少。 较高值指示长篇故事或功能在本质上比值较低的那些项具有更高的时间关键性。
Microsoft.VSTS.Common.TimeCriticality
标题
Title		 字符串 总结了工作项的含义以及帮助团队成员将其与列表中其他工作项区分开的简短说明。
System.Title
值区域
ValueArea		 字符串 由长篇故事、功能或积压工作项处理的客户价值区域。 值包括： 体系结构 或 业务。
Microsoft.VSTS.Common.ValueArea
水印
Watermark		 字符串 系统管理的字段，随着对工作项所做的更改而递增。 对于以下实体类型有效： WorkItemRevision 和 WorkItem。
System.Watermark
工作项 ID
WorkItemId		 Int32 分配给工作项的唯一标识符。 工作项 ID 在所有项目中以及组织或项目集合中是唯一的。
System.Id
WorkItemRevisionSK Int32 外部工具用于联接相关实体的工作项修订的 Analytics 唯一键。
工作项类型
WorkItemType		 字符串 工作项类型的名称。 工作项类型是根据创建项目时使用的过程定义的。 有关详细信息，请参阅 关于进程和进程模板。
System.WorkItemType

OData 中的导航属性是指向另一个实体的实体的引用属性。 下表提供了导航属性、其引用约束以及它们对其有效的实体类型的摘要。

显示名称 名称
引用约束和属性		 对实体类型有效
ChangedOn
ChangedDateSK, DateSK 		WorkItemRevision、 WorkItemSnapshot、、 WorkItemBoardSnapshot
ClosedOn
ClosedDateSK, DateSK 		WorkItemRevision、 WorkItemSnapshot、、 WorkItemBoardSnapshot
CreatedOn
CreatedDateSK, DateSK 		WorkItemRevision、 WorkItemSnapshot、、 WorkItemBoardSnapshot
ResolvedOn
ResolvedDateSK, DateSK 		WorkItemRevision、、WorkItemWorkItemSnapshot、、WorkItemBoardSnapshot
StateChangeOn
StateChangeDateSK, DateSK 		WorkItemRevision、、WorkItemWorkItemSnapshot、、WorkItemBoardSnapshot
InProgressOn
InProgressDateSK, DateSK 		WorkItemRevision、、WorkItemWorkItemSnapshot、、WorkItemBoardSnapshot
CompletedOn
CompletedDateSK, DateSK 		WorkItemRevision、、WorkItemWorkItemSnapshot、、WorkItemBoardSnapshot
ChangedOn
ChangedDateSK, DateSK 		WorkItemRevision、、WorkItemWorkItemSnapshot、、WorkItemBoardSnapshot
RevisedOn
RevisedDateSK, DateSK 		WorkItemRevision, WorkItemSnapshot
Date
DateSK, DateSK 		WorkItemRevision、 WorkItemSnapshot、、 WorkItemBoardSnapshot
Areas Area
AreaSK		 WorkItemRevision、、WorkItemWorkItemSnapshot、、WorkItemBoardSnapshot
BoardLocation WorkItemRevision、 WorkItem、、 WorkItemBoardSnapshot
迭代次数 Iteration
IterationSK		 WorkItemRevision、、WorkItemWorkItemSnapshot、、WorkItemBoardSnapshot
分配到 AssignedTo
AssignedToUserSK, UserSK 		WorkItemRevision、、WorkItemWorkItemSnapshot、、WorkItemBoardSnapshot
更改者 ChangedBy
ChangedByUserSK, UserSK 		WorkItemRevision、、WorkItemWorkItemSnapshot、、WorkItemBoardSnapshot
创建者 CreatedBy
CreatedByUserSK, UserSK 		WorkItemRevision、、WorkItemWorkItemSnapshot、、WorkItemBoardSnapshot
激活者 ActivatedBy
ActivatedByUserSK, UserSK 		WorkItemRevision、WorkItem、 WorkItemSnapshot、 WorkItemBoardSnapshot
关闭者 ClosedBy
ClosedBySK, UserSK 		WorkItemRevision、、WorkItemWorkItemSnapshot、、WorkItemBoardSnapshot
ResolvedBy ResolvedBy
ResolvedByUserSK, UserSK 		WorkItemRevision、 WorkItemSnapshot、、 WorkItemBoardSnapshot
Teams Area、、BoardLocationIteration、WorkItemRevision、WorkItemSnapshot、WorkItemBoardSnapshot
标记 WorkItem、 WorkItemRevision、、 WorkItemBoardSnapshot
Project Project
ProjectSK, ProjectSK 		Tag、、WorkItemBoardSnapshotWorkItemLink、WorkItemRevision、WorkItemSnapshot、、 WorkItemTypeField
进程 WorkItemRevision、 WorkItem、、 WorkItemSnapshot
修订 WorkItem
链接 WorkItem
Children WorkItem
Parent WorkItem
Descendants WorkItem
WorkItem WorkItemId WorkItemRevision

预测函数

WorkItem 实体支持以下两个函数。 这些函数用于支持所选 Analytics 内置报表和小组件的预测趋势。

  • PredictTags
  • Predict

BoardLocation 和 WorkItemBoardSnapshot

下表中列出的和描述的属性是针对以下实体类型定义的，除非特别说明。 使用这些字段，可以根据团队板列、泳道或积压工作级别中工作项的状态筛选工作项数据。

  • BoardLocation
  • WorkItemBoardSnapshot

有关查询 WorkItemBoardSnapshot 实体集的示例，请参阅 (CFD) 示例报表的累积流图。

显示名称
Property name		 数据类型 描述
Reference name
板 ID
BoardId		 Guid 分配给开发板的唯一 GUID。 每个团队都与一个或多个董事会相关联。
板类别引用名称
BoardCategoryReferenceName		 字符串 分配给用于填充开发板的工作项类型的类别的名称。 例如，产品积压工作板与“要求”类别相关联。 有关详细信息，请参阅自定义积压工作或面板（继承的流程）。
电路板名称
BoardName		 字符串 分配给开发板的名称。 例如，故事、积压工作项、功能和长篇故事。
板级别
BoardLevel		 Int32 根据它位于板层次结构中的位置分配给开发板的数字。
积压工作类型
BacklogType		 字符串 积压工作类型的名称。 例如，迭代、要求或项目组合。
列名称
ColumnName		 字符串 工作项当前分配的板列的名称，例如 Active、Closed、Committed、Done 或其他自定义列标签。
System.BoardColumn
列顺序
ColumnOrder		 Int32 根据板中的序列分配给板列的数字。
已完成
Done		 Enumerated 指示拆分列的位置。 下面列出了 BoardColumnSplit 的有效值。
列项限制
ColumnItemLimit		 Int32 按顺序分配给板列的数字。
板是否可见
IsBoardVisible		 布尔值 指示团队是否已选择使版块可见。
是否拆分列
IsColumnSplit		 布尔 指示列是否已拆分为 “正在执行 ”和 “完成 ”列，如开发板上的 “拆分”列中所述，以显示正在进行的工作。
是否为最新
IsCurrent		 布尔值 通过将 值设置为 True，支持筛选数据以查看已筛选的工作项集的最新快照的属性。
是默认通道
IsDefaultLane		 布尔值 指示工作项分配给默认泳道的属性 (True) 或不 (False) 。
已完成
IsDone		 布尔 在列中将工作项的当前赋值（False）或“完成”（True）。 仅在为面板栏启用拆分栏时分配。
System.BoardColumnDone
通道 ID
LaneId		 Guid 分配给板泳道的唯一 GUID。 每个团队都可以向板中添加一个或多个泳道。 有关泳道的详细信息，请参阅 在棋盘中使用泳道加快团队的工作速度。
通道名称
LaneName		 字符串 分配给板泳道的名称。
System.BoardLane
通道顺序
LaneOrder		 Int32 按顺序分配给板泳道的数字。

BoardColumnSplit 枚举成员

下表列出了枚举类型的成员名称 BoardColumnSplit ，可用于筛选“ 正在执行” 或 “完成 ”板列中的工作项。

成员名称 值 显示名称
Doing 0 正在执行
Done 1 完成
Unknown 2 未知 (未拆分)

有关团队的板列的详细信息，请参阅以下文章：

Areas

以下属性对与“区域路径”字段关联的“区域”实体集有效。 与 Area 关联的代理键包括 AreaSK 和 ProjectSK。 可以使用这些属性根据区域路径分配筛选或报告工作跟踪数据。

显示名称 名称 数据类型 描述
AnalyticsUpdatedDate DateTime 指示上次更新 Analytics 数据的水印。
Number Int32 创建区域路径节点时分配给该节点的整数值。
Depth Depth Int32 根据从根级别开始的深度定义区域路径的级别。
区域 ID AreaId GUID 创建区域路径时分配给区域路径的唯一标识符。
区域级别 1 到
区域级别 14		 AreaLevel1 到
AreaLevel14		 String 与区域路径的节点级别关联的名称。 最多支持 14 个嵌套级别。 例如，区域级别 1 始终对应于根节点和项目名称。
区域名称 AreaName String 创建区域路径时为其定义的名称。
区域路径 AreaPath String 从根节点开始的区域路径的完整路径。

重要

  • 删除 区域路径 或重新配置 迭代路径 会导致不可逆的数据丢失。 例如，具有已更改 区域路径 的团队的冲刺烧毁和速度图表不会显示准确的数据。 历史趋势图引用 区域路径 和 迭代路径 ，因为它们是在每次为工作项定义的。 删除后，无法检索这些路径的历史数据。
  • 只能删除任何工作项不再使用的区域和迭代路径。

Area 实体类型和 Areas 实体集的导航属性包括 Project 和 Teams。

有关区域路径的详细信息，请参阅以下文章：

迭代

以下属性对 迭代 实体集有效，该集与 “迭代路径 ”字段相关联。 与 迭代 关联的代理键包括 IterationSK 和 ProjectSK。 可以使用这些属性根据迭代路径分配筛选或报告工作跟踪数据。

显示名称 名称 数据类型 描述
AnalyticsUpdatedDate DateTime 指示上次更新 Analytics 数据的水印。
Number Int32 创建迭代路径节点时分配给迭代路径节点的整数值。
Depth Depth Int32 迭代路径基于其从根级别的深度定义的级别。
结束日期 EndDate DateTime 为迭代路径定义的结束日期。
IsEnded IsEnded 布尔值 设置为 True 时，指示迭代路径结束日期是过去。
迭代 ID IterationId GUID 创建迭代路径时分配给迭代路径的唯一标识符。
迭代级别 1 到
迭代级别 14		 IterationLevel1 到
IterationLevel14		 字符串 与迭代路径的节点级别关联的名称。 最多支持 14 个嵌套级别。 例如，迭代级别 1 始终对应于根节点和项目名称。
迭代名称 IterationName 字符串 创建迭代路径时为其定义的名称。
迭代路径 IterationPath 字符串 从根节点开始的迭代路径的完整路径。 迭代必须是项目层次结构中的有效节点。
System.IterationPath
开始日期 StartDate DateTime 为迭代路径定义的开始日期。

重要

  • 删除 区域路径 或重新配置 迭代路径 会导致不可逆的数据丢失。 例如，具有已更改 区域路径 的团队的冲刺烧毁和速度图表不会显示准确的数据。 历史趋势图引用 区域路径 和 迭代路径 ，因为它们是在每次为工作项定义的。 删除后，无法检索这些路径的历史数据。
  • 只能删除任何工作项不再使用的区域和迭代路径。

迭代实体类型和迭代实体集的导航属性包括 Project 和 Teams。

有关迭代路径的详细信息，请参阅以下文章：

进程

以下属性对 Process 实体类型和 Process 实体集有效。 与 Process 关联的代理键包括 ProcessSK、 ProjectSK和 TeamSK。 可以使用这些属性根据项目或团队使用的工作项类型筛选或报告工作跟踪数据。

注意

v-2.0、v3.0-preview 和 v4.0-preview 版本的 Analytics 支持进程实体类型和进程实体集。

可以使用这些属性根据积压工作级别筛选工作跟踪数据

显示名称 名称 数据类型 描述
AnalyticsUpdatedDate DateTime 指示上次更新分析数据的水印。
ProjectSK GUID 与流程关联的项目密钥。
TeamSK GUID 与流程关联的团队密钥。
积压工作类别引用名称 BacklogCategoryReferenceName 字符串 分配给与工作项类型关联的积压工作的类别引用名称。 示例包括 Microsoft.EpicCategory、 Microsoft.FeatureCategory、 Microsoft.RequirementCategory、 Microsoft.TaskCategory。
积压工作名称 BacklogName 布尔值 分配给与工作项类型关联的积压工作的引用名称
积压工作类型 BacklogType GUID 创建迭代路径时分配给迭代路径的唯一标识符。
积压工作级别 BacklogLevel 字符串 指定与工作项类型关联的积压工作级别。 如果工作项类型未与积压工作级别关联，则返回 null的值为 。
工作项类型 WorkItemType 字符串 为工作项类型定义的名称。
有积压工作 HasBacklog 字符串 指示工作项类型是否属于积压工作。
是隐藏类型 IsHiddenType 布尔值 指示是否已禁用工作项类型。
Bug 类型 IsBugType 布尔值 指示工作项类型是否属于 Bug 类别。
已删除 IsDeleted 布尔值 指示是否已删除工作项类型。

有关进程积压工作项类型的详细信息，请参阅以下文章：

自定义工作项类型和自定义积压工作类别

自定义工作项类型的数据会自动添加到 Analytics 服务。

定义自定义工作项类型和积压工作级别时，将创建自定义类别。 Custom_ 在类别 GUID 前面附加。 例如，对于包含 项目组合 积压工作的项目组合自定义工作项类型，GUID 分配给自定义类别，例如 Custom.49b81c4e-9c4f-4c04-94fd-d660cbf3a000。

标记

以下属性对 Tags 实体集有效。 与 标记 关联的代理键包括 TagSK 和 ProjectSK。 导航属性包括 Project 及其引用约束 ProjectSK。 有关使用标记的详细信息，请参阅 添加工作项标记以对列表和板进行分类和筛选。

可以使用这些属性筛选或报告工作跟踪数据。

显示名称 名称 数据类型 描述
标记 ID TagId GUID 创建标记时分配给标记的唯一 ID。
标记名称 TagName 字符串 标记名称。

Teams

以下属性对 Team 实体类型和 Teams 实体集有效。 与 Team 关联的代理键包括 TeamSK 和 ProjectSK。 可以使用这些属性根据团队分配筛选或报告工作跟踪数据。 有关使用和添加团队的信息，请参阅关于团队和敏捷工具和创建或添加团队。

显示名称 名称 数据类型 描述
AnalyticsUpdatedDate DateTime 指示上次更新 Analytics 数据的水印。
团队 ID TeamId GUID 创建团队时分配给团队的唯一 ID。
团队名称 TeamName 字符串 团队名称。

Teams 实体集的导航属性包括 Projects、 Areas和 Iterations。

以下属性对 WorkItemLinks 实体集有效。 属性引用代理项键为 WorkItemLinkSK。 查询 WorkItemLinks 以报告父/子链接、相关链接、前置链接/后续链接类型或其他链接类型。

显示名称 名称 数据类型 描述
AnalyticsUpdatedDate DateTime 指示上次更新 Analytics 数据的水印。
WorkItemLinkSK Int32 分配给实体的 WorkItemLink 代理键。
创建日期 CreatedDate GUID 创建链接的日期。
注释 Comment 字符串 创建链接时添加的注释。
删除日期 DeletedDate 字符串 删除链接的日期。
链接类型 ID LinkTypeId Int32 分配给链接到的目标工作项的 ID。
链接类型名称 LinkTypeName 字符串 分配给链接类型的友好名称。
链接类型引用名称 LinkTypeReferenceName 字符串 分配给链接类型的引用名称。
链接类型是无环的 LinkTypeIsAcyclic 布尔值 当值设置为 True 时，指示链接类型的链接类型属性的值允许循环关系。 例如，树类型链接限制循环关系。
链接类型为方向 LinkTypeIsDirectional 布尔值 指示链接类型为方向的链接类型属性的值。 方向链接类型与正向和反向组件成对定义。
源工作项 ID SourceWorkItemId Int32 分配给链接到的源工作项的 ID。
目标工作项 ID TargetWorkItemId Int32 分配给链接到的目标工作项的 ID。

WorkItemLink 实体类型的导航属性包括 Projects、 SourceWorkItem和 TargetWorkItem。

有关链接和链接类型的详细信息，请参阅以下文章：

WorkItemTypeFields

以下属性对 WorkItemTypeFields 实体集有效。 属性引用键为 FieldName、 ProjectSK和 WorkItemType。

显示名称 名称 数据类型 描述
字段名称 FieldName String 系统或创建字段时分配给字段的友好名称。
字段引用名称 FieldReferenceName 字符串 系统或创建自定义字段时分配给字段的引用名称。
字段类型 FieldType String 分配给字段的数据类型。
工作项类型 WorkItemType 字符串 为其定义字段的工作项类型的名称。

导航属性包括 Project。

有关为项目定义的所有字段的索引，请参阅 工作项字段的字段说明。 有关其他信息，请参阅以下文章：

自定义属性

自定义字段作为自定义属性自动添加到 Analytics 服务。 Custom_ 或 Custom. 在属性名称前面追加。 检查集合的元数据，如 为 Analytics 构造 OData 查询中所述，URL 组件用于查询元数据。 以下示例提供自定义字段 Risk Opportunity 的元数据语法。

<Property Name="Custom_RiskOpportunity" Type="Edm.Double">
<Annotation Term="Display.DisplayName" String="Risk Opportunity"/>
<Annotation Term="Ref.ReferenceName" String="Custom.RiskOpportunity"/>
<Annotation Term="Display.Description" String="Risk Reduction | Opportunity Enablement Value. Enter a value from 1 to 5. 5 represents high risk reduction or high opportunity enablement."/>
</Property>