列出工作项字段和属性

工作项字段用于跟踪 Azure DevOps 内的信息。 这些字段可在组织级别定义，并在组织中的所有项目中共享。 若要查看为组织定义的字段，可以使用以下两种工具之一，这两个工具同时适用于继承和托管的 XML 流程模型：

• 流程 > 字段网页
• 工作项字段资源管理器

工作项字段用于跟踪 Azure DevOps 内的信息。 这些字段可在集合级别定义，并在该集合中的所有项目中共享。 若要查看为集合定义的字段，请使用以下工具之一：

• 流程 > 字段网页：适用于继承的流程模型。
• 工作项字段资源管理器：适用于继承和本地 XML 流程模型。

可以通过打开“流程”>“字段”页来查看为组织定义的字段的数据类型。

当项目集合使用继承流程模型来自定义工作跟踪时，可以通过打开“流程 > 字段”页面来查看字段的数据类型。

如果项目集合使用本地 XML 流程模型，则可以通过“工作项字段索引”来确定数据类型。 此外，也可以：

• 打开“工作项字段资源管理器”，以查看定义的字段及其属性。
• 使用 witadmin listfields 命令列出字段属性。

有关详细信息，请参阅本文后面的工作项字段资源管理器和列表字段属性。

可报告属性

所有报告属性仅对内部部署有效，其中项目配置为支持 SQL Server Reporting Service 和 SQL Server Analysis Service。 有关详细信息，请参阅将报告添加到项目。

有关每个可报告属性的说明，请参阅添加或修改工作项字段以支持报告。

若要查看具有默认情况下定义的可报告属性的字段列表，请参阅可报告字段引用。

索引字段

使用 witadmin indexfield 命令启用或禁用工作项字段的索引。 启用字段索引可以提高指定该字段的查询的性能。 默认情况下，将为以下字段编制索引：

• 分配到
• 创建日期
• 更改者
• State
• Reason
• 区域 ID
• 迭代 ID
• 工作项类型

如果添加在工作项查询中常用的自定义字段，请考虑为该字段启用索引。 有关详细信息，请参阅管理工作项字段 (witadmin)。

可以使用字段 - 获取 REST API 列出分配给字段的属性。 将 OrganizationName 替换为实际的组织名称。

https://dev.azure.com/OrganizationName/_apis/wit/fields/FieldReferenceName

例如，若要列出迭代路径的属性，请使用 System.IterationPath 组织的引用名称 fabrikam：

https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath

**Returned data:**

> [!div class="tabbedCodeSnippets"]
> ```JSON
> {
> "name": "Iteration Path",
> "referenceName": "System.IterationPath",
> "description": "The iteration within which this bug will be fixed",
> "type": "treePath",
> "usage": "workItem",
> "readOnly": false,
> "canSortBy": true,
> "isQueryable": true,
> "supportedOperations": [
> {
> "referenceName": "SupportedOperations.Under",
> "name": "Under"
> },
> {
> "referenceName": "SupportedOperations.NotUnder",
> "name": "Not Under"
> },
> {
> "referenceName": "SupportedOperations.Equals",
> "name": "="
> },
> {
> "referenceName": "SupportedOperations.NotEquals",
> "name": "<>"
> },
> {
> "referenceName": "SupportedOperations.In",
> "name": "In"
> },
> {
> "name": "Not In"
> }
> ],
> "isIdentity": false,
> "isPicklist": false,
> "isPicklistSuggested": false,
> "url": "https://dev.azure.com/mseng/_apis/wit/fields/System.IterationPath"
> }
> ```

可以使用字段 - 获取 REST API 列出分配给字段的属性。 为“组织名称”输入组织名称。 若要开始使用 REST，请参阅 Azure DevOps Services REST API 参考

https://{ServerName:Port}/tfs/{Collection}/_apis/wit/fields/FieldReferenceName?api-version={version}

例如，此处我们列出了迭代路径的属性，并为 fabrikam 服务器指定引用名称 System.IterationPath。

https://fabrikam:8080/tfs/DefaultCollection/_apis/wit/fields/System.IterationPath?api-version=4.1

返回的数据：

{
"name": "Iteration Path",
"referenceName": "System.IterationPath",
"description": "The iteration within which this bug will be fixed",
"type": "treePath",
"usage": "workItem",
"readOnly": false,
"canSortBy": true,
"isQueryable": true,
"supportedOperations": [
{
"referenceName": "SupportedOperations.Under",
"name": "Under"
},
{
"referenceName": "SupportedOperations.NotUnder",
"name": "Not Under"
},
{
"referenceName": "SupportedOperations.Equals",
"name": "="
},
{
"referenceName": "SupportedOperations.NotEquals",
"name": "<>"
},
{
"referenceName": "SupportedOperations.In",
"name": "In"
},
{
"name": "Not In"
}
],
"isIdentity": false,
"isPicklist": false,
"isPicklistSuggested": false,
"url": "https://fabrikam:8080/tfs/DefaultCollection/_apis/wit/fields/System.IterationPath?api-version=4.1"
}

使用 witadmin 命令行工具列出属性

可以使用 witadmin listfields 命令列出选择字段属性（如数据类型、可报告属性和索引）。

例如，可以输入以下命令以列出为指定字段定义的属性，例如 Microsoft.VSTS.Common.Issue。

witadmin listfields /collection:http://fabrikam:8080/tfs/DefaultCollection /n:Microsoft.VSTS.Common.Issue  

为命名字段显示的字段和特性信息，如本示例所示。

Field: Microsoft.VSTS.Common.Issue  
Name: Issue  
Type: String  
Reportable As: dimension  
Use: Adventure Works (Shared Steps), AW Future (Shared Steps), AW Current (Shared Steps)  
Indexed: False  

Use 参数指示每个项目的名称和使用字段的工作项类型。

若要将字段添加到流程，请将它们添加到一个或多个工作项类型。 有关详细信息，请参阅 自定义继承过程。

可以添加或修改 WIT 中包含的字段，也可以添加自定义 WIT。 有关详细信息，请参阅：

• 对于使用继承流程模型的项目集合：自定义继承流程。
• 对于使用本地 XML 流程模型的项目集合：自定义本地 XML 流程模型。

可以使用 witadmin 命令行工具更改系统字段以外的所有字段的字段名称、索引和报表属性。 有关详细信息，请参阅管理工作项字段-witadmin。

• 请参阅“查询快速参考”，快速了解查询语法和用法。
• 探索工作项字段索引，查看所有可用的工作项字段。
• 添加和管理继承流程的字段，根据继承的流程要求自定义字段。
• 访问 Azure Boards Analytics 的元数据参考，了解分析元数据和报告功能。

• 请参阅“查询快速参考”，快速了解查询语法和用法。
• 探索工作项字段索引，查看所有可用的工作项字段。
• 选择项目集合的流程模型，根据需要选择适当的流程模型。
• 根据项目的要求修改工作项字段。
• 使用 witadmin 管理工作项字段，以执行高级字段管理任务。
• 访问 Azure Boards Analytics 的元数据参考，了解分析元数据和报告功能。