Layout - Get

参考

服务:: Work Item Tracking Process

API 版本:: 7.1

获取窗体布局。

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

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”才能使用此版本的 API。

响应

名称	类型	说明
200 OK	FormLayout	成功作

安全性

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

示例

Get the form layout

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "pages": [
    {
      "id": "Agile.Bug.Bug",
      "inherited": true,
      "overridden": true,
      "label": "Details",
      "pageType": "custom",
      "locked": false,
      "visible": true,
      "isContribution": false,
      "sections": [
        {
          "id": "Section1",
          "groups": [
            {
              "id": "Agile.Bug.Bug.Repro Steps.WideGroup",
              "inherited": true,
              "label": "Repro Steps",
              "isContribution": false,
              "visible": true,
              "controls": [
                {
                  "id": "Microsoft.VSTS.TCM.ReproSteps",
                  "inherited": true,
                  "label": "Repro Steps",
                  "controlType": "HtmlFieldControl",
                  "readOnly": false,
                  "watermark": "",
                  "metadata": "",
                  "visible": true,
                  "isContribution": false
                }
              ]
            },
            {
              "id": "Agile.Bug.Bug.System Info.WideGroup",
              "inherited": true,
              "label": "System Info",
              "isContribution": false,
              "visible": true,
              "controls": [
                {
                  "id": "Microsoft.VSTS.TCM.SystemInfo",
                  "inherited": true,
                  "label": "System Info",
                  "controlType": "HtmlFieldControl",
                  "readOnly": false,
                  "watermark": "",
                  "metadata": "",
                  "visible": true,
                  "isContribution": false
                }
              ]
            }
          ]
        },
        {
          "id": "Section2",
          "groups": [
            {
              "id": "Agile.Bug.Bug.Planning",
              "inherited": true,
              "label": "Planning",
              "isContribution": false,
              "visible": true,
              "controls": [
                {
                  "id": "Microsoft.VSTS.Common.ResolvedReason",
                  "inherited": true,
                  "label": "Resolved Reason",
                  "controlType": "FieldControl",
                  "readOnly": false,
                  "watermark": "",
                  "metadata": "",
                  "visible": true,
                  "isContribution": false
                },
                {
                  "id": "Microsoft.VSTS.Scheduling.StoryPoints",
                  "inherited": true,
                  "label": "Story Points",
                  "controlType": "FieldControl",
                  "readOnly": false,
                  "watermark": "",
                  "metadata": "",
                  "visible": true,
                  "isContribution": false
                },
                {
                  "id": "Microsoft.VSTS.Common.Priority",
                  "inherited": true,
                  "label": "Priority",
                  "controlType": "FieldControl",
                  "readOnly": false,
                  "watermark": "",
                  "metadata": "",
                  "visible": true,
                  "isContribution": false
                },
                {
                  "id": "Microsoft.VSTS.Common.Severity",
                  "inherited": true,
                  "label": "Severity",
                  "controlType": "FieldControl",
                  "readOnly": false,
                  "watermark": "",
                  "metadata": "",
                  "visible": true,
                  "isContribution": false
                },
                {
                  "id": "Microsoft.VSTS.Common.Activity",
                  "inherited": true,
                  "label": "Activity",
                  "controlType": "FieldControl",
                  "readOnly": false,
                  "watermark": "",
                  "metadata": "",
                  "visible": true,
                  "isContribution": false
                }
              ]
            },
            {
              "id": "Agile.Bug.Bug.Effort (Hours)",
              "inherited": true,
              "label": "Effort (Hours)",
              "isContribution": false,
              "visible": true,
              "controls": [
                {
                  "id": "Microsoft.VSTS.Scheduling.OriginalEstimate",
                  "inherited": true,
                  "label": "Original Estimate",
                  "controlType": "FieldControl",
                  "readOnly": false,
                  "watermark": "",
                  "metadata": "",
                  "visible": true,
                  "isContribution": false
                },
                {
                  "id": "Microsoft.VSTS.Scheduling.RemainingWork",
                  "inherited": true,
                  "label": "Remaining",
                  "controlType": "FieldControl",
                  "readOnly": false,
                  "watermark": "",
                  "metadata": "",
                  "visible": true,
                  "isContribution": false
                },
                {
                  "id": "Microsoft.VSTS.Scheduling.CompletedWork",
                  "inherited": true,
                  "label": "Completed",
                  "controlType": "FieldControl",
                  "readOnly": false,
                  "watermark": "",
                  "metadata": "",
                  "visible": true,
                  "isContribution": false
                }
              ]
            },
            {
              "id": "ms-devlabs.vsts-uservoice-ui.vsts-uservoice-ui-wi-group",
              "label": "Customer feedback",
              "contribution": {
                "contributionId": "ms-devlabs.vsts-uservoice-ui.vsts-uservoice-ui-wi-group"
              },
              "isContribution": true,
              "visible": true,
              "controls": []
            },
            {
              "id": "ottostreifel.board-group.board-work-item-form-group",
              "label": "Board",
              "contribution": {
                "contributionId": "ottostreifel.board-group.board-work-item-form-group"
              },
              "isContribution": true,
              "visible": true,
              "controls": []
            }
          ]
        },
        {
          "id": "Section3",
          "groups": [
            {
              "id": "Agile.Bug.Bug.Development",
              "inherited": true,
              "label": "Development",
              "isContribution": false,
              "visible": true,
              "controls": [
                {
                  "id": "Development",
                  "inherited": true,
                  "label": "",
                  "controlType": "LinksControl",
                  "readOnly": false,
                  "watermark": "",
                  "metadata": "<LinksControlOptions ViewMode=\"Dynamic\" ZeroDataExperience=\"Development\" ShowCallToAction=\"true\"><ListViewOptions GroupLinks=\"false\"></ListViewOptions><LinkFilters><ExternalLinkFilter Type=\"Build\" /><ExternalLinkFilter Type=\"Integrated in build\" /><ExternalLinkFilter Type=\"Pull Request\" /><ExternalLinkFilter Type=\"Branch\" /><ExternalLinkFilter Type=\"Fixed in Commit\" /><ExternalLinkFilter Type=\"Fixed in Changeset\" /><ExternalLinkFilter Type=\"Source Code File\" /><ExternalLinkFilter Type=\"Found in build\" /></LinkFilters></LinksControlOptions>",
                  "visible": true,
                  "isContribution": false
                }
              ]
            },
            {
              "id": "Agile.Bug.Bug.Related Work",
              "inherited": true,
              "label": "Related Work",
              "isContribution": false,
              "visible": true,
              "controls": [
                {
                  "id": "Related Work",
                  "inherited": true,
                  "label": "",
                  "controlType": "LinksControl",
                  "readOnly": false,
                  "watermark": "",
                  "metadata": "<LinksControlOptions><LinkFilters><WorkItemLinkFilter Type=\"System.LinkTypes.Duplicate-Reverse\" /><WorkItemLinkFilter Type=\"System.LinkTypes.Hierarchy-Reverse\" /><WorkItemLinkFilter Type=\"Microsoft.VSTS.Common.TestedBy-Forward\" /><WorkItemLinkFilter Type=\"Microsoft.VSTS.Common.TestedBy-Reverse\" /><WorkItemLinkFilter Type=\"System.LinkTypes.Hierarchy-Forward\" /><WorkItemLinkFilter Type=\"System.LinkTypes.Duplicate-Forward\" /><WorkItemLinkFilter Type=\"System.LinkTypes.Dependency\" /><WorkItemLinkFilter Type=\"System.LinkTypes.Related\" /></LinkFilters><Columns><Column Name=\"System.State\" /><Column Name=\"System.ChangedDate\" /><Column Name=\"System.Links.Comment\" /></Columns></LinksControlOptions>",
                  "visible": true,
                  "isContribution": false
                }
              ]
            },
            {
              "id": "Agile.Bug.Bug.System Info",
              "inherited": true,
              "label": "System Info",
              "isContribution": false,
              "visible": true,
              "controls": [
                {
                  "id": "Microsoft.VSTS.Build.FoundIn",
                  "inherited": true,
                  "label": "Found in Build",
                  "controlType": "FieldControl",
                  "readOnly": false,
                  "watermark": "",
                  "metadata": "",
                  "visible": true,
                  "isContribution": false
                },
                {
                  "id": "Microsoft.VSTS.Build.IntegrationBuild",
                  "inherited": true,
                  "label": "Integrated in Build",
                  "controlType": "FieldControl",
                  "readOnly": false,
                  "watermark": "",
                  "metadata": "",
                  "visible": true,
                  "isContribution": false
                }
              ]
            }
          ]
        },
        {
          "id": "Section4",
          "groups": []
        }
      ]
    },
    {
      "id": "Agile.Bug.System_History",
      "inherited": true,
      "label": "History",
      "pageType": "history",
      "locked": true,
      "visible": true,
      "isContribution": false,
      "sections": [
        {
          "id": "Section1",
          "groups": [
            {
              "id": "Agile.Bug.System_History.History",
              "inherited": true,
              "label": "History",
              "isContribution": false,
              "visible": true,
              "controls": [
                {
                  "id": "System.History",
                  "inherited": true,
                  "controlType": "WorkItemLogControl",
                  "visible": true,
                  "isContribution": false
                }
              ]
            }
          ]
        },
        {
          "id": "Section2",
          "groups": []
        },
        {
          "id": "Section3",
          "groups": []
        },
        {
          "id": "Section4",
          "groups": []
        }
      ]
    },
    {
      "id": "Agile.Bug.System_Links",
      "inherited": true,
      "label": "Links",
      "pageType": "links",
      "locked": true,
      "visible": true,
      "isContribution": false,
      "sections": [
        {
          "id": "Section1",
          "groups": [
            {
              "id": "Agile.Bug.System_Links.Links",
              "inherited": true,
              "label": "Links",
              "isContribution": false,
              "visible": true,
              "controls": [
                {
                  "inherited": true,
                  "controlType": "LinksControl",
                  "metadata": "<LinksControlOptions ZeroDataExperience=\"CallToAction\"><Columns><Column Name=\"System.State\" /><Column Name=\"System.ChangedDate\" /><Column Name=\"System.Links.Comment\" /></Columns></LinksControlOptions>",
                  "visible": true,
                  "isContribution": false
                }
              ]
            }
          ]
        },
        {
          "id": "Section2",
          "groups": []
        },
        {
          "id": "Section3",
          "groups": []
        },
        {
          "id": "Section4",
          "groups": []
        }
      ]
    },
    {
      "id": "Agile.Bug.System_Attachments",
      "inherited": true,
      "label": "Attachments",
      "pageType": "attachments",
      "locked": true,
      "visible": true,
      "isContribution": false,
      "sections": [
        {
          "id": "Section1",
          "groups": [
            {
              "id": "Agile.Bug.System_Attachments.Attachments",
              "inherited": true,
              "label": "Attachments",
              "isContribution": false,
              "visible": true,
              "controls": [
                {
                  "inherited": true,
                  "label": "Attachments",
                  "controlType": "AttachmentsControl",
                  "visible": true,
                  "isContribution": false
                }
              ]
            }
          ]
        },
        {
          "id": "Section2",
          "groups": []
        },
        {
          "id": "Section3",
          "groups": []
        },
        {
          "id": "Section4",
          "groups": []
        }
      ]
    }
  ],
  "systemControls": [
    {
      "id": "System.Title",
      "label": "",
      "controlType": "FieldControl",
      "readOnly": false,
      "watermark": "Enter title",
      "visible": true,
      "isContribution": false
    },
    {
      "id": "System.AssignedTo",
      "label": "Assi&gned To",
      "controlType": "FieldControl",
      "readOnly": false,
      "watermark": "",
      "visible": true,
      "isContribution": false
    },
    {
      "id": "System.State",
      "label": "Stat&e",
      "controlType": "FieldControl",
      "readOnly": false,
      "watermark": "",
      "visible": true,
      "isContribution": false
    },
    {
      "id": "System.Reason",
      "label": "Reason",
      "controlType": "FieldControl",
      "readOnly": false,
      "watermark": "",
      "visible": true,
      "isContribution": false
    },
    {
      "id": "System.AreaPath",
      "label": "&Area",
      "controlType": "WorkItemClassificationControl",
      "readOnly": false,
      "watermark": "",
      "visible": true,
      "isContribution": false
    },
    {
      "id": "System.IterationPath",
      "label": "Ite&ration",
      "controlType": "WorkItemClassificationControl",
      "readOnly": false,
      "watermark": "",
      "visible": true,
      "isContribution": false
    },
    {
      "id": "System.History",
      "label": "History",
      "controlType": "WorkItemLogControl",
      "readOnly": false,
      "watermark": "",
      "visible": true,
      "isContribution": false
    },
    {
      "id": "Links",
      "label": "Links",
      "controlType": "LinksControl",
      "readOnly": false,
      "watermark": "",
      "visible": true,
      "isContribution": false
    },
    {
      "id": "Attachments",
      "label": "Attachments",
      "controlType": "AttachmentsControl",
      "readOnly": false,
      "watermark": "",
      "visible": true,
      "isContribution": false
    }
  ]
}

定义

名称	说明
Control	表示窗体中的控件。
Extension	表示布局的扩展部分
FormLayout	描述工作项类型的布局
Group	表示窗体中保存控件的组。
Page	描述工作项窗体布局中的页面
PageType	页面的图标。
Section	定义工作项窗体布局的一部分
WitContribution	工作项表单贡献的属性

Control

Object

表示窗体中的控件。

名称	类型	说明
contribution	WitContribution	控件的贡献。
controlType	string	控件的类型。
height	integer (int32)	控件的高度，对于 html 控件。
id	string	布局节点的 ID。
inherited	boolean	一个值，该值指示是否已继承此布局节点。从父布局。这应仅由合并器设置。
isContribution	boolean	一个值，该值指示布局节点是否参与。
label	string	字段的标签。
metadata	string	控件的内部文本。
order	integer (int32)	控件应在其组中显示的顺序。
overridden	boolean	一个值，该值指示是否已重写此布局节点。按子布局。
readOnly	boolean	一个值，指示控件是否是只读的。
visible	boolean	一个值，指示控件是否应隐藏。
watermark	string	文本框的水印文本。

Extension

Object

表示布局的扩展部分

名称	类型	说明
id	string	扩展的 ID

FormLayout

Object

描述工作项类型的布局

名称	类型	说明
extensions	Extension[]	获取和设置扩展列表。
pages	Page[]	布局的顶级选项卡。
systemControls	Control[]	布局的标题控件。

Group

Object

表示窗体中保存控件的组。

名称	类型	说明
contribution	WitContribution	组的贡献。
controls	Control[]	要放入组中的控件。
height	integer (int32)	贡献的高度。
id	string	布局节点的 ID。
inherited	boolean	一个值，该值指示此布局节点是否继承自父布局。这应仅由合并器设置。
isContribution	boolean	一个值，该值指示布局节点是否参与。
label	string	组的标签。
order	integer (int32)	组应在节中显示的顺序。
overridden	boolean	一个值，该值指示此布局节点是否已由子布局重写。
visible	boolean	一个值，该值指示组是否应隐藏。

Page

Object

描述工作项窗体布局中的页面

名称	类型	说明
contribution	WitContribution	页面的贡献。
id	string	布局节点的 ID。
inherited	boolean	一个值，该值指示此布局节点是否继承自父布局。这应仅由合并器设置。
isContribution	boolean	一个值，该值指示布局节点是否参与。
label	string	页面的标签。
locked	boolean	一个值，该值指示是否允许在此页面上执行任何用户作以及此页面的内容
order	integer (int32)	页面应在布局中显示的顺序。
overridden	boolean	一个值，该值指示此布局节点是否已由子布局重写。
pageType	PageType	页面的图标。
sections	Section[]	页面的各个部分。
visible	boolean	一个值，该值指示是否应隐藏页面。

PageType

枚举

页面的图标。

值	说明
attachments	附件页类型。
custom	自定义页面类型。
history	历史记录页类型。
links	链接页类型。

Section

Object

定义工作项窗体布局的一部分

名称	类型	说明
groups	Group[]	本节中的子组列表
id	string	布局节点的 ID。
overridden	boolean	一个值，该值指示此布局节点是否已由子布局重写。

WitContribution

Object

工作项表单贡献的属性

名称	类型	说明
contributionId	string	贡献的 ID。
height	integer (int32)	贡献的高度。
inputs	object	保存供稿输入的键值对的字典。
showOnDeletedWorkItem	boolean	一个值，该值指示是否应在已删除的工作项上显示贡献。

通过

Layout - Get

URI 参数

响应

安全性

oauth2

作用域

示例

Get the form layout

示例请求

示例响应

定义

Control

Extension

FormLayout

Group

Page

PageType

Section

WitContribution

其他资源