Fields - Get

リファレンス

Service:: Work Item Tracking

API Version:: 7.1-preview.3

特定のフィールドに関する情報を取得します。

GET https://dev.azure.com/{organization}/{project}/_apis/wit/fields/{fieldNameOrRefName}?api-version=7.1-preview.3

URI パラメーター

名前	/	必須	型	説明
fieldNameOrRefName	path	True	string	フィールドの単純な名前または参照名
organization	path	True	string	Azure DevOps 組織の名前です。
project	path		string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '7.1-preview.3' に設定する必要があります。

応答

名前	型	説明
200 OK	WorkItemField2	成功した操作

セキュリティ

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token 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

Scopes

名前	説明
vso.work	作業項目、クエリ、ボード、領域とイテレーションのパス、およびその他の作業項目追跡関連のメタデータを読み取る機能を付与します。また、クエリを実行したり、作業項目を検索したり、サービスフックを介して作業項目イベントに関する通知を受信したりすることもできます。

例

Gets information on a specific field

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/wit/fields/{fieldNameOrRefName}?api-version=7.1-preview.3

Sample Response

Status code:: 200

{
  "name": "Iteration Path",
  "referenceName": "System.IterationPath",
  "type": "treePath",
  "readOnly": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Under",
      "name": "Under"
    },
    {
      "referenceName": "SupportedOperations.NotUnder",
      "name": "Not Under"
    },
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath"
}

定義

名前	説明
FieldType	フィールドの型。
FieldUsage	フィールドの使用法。
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
WorkItemField2	作業項目のフィールドと、その作業項目の種類に固有のプロパティについて説明します。
WorkItemFieldOperation	作業項目フィールド操作について説明します。

FieldType

フィールドの型。

名前	型	説明
boolean	string	ブール型のフィールド型。
dateTime	string	Datetime フィールドの種類。
double	string	Double フィールド型。
guid	string	Guid フィールドの種類。
history	string	履歴フィールドの種類。
html	string	HTML (複数行) フィールド型。
identity	string	ID フィールドの種類。
integer	string	整数フィールド型。
picklistDouble	string	二重選択リストフィールドの種類。 REST API から二重選択リストフィールドを作成する場合は、"Double" FieldType を使用します。
picklistInteger	string	整数の picklist フィールド型。 REST API から整数の picklist フィールドを作成する場合は、"Integer" FieldType を使用します。
picklistString	string	文字列選択リストフィールドの種類。 REST API から文字列 picklist フィールドを作成する場合は、"String" FieldType を使用します。
plainText	string	プレーンテキストフィールド型。
string	string	文字列フィールド型。
treePath	string	Treepath フィールドの種類。

FieldUsage

フィールドの使用法。

名前	型	説明
none	string	空の使用法。
tree	string	ツリーノードフィールドの使用法。
workItem	string	作業項目フィールドの使用法。
workItemLink	string	作業項目リンクフィールドの使用法。
workItemTypeExtension	string	作業項目の種類拡張機能の使用方法。

ReferenceLinks

REST 参照リンクのコレクションを表すクラス。

名前	型	説明
links	object	リンクの読み取り専用ビュー。参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。

WorkItemField2

作業項目のフィールドと、その作業項目の種類に固有のプロパティについて説明します。

名前	型	説明
_links	ReferenceLinks	関連する REST リソースへの参照をリンクします。
canSortBy	boolean	サーバークエリでフィールドを並べ替え可能にするかどうかを示します。
description	string	フィールドの説明。
isDeleted	boolean	このフィールドが削除されるかどうかを示します。
isIdentity	boolean	このフィールドが ID フィールドかどうかを示します。
isLocked	boolean	このフィールドが編集用にロック済みとしてマークされているかどうかを示します。
isPicklist	boolean	このインスタンスが picklist であるかどうかを示します。
isPicklistSuggested	boolean	このインスタンスが候補候補リストであるかどうかを示します。
isQueryable	boolean	サーバーでフィールドにクエリを実行できるかどうかを示します。
name	string	フィールドの名前。
picklistId	string	このフィールドが picklist の場合は、関連付けられた候補リストの識別子。それ以外の場合は null
readOnly	boolean	フィールドが [読み取り専用] かどうかを示します。
referenceName	string	フィールドの参照名。
supportedOperations	WorkItemFieldOperation[]	このフィールドでサポートされている操作。
type	FieldType	フィールドの型。
url	string
usage	FieldUsage	フィールドの使用法。

WorkItemFieldOperation

作業項目フィールド操作について説明します。

名前	型	説明
name	string	操作のフレンドリ名。
referenceName	string	操作の参照名。

次の方法で共有