Fields - Get

  • リファレンス
Service:
Work Item Tracking
API Version:
4.1

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

GET https://{instance}/{collection}/{project}/_apis/wit/fields/{fieldNameOrRefName}?api-version=4.1

URI パラメーター

名前 / 必須 型 説明
collection
 path True

string

Team Foundation Server コレクションの名前。
fieldNameOrRefName
 path True

string

フィールドの単純名または参照名
instance
 path True

string

TFS サーバー名 ({server:port})
project
 path

string

プロジェクト ID またはプロジェクト名
api-version
 query True

string

使う API のバージョン。 このバージョンの API を使用するには、これを '4.1' に設定する必要があります。

応答

名前 型 説明
200 OK

WorkItemField

正常な操作

セキュリティ

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

例

Sample Request

GET https://{instance}/{collection}/_apis/wit/fields/{fieldNameOrRefName}?api-version=4.1

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://fabrikam:8080/tfs/_apis/wit/fields/System.IterationPath"
}

定義

名前 説明
FieldType

フィールドの型。
FieldUsage

フィールドの使用法。
ReferenceLinks

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

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

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

FieldType

フィールドの型。

名前 型 説明
boolean

string

ブール型のフィールド型。
dateTime

string

Datetime フィールド型。
double

string

二重フィールド型。
guid

string

Guid フィールドの種類。
history

string

履歴フィールドの種類。
html

string

HTML (複数行) フィールド型。
identity

string

ID フィールドの種類。
integer

string

整数フィールド型。
picklistDouble

string

二重選択リストフィールドの種類。
picklistInteger

string

整数の選択リスト フィールドの種類。
picklistString

string

文字列選択リスト フィールドの種類。
plainText

string

プレーン テキスト フィールドの種類。
string

string

文字列フィールドの種類。
treePath

string

Treepath フィールドの種類。

FieldUsage

フィールドの使用法。

名前 型 説明
none

string

空の使用法。
tree

string

Treenode フィールドの使用法。
workItem

string

作業項目フィールドの使用法。
workItemLink

string

作業項目リンク フィールドの使用法。
workItemTypeExtension

string

作業項目の種類の拡張機能の使用法。

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

名前 型 説明
links

object

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

WorkItemField

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

名前 型 説明
_links

ReferenceLinks

関連する REST リソースへの参照をリンクします。
description

string

フィールドの説明。
isIdentity

boolean

このフィールドが ID フィールドであるかどうかを示します。
isPicklist

boolean

このインスタンスが選択リストであるかどうかを示します。
isPicklistSuggested

boolean

このインスタンスが候補候補リスト であるかどうかを示します。
name

string

フィールドの名前。
readOnly

boolean

フィールドが [読み取り専用] かどうかを示します。
referenceName

string

フィールドの参照名。
supportedOperations

WorkItemFieldOperation[]

このフィールドでサポートされている操作。
type

FieldType

フィールドの型。
url

string

usage

FieldUsage

フィールドの使用法。

WorkItemFieldOperation

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

名前 型 説明
name

string

操作の名前。
referenceName

string

操作の参照名。