次の方法で共有

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 のバージョン。 このバージョンの API を使用するには、これを '7.1' に設定する必要があります。

応答

名前 型 説明
200 OK

FormLayout

成功した操作

セキュリティ

oauth2

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン 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

要求のサンプル

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

削除された workItem にコントリビューションを表示するかどうかを示す値。