Layout - Get

Referenz

Dienst:: Work Item Tracking Process Definitions

API-Version:: 4.1-preview.1

Ruft das Formularlayout ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
processId	path	True	string uuid	Die ID des Prozesses
witRefName	path	True	string	Der Verweisname des Arbeitselementtyps.
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "4.1-preview.1" festgelegt werden, um diese Version der API zu verwenden.

Antworten

Name	Typ	Beschreibung
200 OK	FormLayout	Erfolgreicher Vorgang

Sicherheit

accessToken

Persönliches Zugriffstoken. Verwenden Sie einen beliebigen Wert für den Benutzernamen und das Token als Kennwort.

Typ: basic

Beispiele

Get the form layout

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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
    }
  ]
}

Definitionen

Name	Beschreibung
Control	Stellt ein Steuerelement im Formular dar.
Extension	Stellt den Erweiterungsteil des Layouts dar.
FormLayout
Group	Stellt eine Gruppe in der Form dar, die Steuerelemente enthält.
Page
PageType	Das Symbol für die Seite.
Section	Ein Layoutknoten, der Gruppen auf einer Seite zusammenhält
WitContribution

Control

Objekt

Stellt ein Steuerelement im Formular dar.

Name	Typ	Beschreibung
contribution	WitContribution	Beitrag für das Steuerelement.
controlType	string	Typ des Steuerelements.
height	integer	Höhe des Steuerelements für HTML-Steuerelemente.
id	string	Die ID für den Layoutknoten.
inherited	boolean	Ein Wert, der angibt, ob dieser Layoutknoten von einem übergeordneten Layout geerbt wurde. Es wird erwartet, dass dies nur vom Combiner festgelegt wird.
isContribution	boolean	Ein -Wert, der angibt, ob der Layoutknoten ein Beitrag ist oder nicht.
label	string	Bezeichnung für das Feld
metadata	string	Innerer Text des Steuerelements.
order	integer
overridden	boolean	Ein Wert, der angibt, ob dieser Layoutknoten von einem untergeordneten Layout überschrieben wurde.
readOnly	boolean	Ein -Wert, der angibt, ob das Steuerelement schreiblos ist.
visible	boolean	Ein Wert, der angibt, ob das Steuerelement ausgeblendet werden soll oder nicht.
watermark	string	Wasserzeichentext für das Textfeld.

Extension

Objekt

Stellt den Erweiterungsteil des Layouts dar.

Name	Typ	Beschreibung
id	string

FormLayout

Objekt

Name	Typ	Beschreibung
extensions	Extension[]	Ruft die Erweiterungsliste ab und legt sie fest.
pages	Page[]	Registerkarten der obersten Ebene des Layouts.
systemControls	Control[]	Headersteuerelemente des Layouts.

Group

Objekt

Stellt eine Gruppe in der Form dar, die Steuerelemente enthält.

Name	Typ	Beschreibung
contribution	WitContribution	Beitrag für die Gruppe.
controls	Control[]	Steuerelemente, die in der Gruppe platziert werden sollen.
height	integer	Die Höhe des Beitrags.
id	string	Die ID für den Layoutknoten.
inherited	boolean	Ein Wert, der angibt, ob dieser Layoutknoten von einem übergeordneten Layout geerbt wurde. Es wird erwartet, dass dies nur vom Combiner festgelegt wird.
isContribution	boolean	Ein Wert, der angibt, ob der Layoutknoten ein Beitrag ist, sind nicht.
label	string	Die Beschriftung für die Gruppe.
order	integer	Reihenfolge, in der die Gruppe im Abschnitt angezeigt werden soll.
overridden	boolean	Ein Wert, der angibt, ob dieser Layoutknoten von einem untergeordneten Layout überschrieben wurde.
visible	boolean	Ein -Wert, der angibt, ob die Gruppe ausgeblendet werden soll oder nicht.

Page

Objekt

Name	Typ	Beschreibung
contribution	WitContribution	Beitrag für die Seite.
id	string	Die ID für den Layoutknoten.
inherited	boolean	Ein Wert, der angibt, ob dieser Layoutknoten von einem übergeordneten Layout geerbt wurde. Es wird erwartet, dass dies nur vom Combiner festgelegt wird.
isContribution	boolean	Ein Wert, der angibt, ob der Layoutknoten ein Beitrag ist, sind nicht.
label	string	Die Bezeichnung für die Seite.
locked	boolean	Ein Wert, der angibt, ob Benutzervorgänge auf dieser Seite und dem Inhalt dieser Seite zulässig sind.
order	integer	Reihenfolge, in der die Seite im Layout angezeigt werden soll.
overridden	boolean	Ein Wert, der angibt, ob dieser Layoutknoten von einem untergeordneten Layout überschrieben wurde.
pageType	PageType	Das Symbol für die Seite.
sections	Section[]	Die Abschnitte der Seite.
visible	boolean	Ein Wert, der angibt, ob die Seite ausgeblendet werden soll oder nicht.

PageType

Enumeration

Das Symbol für die Seite.

Wert	Beschreibung
attachments
custom
history
links

Section

Objekt

Ein Layoutknoten, der Gruppen auf einer Seite zusammenhält

Name	Typ	Beschreibung
groups	Group[]	Stellt eine Gruppe in der Form dar, die Steuerelemente enthält.
id	string	Die ID für den Layoutknoten.
overridden	boolean	Ein Wert, der angibt, ob dieser Layoutknoten von einem untergeordneten Layout überschrieben wurde.

WitContribution

Objekt

Name	Typ	Beschreibung
contributionId	string	Die ID für den Beitrag.
height	integer	Die Höhe des Beitrags.
inputs	object	Ein Wörterbuch, das Schlüsselwertpaare für Beitragseingaben enthält.
showOnDeletedWorkItem	boolean	Ein -Wert, der angibt, ob der Beitrag für gelöschte workItem-Elemente angezeigt werden soll.

Freigeben über

Layout - Get

URI-Parameter

Antworten

Sicherheit

accessToken

Beispiele

Get the form layout

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Control

Extension

FormLayout

Group

Page

PageType

Section

WitContribution