Fields - Get

參考

Service:: Work Item Tracking

API Version:: 4.1

取得特定欄位的相關資訊。

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

URI 參數

名稱	位於	必要	類型	Description
collection	path	True	string	Team Foundation Server 集合的名稱。
fieldNameOrRefName	path	True	string	功能變數名稱簡單名稱或參考名稱
instance	path	True	string	TFS 伺服器名稱 ({server：port})
project	path		string	專案識別碼或專案名稱
api-version	query	True	string	要使用的 API 版本。這應該設定為 '4.1' 以使用此版本的 API。

回應

名稱	類型	Description
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

名稱	Description
vso.work	授與讀取工作專案、查詢、面板、區域和反復專案路徑，以及其他工作專案追蹤相關中繼資料的能力。也授與執行查詢的能力，以及透過服務勾點接收工作專案事件的相關通知。

範例

Sample Request

HTTP

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"
}

定義

名稱	Description
FieldType	欄位的型別。
FieldUsage	欄位的使用方式。
ReferenceLinks	表示 REST 參考連結集合的類別。
WorkItemField	描述工作專案上的欄位，以及該工作專案類型特有的屬性。
WorkItemFieldOperation	描述工作專案欄位作業。

FieldType

欄位的型別。

名稱	類型	Description
boolean	string	布林值欄位類型。
dateTime	string	Datetime 欄位類型。
double	string	雙精度浮點數欄位類型。
guid	string	Guid 欄位類型。
history	string	歷程記錄欄位類型。
html	string	HTML (多行) 欄位類型。
identity	string	身分識別欄位類型。
integer	string	整數位段類型。
picklistDouble	string	雙重挑選清單欄位類型。
picklistInteger	string	整數挑選清單欄位類型。
picklistString	string	字串挑選清單欄位類型。
plainText	string	純文字欄位類型。
string	string	字串欄位類型。
treePath	string	樹狀結構路徑欄位類型。

FieldUsage

欄位的使用方式。

名稱	類型	Description
none	string	空的使用方式。
tree	string	樹狀節點欄位使用方式。
workItem	string	工作專案欄位使用方式。
workItemLink	string	工作專案連結欄位使用方式。
workItemTypeExtension	string	工作專案類型延伸模組使用方式。

ReferenceLinks

表示 REST 參考連結集合的類別。

名稱	類型	Description
links	object	連結的唯讀檢視。因為參考連結是唯讀的，所以我們只想要將它們公開為唯讀。

WorkItemField

描述工作專案上的欄位，以及該工作專案類型特有的屬性。

名稱	類型	Description
_links	ReferenceLinks	連結相關 REST 資源的參考。
description	string	欄位的描述。
isIdentity	boolean	指出此欄位是否為識別欄位。
isPicklist	boolean	指出這個實例是否為 picklist。
isPicklistSuggested	boolean	指出這個實例是否為建議的挑選清單。
name	string	欄位的名稱。
readOnly	boolean	指出欄位是否為 [唯讀]。
referenceName	string	欄位的參考名稱。
supportedOperations	WorkItemFieldOperation[]	此欄位支援的作業。
type	FieldType	欄位的型別。
url	string
usage	FieldUsage	欄位的使用方式。

WorkItemFieldOperation

描述工作專案欄位作業。

名稱	類型	Description
name	string	作業名稱。
referenceName	string	作業的參考名稱。