Fields - Update

參考

服務:: Work Item Tracking

API 版本:: 7.1

更新欄位。

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

URI 參數

名稱	位於	必要	類型	Description
fieldNameOrRefName	path	True	string	要更新之欄位的名稱/參考名稱
organization	path	True	string	Azure DevOps 組織的名稱。
project	path		string	項目識別碼或項目名稱
api-version	query	True	string	要使用的 API 版本。這應該設定為『7.1』以使用此版本的 API。

要求本文

名稱	類型	Description
isDeleted	boolean	指出使用者是否要還原欄位。
isLocked	boolean	指出使用者是否想要鎖定欄位。

回應

名稱	類型	Description
200 OK	WorkItemField2	成功作業

安全性

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	授與讀取、建立和更新工作專案和查詢、更新面板元數據、讀取區域和反覆專案路徑的能力，其他工作專案追蹤相關元數據、執行查詢，以及透過服務攔截接收工作專案事件的通知。

範例

Set field locked

Undelete a field

Set field locked

範例要求

HTTP

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

{
  "isLocked": true
}

範例回覆

狀態碼:: 200

persistent-Auth: true
lfs-Authenticate: NTLM
wwW-Authenticate: Negotiate oRswGaADCgEAoxIEEAEAAAAMDzOy0XQtlQAAAAA=

{
  "name": "New Work Item Field3",
  "referenceName": "Custom.TestField",
  "description": "New work item field for testing",
  "type": "string",
  "usage": "workItem",
  "readOnly": false,
  "canSortBy": true,
  "isQueryable": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.GreaterThan",
      "name": ">"
    },
    {
      "referenceName": "SupportedOperations.LessThan",
      "name": "<"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEquals",
      "name": ">="
    },
    {
      "referenceName": "SupportedOperations.LessThanEquals",
      "name": "<="
    },
    {
      "referenceName": "SupportedOperations.Contains",
      "name": "Contains"
    },
    {
      "referenceName": "SupportedOperations.NotContains",
      "name": "Does Not Contain"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    },
    {
      "name": "Not In"
    },
    {
      "referenceName": "SupportedOperations.InGroup",
      "name": "In Group"
    },
    {
      "referenceName": "SupportedOperations.NotInGroup",
      "name": "Not In Group"
    },
    {
      "referenceName": "SupportedOperations.Ever",
      "name": "Was Ever"
    },
    {
      "referenceName": "SupportedOperations.EqualsField",
      "name": "= [Field]"
    },
    {
      "referenceName": "SupportedOperations.NotEqualsField",
      "name": "<> [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanField",
      "name": "> [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanField",
      "name": "< [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEqualsField",
      "name": ">= [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanEqualsField",
      "name": "<= [Field]"
    }
  ],
  "isIdentity": false,
  "isPicklist": false,
  "isLocked": true,
  "isPicklistSuggested": false,
  "url": "http://localhost/DefaultCollection/_apis/wit/fields/Custom.TestField"
}

Undelete a field

範例要求

HTTP

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

{
  "isDeleted": false
}

範例回覆

狀態碼:: 200

persistent-Auth: true
lfs-Authenticate: NTLM
wwW-Authenticate: Negotiate oRswGaADCgEAoxIEEAEAAAAMDzOy0XQtlQAAAAA=

{
  "name": "New Work Item Field3",
  "referenceName": "Custom.TestField",
  "description": "New work item field for testing",
  "type": "string",
  "usage": "workItem",
  "readOnly": false,
  "canSortBy": true,
  "isQueryable": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.GreaterThan",
      "name": ">"
    },
    {
      "referenceName": "SupportedOperations.LessThan",
      "name": "<"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEquals",
      "name": ">="
    },
    {
      "referenceName": "SupportedOperations.LessThanEquals",
      "name": "<="
    },
    {
      "referenceName": "SupportedOperations.Contains",
      "name": "Contains"
    },
    {
      "referenceName": "SupportedOperations.NotContains",
      "name": "Does Not Contain"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    },
    {
      "name": "Not In"
    },
    {
      "referenceName": "SupportedOperations.InGroup",
      "name": "In Group"
    },
    {
      "referenceName": "SupportedOperations.NotInGroup",
      "name": "Not In Group"
    },
    {
      "referenceName": "SupportedOperations.Ever",
      "name": "Was Ever"
    },
    {
      "referenceName": "SupportedOperations.EqualsField",
      "name": "= [Field]"
    },
    {
      "referenceName": "SupportedOperations.NotEqualsField",
      "name": "<> [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanField",
      "name": "> [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanField",
      "name": "< [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEqualsField",
      "name": ">= [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanEqualsField",
      "name": "<= [Field]"
    }
  ],
  "isIdentity": false,
  "isPicklist": false,
  "isPicklistSuggested": false,
  "url": "http://localhost/DefaultCollection/_apis/wit/fields/Custom.TestField"
}

定義

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

FieldType

列舉型別

欄位的類型。

值	Description
boolean	布爾欄位類型。
dateTime	Datetime 欄位類型。
double	雙欄位類型。
guid	Guid 欄位類型。
history	歷程記錄欄位類型。
html	HTML （多行）欄位類型。
identity	身分識別欄位類型。
integer	整數位段類型。
picklistDouble	雙選清單欄位類型。從 REST API 建立雙選清單欄位時，請使用「Double」 FieldType。
picklistInteger	整數選擇清單欄位類型。從 REST API 建立整數選擇清單欄位時，請使用「Integer」 FieldType。
picklistString	字串選擇清單欄位類型。從 REST API 建立字串選擇清單欄位時，請使用 “String” FieldType。
plainText	純文字欄位類型。
string	字串字位類型。
treePath	樹形路徑欄位類型。

FieldUpdate

Object

描述工作專案欄位的更新要求。

名稱	類型	Description
isDeleted	boolean	指出使用者是否要還原欄位。
isLocked	boolean	指出使用者是否想要鎖定欄位。

FieldUsage

列舉型別

欄位的使用方式。

值	Description
none	空白使用量。
tree	Treenode 欄位使用方式。
workItem	工作專案欄位使用方式。
workItemLink	工作項目連結欄位使用方式。
workItemTypeExtension	工作專案類型延伸模組使用方式。

ReferenceLinks

Object

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

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

WorkItemField2

Object

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

名稱	類型	Description
_links	ReferenceLinks	連結相關 REST 資源的參考。
canSortBy	boolean	指出欄位是否可在伺服器查詢中排序。
description	string	欄位的描述。
isDeleted	boolean	指出是否刪除此欄位。
isIdentity	boolean	指出此欄位是否為識別欄位。
isLocked	boolean	指出此欄位是否標示為鎖定以供編輯。
isPicklist	boolean	指出這個實例是否為picklist。
isPicklistSuggested	boolean	指出這個實例是否為建議的挑選清單。
isQueryable	boolean	指出是否可以在伺服器中查詢欄位。
name	string	功能變數名稱。
picklistId	string (uuid)	如果此欄位是picklist，則為相關聯的選擇清單標識碼，否則為 null
readOnly	boolean	指出欄位是否為 [只讀]。
referenceName	string	欄位的參考名稱。
supportedOperations	WorkItemFieldOperation[]	此欄位上支援的作業。
type	FieldType	欄位的類型。
url	string
usage	FieldUsage	欄位的使用方式。

WorkItemFieldOperation

Object

描述工作專案欄位作業。

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

共用方式為

Fields - Update

URI 參數

要求本文

回應

安全性

oauth2

範圍

範例

Set field locked

範例要求

範例回覆

Undelete a field

範例要求

範例回覆

定義

FieldType

FieldUpdate

FieldUsage

ReferenceLinks

WorkItemField2

WorkItemFieldOperation

其他資源