Fields - Get

サービス:

Work Item Tracking

API バージョン:

7.1

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

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

URI パラメーター

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

応答

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

セキュリティ

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

例

Gets information on a specific field

要求のサンプル

HTTP

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

応答のサンプル

状態コード:

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	ブール型のフィールド型。
dateTime	Datetime フィールド型。
double	Double フィールド型。
guid	Guid フィールドの種類。
history	履歴フィールドの種類。
html	HTML (複数行) フィールド型。
identity	ID フィールドの種類。
integer	整数フィールド型。
picklistDouble	[二重選択リスト] フィールドの種類。 REST API から二重候補リスト フィールドを作成する場合は、"Double" FieldType を使用します。
picklistInteger	整数の候補リスト フィールドの種類。 REST API から整数候補リスト フィールドを作成する場合は、"Integer" FieldType を使用します。
picklistString	文字列候補リスト フィールドの種類。 REST API から文字列候補リスト フィールドを作成する場合は、"String" FieldType を使用します。
plainText	プレーン テキスト フィールドの種類。
string	文字列フィールド型。
treePath	ツリーパス フィールドの種類。

FieldUsage

列挙

フィールドの使用法。

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

ReferenceLinks

Object

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

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

WorkItemField2

Object

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

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

WorkItemFieldOperation

Object

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

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