共用方式為


Fields - Update

更新欄位。

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

URI 參數

名稱 位於 必要 類型 Description
fieldNameOrRefName
path True

string

要更新之欄位的名稱/參考名稱

organization
path True

string

Azure DevOps 組織的名稱。

project
path

string

專案識別碼或專案名稱

api-version
query True

string

要使用的 API 版本。 這應該設定為 '7.1-preview.3',以使用此版本的 API。

要求本文

名稱 類型 Description
isDeleted

boolean

指出使用者是否要還原欄位。

isLocked

boolean

指出使用者是否要鎖定欄位。

回應

名稱 類型 Description
200 OK

WorkItemField2

成功作業

安全性

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_write 授與讀取、建立及更新工作專案和查詢、更新面板中繼資料、讀取區域和反復專案路徑的其他工作專案追蹤相關中繼資料、執行查詢,以及透過服務勾點接收工作專案事件通知的能力。

範例

Set field locked
Undelete a field

Set field locked

Sample Request

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

{
  "isLocked": true
}

Sample Response

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

Sample Request

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

{
  "isDeleted": false
}

Sample Response

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

string

布林欄位類型。

dateTime

string

日期時間欄位類型。

double

string

雙欄位類型。

guid

string

Guid 欄位類型。

history

string

記錄欄位類型。

html

string

HTML (多行) 欄位類型。

identity

string

身分識別欄位類型。

integer

string

整數位段類型。

picklistDouble

string

雙挑選清單欄位類型。 從 REST API 建立雙選清單欄位時,請使用 「Double」 FieldType。

picklistInteger

string

整數挑選清單欄位類型。 從 REST API 建立整數挑選清單欄位時,請使用 「Integer」 FieldType。

picklistString

string

字串挑選清單欄位類型。 從 REST API 建立字串挑選清單欄位時,請使用 「String」 FieldType。

plainText

string

純文字欄位類型。

string

string

字串欄位類型。

treePath

string

樹狀結構路徑欄位類型。

FieldUpdate

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

名稱 類型 Description
isDeleted

boolean

指出使用者是否要還原欄位。

isLocked

boolean

指出使用者是否要鎖定欄位。

FieldUsage

欄位的使用方式。

名稱 類型 Description
none

string

空的使用方式。

tree

string

樹狀節點欄位使用量。

workItem

string

工作專案欄位使用方式。

workItemLink

string

工作專案連結欄位使用方式。

workItemTypeExtension

string

工作專案類型延伸模組使用方式。

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

名稱 類型 Description
links

object

連結的唯讀檢視。 因為參考連結是唯讀的,所以我們只想要將它們公開為唯讀。

WorkItemField2

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

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

如果此欄位是 picklist,則為相關聯的挑選清單識別碼,否則為 null

readOnly

boolean

指出欄位是否為 [唯讀]。

referenceName

string

欄位的參考名稱。

supportedOperations

WorkItemFieldOperation[]

此欄位上支援的作業。

type

FieldType

欄位的型別。

url

string

usage

FieldUsage

欄位的使用方式。

WorkItemFieldOperation

描述工作專案欄位作業。

名稱 類型 Description
name

string

作業的易記名稱。

referenceName

string

作業的參考名稱。