Fields - Update

Başvuru

Service:: Work Item Tracking

API Version:: 7.1-preview.3

Alanı güncelleştirme.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
fieldNameOrRefName	path	True	string	Güncelleştirilecek alanın adı/başvuru adı
organization	path	True	string	Azure DevOps kuruluşunun adı.
project	path		string	Proje Kimliği veya proje adı
api-version	query	True	string	Kullanılacak API'nin sürümü. Bu, api'nin bu sürümünü kullanmak için '7.1-preview.3' olarak ayarlanmalıdır.

İstek Gövdesi

Name	Tür	Description
isDeleted	boolean	Kullanıcının alanı geri yüklemek isteyip istemediğini gösterir.
isLocked	boolean	Kullanıcının alanı kilitlemek isteyip istemediğini gösterir.

Yanıtlar

Name	Tür	Description
200 OK	WorkItemField2	başarılı işlem

Güvenlik

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

Name	Description
vso.work_write	İş öğelerini ve sorgularını okuma, oluşturma ve güncelleştirme, pano meta verilerini güncelleştirme, alan ve yineleme yollarını diğer iş öğesi izlemeyle ilgili meta verileri okuma, sorguları yürütme ve hizmet kancaları aracılığıyla iş öğesi olayları hakkında bildirim alma olanağı verir.

Örnekler

Set field locked

Undelete a field

Set field locked

Sample Request

HTTP

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

{
  "isLocked": true
}

Sample Response

Status code:: 200

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

Response Body

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

HTTP

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

{
  "isDeleted": false
}

Sample Response

Status code:: 200

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

Response Body

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

Tanımlar

Name	Description
FieldType	Alanın türü.
FieldUpdate	İş öğesi alanı için güncelleştirme isteğini açıklar.
FieldUsage	Alanın kullanımı.
ReferenceLinks	REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.
WorkItemField2	İş öğesindeki bir alanı ve bu iş öğesi türüne özgü özellikleri açıklar.
WorkItemFieldOperation	İş öğesi alanı işlemini açıklar.

FieldType

Alanın türü.

Name	Tür	Description
boolean	string	Boole alan türü.
dateTime	string	Tarih saat alan türü.
double	string	Çift alan türü.
guid	string	Guid alan türü.
history	string	Geçmiş alan türü.
html	string	HTML (Çok Satırlı) alan türü.
identity	string	Kimlik alanı türü.
integer	string	Tamsayı alan türü.
picklistDouble	string	Çift seçim listesi alan türü. REST API'den çift seçim listesi alanı oluştururken "Double" FieldType kullanın.
picklistInteger	string	Tamsayı seçim listesi alan türü. REST API'den bir tamsayı seçim listesi alanı oluştururken "Integer" FieldType kullanın.
picklistString	string	Dize seçim listesi alan türü. REST API'den bir dize seçim listesi alanı oluştururken "String" FieldType kullanın.
plainText	string	Düz metin alanı türü.
string	string	Dize alanı türü.
treePath	string	Ağaç yolu alan türü.

FieldUpdate

İş öğesi alanı için güncelleştirme isteğini açıklar.

Name	Tür	Description
isDeleted	boolean	Kullanıcının alanı geri yüklemek isteyip istemediğini gösterir.
isLocked	boolean	Kullanıcının alanı kilitlemek isteyip istemediğini gösterir.

FieldUsage

Alanın kullanımı.

Name	Tür	Description
none	string	Boş kullanım.
tree	string	Ağaç düğümü alanı kullanımı.
workItem	string	İş öğesi alanı kullanımı.
workItemLink	string	İş öğesi bağlantı alanı kullanımı.
workItemTypeExtension	string	İş Öğesi Türü Uzantısı kullanımı.

ReferenceLinks

REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.

Name	Tür	Description
links	object	Bağlantıların salt okunur görünümü. Başvuru bağlantıları salt okunur olduğundan, bunları yalnızca salt okunur olarak kullanıma açmak istiyoruz.

WorkItemField2

İş öğesindeki bir alanı ve bu iş öğesi türüne özgü özellikleri açıklar.

Name	Tür	Description
_links	ReferenceLinks	İlgili REST kaynaklarına bağlantı başvuruları.
canSortBy	boolean	Alanın sunucu sorgularında sıralanabilir olup olmadığını gösterir.
description	string	Alanın açıklaması.
isDeleted	boolean	Bu alanın silinip silinmediğini gösterir.
isIdentity	boolean	Bu alanın bir kimlik alanı olup olmadığını gösterir.
isLocked	boolean	Bu alanın düzenleme için kilitli olarak işaretlenip işaretlenmediğini gösterir.
isPicklist	boolean	Bu örneğin seçim listesi olup olmadığını gösterir.
isPicklistSuggested	boolean	Bu örneğin önerilen bir seçim listesi olup olmadığını gösterir.
isQueryable	boolean	Alanın sunucuda sorgulanıp sorgulanamayacağını gösterir.
name	string	Alanın adı.
picklistId	string	Bu alan seçim listesiyse, ilişkili seçim listesinin tanımlayıcısı, aksi takdirde null
readOnly	boolean	Alanın [salt okunur] olup olmadığını gösterir.
referenceName	string	Alanın başvuru adı.
supportedOperations	WorkItemFieldOperation[]	Bu alanda desteklenen işlemler.
type	FieldType	Alanın türü.
url	string
usage	FieldUsage	Alanın kullanımı.

WorkItemFieldOperation

İş öğesi alanı işlemini açıklar.

Name	Tür	Description
name	string	İşlemin kolay adı.
referenceName	string	İşlemin başvuru adı.

Fields - Update

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

oauth2

Scopes

Örnekler

Set field locked

Sample Request

Sample Response

Undelete a field

Sample Request

Sample Response

Tanımlar

FieldType

FieldUpdate

FieldUsage

ReferenceLinks

WorkItemField2

WorkItemFieldOperation

Geri Bildirim

Ek kaynaklar