Fields - Update

フィールドを更新します。

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

URI パラメーター

名前 / 必須 説明
fieldNameOrRefName
path True

string

更新するフィールドの名前/参照名

organization
path True

string

Azure DevOps 組織の名前です。

project
path

string

プロジェクト ID またはプロジェクト名

api-version
query True

string

使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.3' に設定する必要があります。

要求本文

名前 説明
isDeleted

boolean

ユーザーがフィールドを復元するかどうかを示します。

isLocked

boolean

ユーザーがフィールドをロックするかどうかを示します。

応答

名前 説明
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

名前 説明
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"
}

定義

名前 説明
FieldType

フィールドの型。

FieldUpdate

作業項目フィールドの更新要求について説明します。

FieldUsage

フィールドの使用法。

ReferenceLinks

REST 参照リンクのコレクションを表す クラス。

WorkItemField2

作業項目のフィールドとその作業項目の種類に固有のプロパティについて説明します。

WorkItemFieldOperation

作業項目フィールド操作について説明します。

FieldType

フィールドの型。

名前 説明
boolean

string

ブール型のフィールド型。

dateTime

string

Datetime フィールド型。

double

string

二重フィールド型。

guid

string

Guid フィールドの種類。

history

string

履歴フィールドの種類。

html

string

HTML (複数行) フィールド型。

identity

string

ID フィールドの種類。

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

Treepath フィールドの種類。

FieldUpdate

作業項目フィールドの更新要求について説明します。

名前 説明
isDeleted

boolean

ユーザーがフィールドを復元するかどうかを示します。

isLocked

boolean

ユーザーがフィールドをロックするかどうかを示します。

FieldUsage

フィールドの使用法。

名前 説明
none

string

空の使用法。

tree

string

Treenode フィールドの使用法。

workItem

string

作業項目フィールドの使用法。

workItemLink

string

作業項目リンク フィールドの使用法。

workItemTypeExtension

string

作業項目の種類の拡張機能の使用法。

REST 参照リンクのコレクションを表す クラス。

名前 説明
links

object

リンクの読み取り時ビュー。 参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。

WorkItemField2

作業項目のフィールドとその作業項目の種類に固有のプロパティについて説明します。

名前 説明
_links

ReferenceLinks

関連する REST リソースへの参照をリンクします。

canSortBy

boolean

サーバー クエリでフィールドを並べ替え可能にするかどうかを示します。

description

string

フィールドの説明。

isDeleted

boolean

このフィールドが削除されるかどうかを示します。

isIdentity

boolean

このフィールドが ID フィールドであるかどうかを示します。

isLocked

boolean

このフィールドが編集用にロック済みとしてマークされているかどうかを示します。

isPicklist

boolean

このインスタンスが選択リストであるかどうかを示します。

isPicklistSuggested

boolean

このインスタンスが候補候補リスト であるかどうかを示します。

isQueryable

boolean

フィールドをサーバーで照会できるかどうかを示します。

name

string

フィールドの名前。

picklistId

string

このフィールドが候補リストの場合は、選択リストの識別子が関連付けられます。それ以外の場合は null

readOnly

boolean

フィールドが [読み取り専用] かどうかを示します。

referenceName

string

フィールドの参照名。

supportedOperations

WorkItemFieldOperation[]

このフィールドでサポートされている操作。

type

FieldType

フィールドの型。

url

string

usage

FieldUsage

フィールドの使用法。

WorkItemFieldOperation

作業項目フィールド操作について説明します。

名前 説明
name

string

操作のフレンドリ名。

referenceName

string

操作の参照名。