Layout - Get

参考

服务:: Work Item Tracking Process Definitions

API 版本:: 4.1-preview.1

获取窗体布局

GET https://dev.azure.com/{organization}/_apis/work/processdefinitions/{processId}/workItemTypes/{witRefName}/layout?api-version=4.1-preview.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
processId	path	True	string uuid	进程的 ID
witRefName	path	True	string	工作项类型的引用名称
api-version	query	True	string	要使用的 API 版本。这应设置为“4.1-preview.1”才能使用此版本的 API。

响应

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

安全性

accessToken

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

类型: basic

示例

Get the form layout

示例请求

HTTP

GET https://dev.azure.com/{organization}/_apis/work/processdefinitions/{processId}/workItemTypes/{witRefName}/layout?api-version=4.1-preview.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	控件的高度，对于 html 控件。
id	string	布局节点的 ID。
inherited	boolean	一个值，该值指示此布局节点是否已从父布局继承。这只能由合并器设置。
isContribution	boolean	一个值，该值指示布局节点是否为贡献节点。
label	string	字段标签
metadata	string	控件的内部文本。
order	integer
overridden	boolean	一个值，该值指示此布局节点是否已被子布局覆盖。
readOnly	boolean	一个值，该值指示控件是否为只读控件。
visible	boolean	一个值，该值指示控件是否应隐藏。
watermark	string	文本框的水印文本。

Extension

Object

表示布局的扩展部分

名称	类型	说明
id	string

FormLayout

Object

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

Group

Object

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

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

Page

Object

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

PageType

Enumeration

页面的图标。

值	说明
attachments
custom
history
links

Section

Object

在页面中一起存放组的布局节点

名称	类型	说明
groups	Group[]	表示窗体中保存控件的组。
id	string	布局节点的 ID。
overridden	boolean	一个值，该值指示此布局节点是否已被子布局覆盖。

WitContribution

Object

名称	类型	说明
contributionId	string	贡献的 ID。
height	integer	贡献的高度。
inputs	object	包含贡献输入的键值对的字典。
showOnDeletedWorkItem	boolean	一个值，该值指示是否应在已删除的 workItem 上显示贡献。

通过

Layout - Get

URI 参数

响应

安全性

accessToken

示例

Get the form layout

示例请求

示例响应

定义

Control

Extension

FormLayout

Group

Page

PageType

Section

WitContribution

其他资源