Fields - Create
建立新的欄位。
POST https://dev.azure.com/{organization}/{project}/_apis/wit/fields?api-version=5.0URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 組織的名稱。 |
|
project
|
path |
string |
專案識別碼或專案名稱 |
|
|
api-version
|
query | True |
string |
要使用的 API 版本。 這應該設定為 '5.0' 以使用此版本的 API。 |
要求本文
| 名稱 | 類型 | Description |
|---|---|---|
| _links |
連結相關 REST 資源的參考。 |
|
| canSortBy |
boolean |
指出欄位是否可在伺服器查詢中排序。 |
| description |
string |
欄位的描述。 |
| isIdentity |
boolean |
指出此欄位是否為識別欄位。 |
| isPicklist |
boolean |
指出這個實例是否為 picklist。 |
| isPicklistSuggested |
boolean |
指出這個實例是否為建議的挑選清單。 |
| isQueryable |
boolean |
指出是否可以在伺服器中查詢欄位。 |
| name |
string |
欄位的名稱。 |
| picklistId |
string |
如果此欄位是 picklist，則為相關聯的挑選清單識別碼，否則為 null |
| readOnly |
boolean |
指出欄位是否為 [唯讀]。 |
| referenceName |
string |
欄位的參考名稱。 |
| supportedOperations |
此欄位支援的作業。 |
|
| type |
欄位的型別。 |
|
| url |
string |
|
| usage |
欄位的使用方式。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
成功的作業 |
安全性
oauth2
類型:
oauth2
Flow:
accessCode
授權 URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
權杖 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
範圍
| 名稱 | Description |
|---|---|
| vso.work_write | 授與讀取、建立和更新工作專案和查詢、更新面板中繼資料、讀取區域和反復專案路徑的其他工作專案追蹤相關中繼資料、執行查詢，以及透過服務勾點接收工作專案事件通知的能力。 |
定義
| 名稱 | Description |
|---|---|
|
Field |
欄位的型別。 |
|
Field |
欄位的使用方式。 |
|
Reference |
表示 REST 參考連結集合的類別。 |
|
Work |
描述工作專案上的欄位，以及該工作專案類型特有的屬性。 |
|
Work |
描述工作專案欄位作業。 |
FieldType
欄位的型別。
| 值 | Description |
|---|---|
| boolean |
布林值欄位類型。 |
| dateTime |
Datetime 欄位類型。 |
| double |
雙精度浮點數欄位類型。 |
| guid |
Guid 欄位類型。 |
| history |
歷程記錄欄位類型。 |
| html |
HTML (多行) 欄位類型。 |
| identity |
身分識別欄位類型。 |
| integer |
整數位段類型。 |
| picklistDouble |
雙重挑選清單欄位類型。 |
| picklistInteger |
整數挑選清單欄位類型。 |
| picklistString |
字串挑選清單欄位類型。 |
| plainText |
純文字欄位類型。 |
| string |
字串欄位類型。 |
| treePath |
樹狀結構路徑欄位類型。 |
FieldUsage
欄位的使用方式。
| 值 | Description |
|---|---|
| none |
空的使用方式。 |
| tree |
樹狀節點欄位使用方式。 |
| workItem |
工作專案欄位使用方式。 |
| workItemLink |
工作專案連結欄位使用方式。 |
| workItemTypeExtension |
工作專案類型延伸模組使用方式。 |
ReferenceLinks
表示 REST 參考連結集合的類別。
| 名稱 | 類型 | Description |
|---|---|---|
| links |
object |
連結的唯讀檢視。 因為參考連結是唯讀的，所以我們只想要將它們公開為唯讀。 |
WorkItemField
描述工作專案上的欄位，以及該工作專案類型特有的屬性。
| 名稱 | 類型 | Description |
|---|---|---|
| _links |
連結相關 REST 資源的參考。 |
|
| canSortBy |
boolean |
指出欄位是否可在伺服器查詢中排序。 |
| description |
string |
欄位的描述。 |
| isIdentity |
boolean |
指出此欄位是否為識別欄位。 |
| isPicklist |
boolean |
指出這個實例是否為 picklist。 |
| isPicklistSuggested |
boolean |
指出這個實例是否為建議的挑選清單。 |
| isQueryable |
boolean |
指出是否可以在伺服器中查詢欄位。 |
| name |
string |
欄位的名稱。 |
| picklistId |
string |
如果此欄位是 picklist，則為相關聯的挑選清單識別碼，否則為 null |
| readOnly |
boolean |
指出欄位是否為 [唯讀]。 |
| referenceName |
string |
欄位的參考名稱。 |
| supportedOperations |
此欄位支援的作業。 |
|
| type |
欄位的型別。 |
|
| url |
string |
|
| usage |
欄位的使用方式。 |
WorkItemFieldOperation
描述工作專案欄位作業。
| 名稱 | 類型 | Description |
|---|---|---|
| name |
string |
作業名稱。 |
| referenceName |
string |
作業的參考名稱。 |