Fields - Create

リファレンス

Service:: Work Item Tracking

API Version:: 6.0

新しいフィールドを作成します。

POST https://dev.azure.com/{organization}/{project}/_apis/wit/fields?api-version=6.0

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
project	path		string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。このバージョンの API を使うには、'6.0' に設定する必要があります。

要求本文

名前	型	説明
_links	ReferenceLinks	関連する REST リソースへの参照をリンクします。
canSortBy	boolean	サーバークエリでフィールドを並べ替え可能にするかどうかを示します。
description	string	フィールドの説明。
isDeleted	boolean	このフィールドが削除されるかどうかを示します。
isIdentity	boolean	このフィールドが ID フィールドかどうかを示します。
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	フィールドの使用法。

応答

名前	型	説明
200 OK	WorkItemField	成功した操作

セキュリティ

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	作業項目とクエリの読み取り、作成、更新、ボードメタデータの更新、読み取り領域とイテレーションパス、関連するメタデータの追跡、クエリの実行、サービスフックを介した作業項目イベントに関する通知の受信を行う機能を付与します。

例

Create a new field

Sample Request

HTTP

POST https://dev.azure.com/{organization}/_apis/wit/fields?api-version=6.0

{
  "name": "New Work Item Field",
  "referenceName": "SupportedOperations.GreaterThanEquals",
  "description": null,
  "type": "string",
  "usage": "workItem",
  "readOnly": false,
  "canSortBy": true,
  "isQueryable": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    }
  ],
  "isIdentity": true,
  "isPicklist": false,
  "isPicklistSuggested": false,
  "url": null
}

Sample Response

Status code:: 200

{
  "name": "New Work Item Field",
  "referenceName": "SupportedOperations.GreaterThanEquals",
  "description": null,
  "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": "https://dev.azure.com/fabricam3/_apis/wit/fields/SupportedOperations.GreaterThanEquals"
}

定義

名前	説明
FieldType	フィールドの型。
FieldUsage	フィールドの使用法。
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
WorkItemField	作業項目のフィールドと、その作業項目の種類に固有のプロパティについて説明します。
WorkItemFieldOperation	作業項目フィールド操作について説明します。

FieldType

フィールドの型。

名前	型	説明
boolean	string	ブール型のフィールド型。
dateTime	string	Datetime フィールドの種類。
double	string	Double フィールド型。
guid	string	Guid フィールドの種類。
history	string	履歴フィールドの種類。
html	string	HTML (複数行) フィールド型。
identity	string	ID フィールドの種類。
integer	string	整数フィールド型。
picklistDouble	string	二重選択リストフィールドの種類。 REST API から二重選択リストフィールドを作成する場合は、"Double" FieldType を使用します。
picklistInteger	string	整数の picklist フィールド型。 REST API から整数の picklist フィールドを作成する場合は、"Integer" FieldType を使用します。
picklistString	string	文字列選択リストフィールドの種類。 REST API から文字列 picklist フィールドを作成する場合は、"String" FieldType を使用します。
plainText	string	プレーンテキストフィールド型。
string	string	文字列フィールド型。
treePath	string	Treepath フィールドの種類。

FieldUsage

フィールドの使用法。

名前	型	説明
none	string	空の使用法。
tree	string	ツリーノードフィールドの使用法。
workItem	string	作業項目フィールドの使用法。
workItemLink	string	作業項目リンクフィールドの使用法。
workItemTypeExtension	string	作業項目の種類拡張機能の使用方法。

ReferenceLinks

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

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

WorkItemField

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

名前	型	説明
_links	ReferenceLinks	関連する REST リソースへの参照をリンクします。
canSortBy	boolean	サーバークエリでフィールドを並べ替え可能にするかどうかを示します。
description	string	フィールドの説明。
isDeleted	boolean	このフィールドが削除されるかどうかを示します。
isIdentity	boolean	このフィールドが ID フィールドかどうかを示します。
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

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

名前	型	説明
name	string	操作のフレンドリ名。
referenceName	string	操作の参照名。

次の方法で共有