通过

Fields - List

  • 参考
服务:
Work Item Tracking Process
API 版本:
7.1-preview.2

返回工作项类型中所有字段的列表。

GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/fields?api-version=7.1-preview.2

URI 参数

名称 在 必需 类型 说明
organization
 path True

string

Azure DevOps 组织的名称。
processId
 path True

string

uuid

进程的 ID。
witRefName
 path True

string

工作项类型的引用名称。
api-version
 query True

string

要使用的 API 版本。 应将其设置为“7.1-preview.2”才能使用此版本的 API。

响应

名称 类型 说明
200 OK

ProcessWorkItemTypeField[]

成功的操作

安全性

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 授予读取工作项、查询、版块、区域和迭代路径以及其他工作项跟踪相关元数据的能力。 此外，还授予执行查询、搜索工作项以及通过服务挂钩接收有关工作项事件的通知的能力。

示例

Returns a list of all fields in a work item type

示例请求

GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/fields?api-version=7.1-preview.2

示例响应

状态代码:
200 
{
  "count": 36,
  "value": [
    {
      "referenceName": "System.State",
      "name": "State",
      "type": "string",
      "required": true,
      "defaultValue": "New",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "inherited"
    },
    {
      "referenceName": "System.Reason",
      "name": "Reason",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "inherited"
    },
    {
      "referenceName": "Microsoft.VSTS.Common.ClosedDate",
      "name": "Closed Date",
      "type": "dateTime",
      "description": "",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "inherited"
    },
    {
      "referenceName": "Microsoft.VSTS.Common.ClosedBy",
      "name": "Closed By",
      "type": "string",
      "description": "",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "inherited"
    },
    {
      "referenceName": "Custom.Fields.Colors",
      "name": "Colors",
      "type": "string",
      "description": "My new field",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "custom"
    },
    {
      "referenceName": "System.IterationPath",
      "name": "Iteration Path",
      "type": "treePath",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.ExternalLinkCount",
      "name": "External Link Count",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.TeamProject",
      "name": "Team Project",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.HyperLinkCount",
      "name": "Hyperlink Count",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.AttachedFileCount",
      "name": "Attached File Count",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.AreaPath",
      "name": "Area Path",
      "type": "treePath",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.ChangedDate",
      "name": "Changed Date",
      "type": "dateTime",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.Id",
      "name": "ID",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.AuthorizedAs",
      "name": "Authorized As",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.Title",
      "name": "Title",
      "type": "string",
      "required": true,
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.AuthorizedDate",
      "name": "Authorized Date",
      "type": "dateTime",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.Rev",
      "name": "Rev",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.ChangedBy",
      "name": "Changed By",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.AssignedTo",
      "name": "Assigned To",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.WorkItemType",
      "name": "Work Item Type",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.CreatedDate",
      "name": "Created Date",
      "type": "dateTime",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.CreatedBy",
      "name": "Created By",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.Description",
      "name": "Description",
      "type": "html",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.History",
      "name": "History",
      "type": "history",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.RelatedLinkCount",
      "name": "Related Link Count",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.Tags",
      "name": "Tags",
      "type": "plainText",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.BoardColumn",
      "name": "Board Column",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.BoardColumnDone",
      "name": "Board Column Done",
      "type": "boolean",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.BoardLane",
      "name": "Board Lane",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.IterationId",
      "name": "Iteration ID",
      "type": "integer",
      "required": true,
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.RemoteLinkCount",
      "name": "Remote Link Count",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.CommentCount",
      "name": "Comment Count",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.NodeName",
      "name": "Node Name",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.RevisedDate",
      "name": "Revised Date",
      "type": "dateTime",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.AreaId",
      "name": "Area ID",
      "type": "integer",
      "required": true,
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.Watermark",
      "name": "Watermark",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    }
  ]
}

定义

名称 说明
CustomizationType

指示此工作项的自定义类型。 系统行为继承自父进程，但未修改。 继承的行为是从父进程继承的修改行为。 自定义行为是用户在当前进程中创建的行为。
FieldType
ProcessWorkItemTypeField

描述工作项类型中的字段及其属性的类。

CustomizationType

Enumeration

指示此工作项的自定义类型。 系统行为继承自父进程，但未修改。 继承的行为是从父进程继承的修改行为。 自定义行为是用户在当前进程中创建的行为。

值 说明
custom

如果自定义了新创建的 workitemtype，则 Customization-type 为 Custom。
inherited

如果自定义继承进程的现有工作项类型，则 Customization-type 为 Inherited。
system

如果 是系统生成的 workitemtype，则 Customization-type 为 System。

FieldType

Enumeration
值 说明
boolean

布尔字段类型。
dateTime

DateTime 字段类型。
double

Double 字段类型。
guid

Guid 字段类型。
history

历史记录字段类型。
html

HTML (多行) 字段类型。
identity

标识字段类型。
integer

整数字段类型。
picklistDouble

双选取列表字段类型。
picklistInteger

整数选取列表字段类型。
picklistString

字符串选取列表字段类型。
plainText

纯文本字段类型。
string

字符串字段类型。
treePath

树路径字段类型。

ProcessWorkItemTypeField

Object

描述工作项类型中的字段及其属性的类。

名称 类型 说明
allowGroups

boolean

允许将字段值设置为组标识。 仅适用于标识字段。
allowedValues

object[]

字段允许值的列表。
customization

CustomizationType

指示此工作项的自定义类型。
defaultValue

object

字段的默认值。
description

string

字段的说明。
isLocked

boolean

有关被锁定以便编辑的字段定义的信息
name

string

字段的名称。
readOnly

boolean

如果为 true，则无法编辑该字段。
referenceName

string

字段的引用名称。
required

boolean

如果为 true，则字段不能为空。
type

FieldType

字段的类型。
url

string

字段的资源 URL。