フィールド REST API リファレンス

[アーティクル]
07/18/2016

SharePoint REST API におけるフィールド関連のリソースおよびエンドポイントについて説明します。

適用対象: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

この記事の内容
この記事の要求の例について
Field リソース
FieldCalculated リソース
FieldCollection リソース
FieldComputed リソース
FieldDateTime リソース
FieldGeolocation リソース
FieldGuid リソース
FieldLookup および FieldUser リソース
FieldMultiChoice、FieldChoice、および FieldRatingScale リソース
FieldMultiLineText リソース
FieldNumber および FieldCurrency リソース
FieldText リソース
FieldUrl リソース
実装メモ
その他の技術情報

この記事の要求の例について

この記事に出てくる例では jQuery AJAX 要求が使用されています。これらの例を使用する前に、次の操作を実行してください。

<サイト url>、および ID、名前、SharePoint エンティティのパスなどその他プレースホルダーのデータを変更します。

クロスドメインライブラリを使用する場合は、要求形式を変更する必要があります。たとえば、次のようになります。

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/fields?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Comments', 'FieldTypeKind': 3 }",
  headers: {
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

OAuth を使用する場合は、Authorization ヘッダー ("Authorization": "Bearer " + <access token>) を追加して OAuth アクセストークンを送信します。
要求の例の url および data プロパティ値から改行を削除します。改行は、例を分かりやすくするために追加されています。
サーバーに Atom 形式で応答を返させる場合は、"accept": "application/json; odata=verbose" ヘッダーを削除します。

要求を変更する方法についての詳細は、「環境によって異なる REST 要求の方法」を参照してください。クロスドメインライブラリ、OAuth、および SharePoint サービスの使用法についての詳細は、「その他の技術情報」を参照してください。

ヒント

SharePoint Online REST サービスは、OData $batch クエリオプションを使用して複数の要求を、サービスに対する 1 つの呼び出しに結合できます。詳細とコードサンプルへのリンクについては、「REST API によりバッチ要求を発行する」をご覧ください。このオプションは、オンプレミスの SharePoint ではサポートされていません。

Field リソース

エンドポイント URI | プロパティ | メソッド | OData 表現

SharePoint リスト内のフィールドを表します。

エンドポイント URI

http://<サイト url>/_api/web/fields('<フィールド id>')
http://<サイト url>/_api/web/lists(guid'<リスト id>')/fields('<フィールド id>')

サポートされる HTTP メソッド

GET | POST | DELETE | MERGE | PUT

要求の例

GET 要求の例: フィールドを取得します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

または、GetByTitle メソッドを FieldCollection リソースから使用して、その (大文字小文字の区別あり) タイトル別にフィールドを取得できます。例: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date')。

POST 要求の例: フィールドを作成します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Comments', 'FieldTypeKind': 3 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json; odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

POST 要求の例: フィールドスキーマを含むフィールドを作成します。複雑なスキーマを送信する場合は、CreateFieldAsXml メソッドを使用できます。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: { '__metadata': { 'type': 'SP.Field' }, 'FieldTypeKind': 20, 'Title':
    'Stakeholders', 'SchemaXml': '<Field Type=\"UserMulti\" Required=\"TRUE\"
    UserSelectionMode=\"PeopleAndGroups\" UserSelectionScope=\"0\" Mult=\"TRUE\" />' },
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json; odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

フィールドを作成する他の方法についての詳細は、「FieldCollection メソッド」を参照してください。

MERGE 要求の例: フィールドを変更します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Internal stakeholders' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

MERGE 要求または PUT 要求でフィールドの種類を指定する方法についての詳細は、「実装メモ」を参照してください。

DELETE 要求の例: フィールドを削除します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Field プロパティ

プロパティを取得するには、以下の例に示されているように、GET 要求をプロパティエンドポイントに送信します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

プロパティ	型	R/W	リソースとともに返される	説明
CanBeDeleted	Boolean	R	はい	フィールドを削除できるかどうかを示す値を取得します。
DefaultValue	String	RW	はい	フィールドの既定値を指定する値を取得または設定します。
Description	String	RW	はい	フィールドの説明を指定する値を取得または設定します。
Direction	String	RW	はい	フィールドの読み取り方向を指定する値を取得または設定します。
EnforceUniqueValues	Boolean	RW	はい	リストまたはライブラリ列内の一意なフィールド値が必要かどうかを指定する値を取得または設定します。
EntityPropertyName	String	R	はい	このフィールドを使用するリストアイテムエンティティのエンティティプロパティの名前を取得します。
FieldTypeKind	Int32	RW	はい	フィールドの種類を指定する値を取得または設定します。FieldType 値を表します。フィールド型の値のリストの詳細は, .NET クライアントオブジェクトモデルリファレンスの「FieldType」を参照してください。
Filterable	Boolean	R	はい	リスト内のリストアイテムをフィールド値でフィルターできるかどうかを示す値を取得します。
FromBaseType	Boolean	R	はい	フィールドが基本フィールド型から派生しているかどうかを示す Boolean 値を取得します。
Group	String	RW	はい	フィールドグループを指定する値を取得または設定します。
Hidden	Boolean	RW	はい	フィールドがリストビューおよびリストフォームで非表示かどうかを指定する値を取得または設定します。
Id	GUID	R	はい	フィールド識別子を示す値を取得します。
Indexed	Boolean	RW	はい	フィールドにインデックスを付けるかどうかを指定するブール値を取得または設定します。
InternalName	String	R	はい	フィールドの内部名を示す値を取得します。
JSLink	String	RW	はい	この種類のフィールドに対する任意のクライアントレンダリングロジックが含まれている外部 JS ファイルの名前を取得または設定します。
ReadOnlyField	Boolean	RW	はい	フィールドの値が読み取り専用かどうかを指定する値を取得または設定します。
Required	Boolean	RW	はい	フィールドで値が必須かどうかを指定する値を取得または設定します。
SchemaXml	String	RW	はい	フィールドを定義する XML スキーマを指定する値を取得または設定します。
SchemaXmlWithResourceTokens	String	R	いいえ	フィールドを定義してリソーストークンを含めるスキーマを取得します。
Scope	String	RW	はい	フィールドが属しているリストまたはサイトのサーバー相対 URL を示す値を取得します。
Sealed	Boolean	RW	はい	フィールドのプロパティの変更および削除ができなくなっているかどうかを示す値を取得します。
Sortable	Boolean	RW	はい	リスト内のリストアイテムをフィールド値によって並べ替えることができるかどうかを示す値を取得します。
StaticName	String	RW	はい	フィールドのカスタマイズ可能な識別子を指定する値を取得または設定します。
Title	String	RW	はい	フィールドの表示名を指定する値を取得または設定します。
TypeAsString	String	RW	はい	フィールドの種類を指定する値を取得または設定します。
TypeDisplayName	String	R	はい	フィールドの種類の表示名を示す値を取得します。
TypeShortDescription	String	R	はい	フィールドの種類の説明を示す値を取得します。
ValidationFormula	String	RW	はい	フィールドの値のデータ検証基準を指定する値を取得または設定します。
ValidationMessage	String	RW	はい	フィールドでデータ検証が失敗した場合に返されるエラーメッセージを指定する値を取得または設定します。

Field メソッド

DeleteObject
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

DeleteObject メソッド

フィールドを削除する場合に推奨される方法は、「Field 要求の例」に示されているように、DELETE 要求を Field リソースエンドポイントに送信することです。

SetShowInDisplayForm メソッド

このフィールドの ShowInDisplayForm プロパティの値を設定します。

エンドポイント	/setshowindisplayform(<boolean>)
パラメーター	型: Boolean true (フォーム内でフィールドを表示する場合。それ以外は false)。
HTTP method	POST
応答	なし

要求の例

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')
    /setshowindisplayform(false)",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

SetShowInEditForm メソッド

このフィールドの ShowInEditForm プロパティの値を設定します。

エンドポイント	/setshowineditform(<boolean>)
パラメーター	型: Boolean true (フォーム内でフィールドを表示する場合。それ以外は false)。
HTTP method	POST
応答	なし

要求の例

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')
    /setshowineditform(false)",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

SetShowInNewForm メソッド

このフィールドの ShowInNewForm プロパティの値を設定します。

エンドポイント	/setshowinnewform(<boolean>)
パラメーター	型: Boolean true (フォーム内でフィールドを表示する場合。それ以外は false)。
HTTP method	POST
応答	なし

要求の例

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')
    /setshowinnewform(false)",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

OData 表現

以下の例では、Field リソースを JSON 形式で表しています。

    {"d":{
      "__metadata":{,
        "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'fa564e0f-0c70-4ab9-b863-0177e6ddd247')",
        "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'fa564e0f-0c70-4ab9-b863-0177e6ddd247')",
        "type":"SP.FieldText"
      },
      "CanBeDeleted":false,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Title",
      "Filterable":true,
      "FromBaseType":true,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"fa564e0f-0c70-4ab9-b863-0177e6ddd247",
      "Indexed":false,
      "InternalName":"Title",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":true,
      "SchemaXml":"<Field ID=\"{fa564e0f-0c70-4ab9-b863-0177e6ddd247}\" Type=\"Text\" Name=\"Title\" DisplayName=\"Task Name\" Required=\"TRUE\" SourceID=\"https://schemas.microsoft.com/sharepoint/v3\" StaticName=\"Title\" FromBaseType=\"TRUE\" Sealed=\"TRUE\" ColName=\"nvarchar1\" />",
      "Scope":"/Lists/Backlog items",
      "Sealed":true,
      "Sortable":true,
      "StaticName":"Title",
      "Title":"Task Name",
      "FieldTypeKind":2,
      "TypeAsString":"Text",
      "TypeDisplayName":"Single line of text",
      "TypeShortDescription":"Single line of text",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "MaxLength":255
    }}

FieldCalculated リソース

エンドポイント URI | プロパティ | メソッド | OData 表現

集計フィールドを指定します。SP.Field から継承します。フィールド型の値 = 17。

エンドポイント URI

http://<サイト url>_api/web/fields('<フィールド id>')
http://<サイト url>/_api/web/lists(guid'<リスト id>')/fields('<フィールド id>')

サポートされる HTTP メソッド

GET | POST | DELETE | MERGE | PUT

要求の例

GET 要求の例: 集計フィールドを取得します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

または、GetByInternalNameOrTitle または GetByTitle メソッドを FieldCollection リソースから使用して、その (大文字小文字を区別する) 内部名またはタイトル別にフィールドを取得できます。例: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date')。

POST 要求の例: 集計フィールドを作成します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldCalculated' }, 'FieldTypeKind': 17, 'Title':
    'Days Remaining', 'Formula': '=DATEDIF([Start Date],[End Date],"d")', 'OutputType': 9 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

フィールドを作成する他の方法についての詳細は、「FieldCollection メソッド」を参照してください。サポートされる数式の例については、「集計フィールドの数式」を参照してください。

MERGE 要求の例: 集計フィールドを変更します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldCalculated' }, 'Title': 'Remaining', 'Formula':
    '=DATEDIF([Start Date],[End Date],"d")&" days"', 'OutputType': 2 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

MERGE 要求または PUT 要求のフィールド型を指定する方法についての詳細は、「実装メモ」を参照してください。

DELETE 要求の例: 集計フィールドを削除します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldCalculated プロパティ

プロパティを取得するには、以下の例に示されているように、GET 要求をプロパティエンドポイントに送信します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

プロパティ	型	R/W	リソースとともに返される	説明
SP.Field から継承されるプロパティについての詳細は、「Field プロパティ」を参照してください。
DateFormat	Int32	RW	はい	フィールドに表示される日付と時刻の形式を取得または設定します。DateTimeFieldFormatType 値を表します。DateOnly = 0、DateTime = 1。
数式	String	RW	はい	フィールドの数式を指定する値を取得または設定します。
OutputType	Int32	RW	はい	フィールドの出力形式を指定する値を取得または設定します。FieldType 値を表します。フィールド型の値のリストの詳細は, .NET クライアントオブジェクトモデルリファレンスの「FieldType」を参照してください。

FieldCalculated メソッド

メソッドは SP.Field から継承されます。

DeleteObject (または、DELETE 要求をフィールドエンドポイントに送信する)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表現

次の例は、JSON 形式での SP.FieldCalculated リソースを表しています。

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'ddb702c8-e343-479b-9fda-b71af9175031')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'ddb702c8-e343-479b-9fda-b71af9175031')",
        "type":"SP.FieldCalculated"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Remaining",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"ddb702c8-e343-479b-9fda-b71af9175031",
      "Indexed":false,
      "InternalName":"Remaining",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":true,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Remaining\" Type=\"Calculated\" Required=\"FALSE\" ResultType=\"Number\" ID=\"{ddb702c8-e343-479b-9fda-b71af9175031}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Remaining\" Name=\"Remaining\" ColName=\"sql_variant6\" RowOrdinal=\"0\" ReadOnly=\"TRUE\" Version=\"1\"><Formula>=DATEDIF(Start_x0020_Date,End_x0020_Date,\"d\")</Formula><FieldRefs><FieldRef Name=\"End_x0020_Date\" /><FieldRef Name=\"Start_x0020_Date\" /></FieldRefs></Field>",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Remaining",
      "Title":"Remaining",
      "FieldTypeKind":17,
      "TypeAsString":"Calculated",
      "TypeDisplayName":"Calculated",
      "TypeShortDescription":"Calculated (calculation based on other columns)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "DateFormat":0,
      "Formula":"=DATEDIF([Start Date],[End Date],\"d\")",
      "OutputType":9
    }}

FieldCollection リソース

エンドポイント URI | プロパティ | メソッド | OData 表現

Field リソースのコレクションを表します。

エンドポイント URI

http://<サイト url>/_api/web/fields
http://<サイト url>/_api/web/lists(guid'<リスト id>')/fields

サポートされる HTTP メソッド

GET | POST

要求の例

GET 要求の例: リスト内のすべてのフィールドを取得します。

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GET 要求の例: 特定のフィールドを取得します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('fa564e0f-0c70-4ab9-b863-0177e6ddd247')",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

または、GetByTitle または GetByInternalNameOrTitle メソッドを FieldCollection リソースから使用して、その (大文字小文字を区別する) 内部名またはタイトル別にフィールドを取得できます。例: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Assigned To')。

POST 要求の例: フィールドを作成します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Comments', 'FieldTypeKind': 3 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json; odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

POST 要求の例: フィールドスキーマを含むフィールドを作成します。複雑なスキーマを送信する場合は、CreateFieldAsXml メソッドを使用できます。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: { '__metadata': { 'type': 'SP.Field' }, 'FieldTypeKind': 20, 'Title':
    'Stakeholders', 'SchemaXml': '<Field Type="UserMulti" Required="TRUE"
    UserSelectionMode="PeopleAndGroups" UserSelectionScope="0" Mult="TRUE" />' },
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json; odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

フィールドを作成する他の方法についての詳細は、「FieldCollection メソッド」を参照してください。フィールドを変更または削除する方法の例については、「Field 要求の例」を参照してください。

FieldCollection プロパティ

プロパティを取得するには、以下の例に示されているように、GET 要求をプロパティエンドポイントに送信します。

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/schemaxml",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

プロパティ	型	R/W	リソースとともに返される	説明
SchemaXml	String	R	いいえ	フィールドのコレクションの XML スキーマを指定します。

FieldCollection メソッド

AddDependentLookupField
AddField
CreateFieldAsXml
GetById
GetByInternalNameOrTitle
GetByTitle

AddDependentLookupField メソッド

リレーションシップに関してプライマリルックアップフィールドに依存しているセカンダリルックアップフィールドを、その情報の取得場所であるリストに追加します。

エンドポイント	/adddependentlookupfield(displayname、primarylookupfieldid、showfield)
パラメーター	displayname 型: String 新規フィールドのタイトル。 primarylookupfieldid 型: String この依存ルックアップフィールドと関連付けるルックアップフィールドの ID。 showfield 型: String データを含めるターゲットリストのフィールドの名前。
HTTP method	POST
応答	型: SP.File 新しいフィールド。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /adddependentlookupfield(displayname='Project', primarylookupfieldid='c3a92d97-2b77-4a25-9698-3ab54874bc6f', showfield='Title')",
  type: "POST",
  headers: {
    "X-RequestDigest": <form digest value>>,
    "accept": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

AddField メソッド

フィールドコレクションにフィールドを追加します。

エンドポイント	/addfield
パラメーター	parameters 型: SP.FieldCreationInformation 新しいフィールドを定義するプロパティ。
HTTP method	POST
応答	型: SP.File 新しいフィールド。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /addfield",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.FieldCreationInformation' }, 'Title':
    'Impact', 'FieldTypeKind': 6, 'Required': true, 'Choices': { '__metadata': { 'type':
    'Collection(Edm.String)' }, 'results': [ 'High', 'Medium', 'Low' ] } } }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json; odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

または、「FieldCollection 要求の例」に示されているように、POST 要求を FieldCollection リソースエンドポイントに送信することによってフィールドを追加できます。

CreateFieldAsXml メソッド

指定されたスキーマ、Boolean 値、およびフィールドオプションに基づいてフィールドを作成します。

エンドポイント	/createfieldasxml
パラメーター	parameters 型: SP.XmlSchemaFieldCreationInformation 新しいフィールドのプロパティ。例に示されているように、要求本文でこのパラメーターを送信します。
HTTP method	POST
応答	型: SP.File 新しいフィールド。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /createfieldasxml",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.XmlSchemaFieldCreationInformation' },
    'SchemaXml': '<Field Type="UserMulti" Title="Stakeholders" DisplayName="Stakeholders"
    Required="FALSE" UserSelectionMode="PeopleAndGroups" UserSelectionScope="0" Mult="TRUE" />' } }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json; odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

GetById メソッド

指定された ID を持つフィールドを取得します。

エンドポイント	/getbyid('<field id>')
パラメーター	型: String フィールドの ID。
HTTP method	GET
応答	型: SP.Field 指定されたフィールド。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /getbyid('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

または、単にフィールド ID を FieldCollection リソースに渡すことができます。例: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')。

GetByInternalNameOrTitle メソッド

指定された内部名またはタイトルを持つ最初の Field オブジェクトをコレクションから取得します。

エンドポイント	/getbyinternalnameortitle('<フィールドの内部名またはタイトル>')
パラメーター	型: String 大文字/小文字を区別した、フィールドの内部名およびタイトル。
HTTP method	GET
応答	型: SP.Field 指定されたフィールド。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /getbyinternalnameortitle('AssignedTo')",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetByTitle メソッド

指定されたフィールドのタイトルに基づいてコレクション内の最初のフィールドオブジェクト返します。

エンドポイント	/getbytitle('<フィールドのタイトル>')
パラメーター	型: String 大文字/小文字を区別した、フィールドのタイトル。
HTTP method	GET
応答	型: SP.Field 指定されたフィールド。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /getbytitle('Start Date')",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

OData 表現

次の例は、JSON 形式での FieldCollection リソースを表しています。

    {"d":{
      "results":[{
        "__metadata":{
          "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'03e45e84-1992-4d42-9116-26f756012634')",
          "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'03e45e84-1992-4d42-9116-26f756012634')",
          "type":"SP.Field"
        },
        "CanBeDeleted":false,
        "DefaultValue":null,
        "Description":"",
        "Direction":"none",
        "EnforceUniqueValues":false,
        "EntityPropertyName":"ContentTypeId",
        "Filterable":true,
        "FromBaseType":true,
        "Group":"Custom Columns",
        "Hidden":true,
        "Id":"03e45e84-1992-4d42-9116-26f756012634",
        "Indexed":false,
        "InternalName":"ContentTypeId",
        "JSLink":null,
        "ReadOnlyField":true,
        "Required":false,
        "SchemaXml":"<Field ID="{03e45e84-1992-4d42-9116-26f756012634}" RowOrdinal="0" Type="ContentTypeId" Sealed="TRUE" ReadOnly="TRUE" Hidden="TRUE" DisplayName="Content Type ID" Name="ContentTypeId" DisplaceOnUpgrade="TRUE" SourceID="https://schemas.microsoft.com/sharepoint/v3" StaticName="ContentTypeId" ColName="tp_ContentTypeId" FromBaseType="TRUE" />",
        "Scope":"/Lists/Backlog items",
        "Sealed":true,
        "Sortable":true,
        "StaticName":"ContentTypeId",
        "Title":"Content Type ID",
        "FieldTypeKind":25,
        "TypeAsString":"ContentTypeId",
        "TypeDisplayName":"Content Type Id",
        "TypeShortDescription":"Content Type Id",
        "ValidationFormula":null,
        "ValidationMessage":null
        },{
        "__metadata":{
          "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'fa564e0f-0c70-4ab9-b863-0177e6ddd247')",
          "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'fa564e0f-0c70-4ab9-b863-0177e6ddd247')",
          "type":"SP.FieldText"
        },
        "CanBeDeleted":false,
        "DefaultValue":null,
        "Description":"",
        "Direction":"none",
        "EnforceUniqueValues":false,
        "EntityPropertyName":"Title",
        "Filterable":true,
        "FromBaseType":true,
        "Group":"Custom Columns",
        "Hidden":false,
        "Id":"fa564e0f-0c70-4ab9-b863-0177e6ddd247",
        "Indexed":false,
        "InternalName":"Title",
        "JSLink":"clienttemplates.js",
        "ReadOnlyField":false,
        "Required":true,
        "SchemaXml":"<Field ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}" Type="Text" Name="Title" DisplayName="Task Name" Required="TRUE" SourceID="https://schemas.microsoft.com/sharepoint/v3" StaticName="Title" FromBaseType="TRUE" Sealed="TRUE" ColName="nvarchar1" />",
        "Scope":"/Lists/Backlog items",
        "Sealed":true,
        "Sortable":true,
        "StaticName":"Title",
        "Title":"Task Name",
        "FieldTypeKind":2,
        "TypeAsString":"Text",
        "TypeDisplayName":"Single line of text",
        "TypeShortDescription":"Single line of text",
        "ValidationFormula":null,
        "ValidationMessage":null,
        "MaxLength":255
        },{
        ...
      }]
    }}

FieldComputed リソース

エンドポイント URI | プロパティ | メソッド | OData 表現

内容が他のフィールドに依存するフィールドを表しますが、カスタムレンダリングのパターンを指定できます。SP.Field から継承します。フィールド型の値 = 12。

エンドポイント URI

http://<サイト url>_api/web/fields('<フィールド id>')
http://<サイト url>/_api/web/lists(guid'<リスト id>')/fields('<フィールド id>')

サポートされる HTTP メソッド

GET | POST | DELETE | MERGE | PUT

要求の例

GET 要求の例: 計算フィールドを取得します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST 要求の例:CreateFieldAsXml メソッドを使用して計算フィールドを作成します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields/createfieldasxml",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.XmlSchemaFieldCreationInformation' },
    'SchemaXml': '<Field Type=\"Computed\" DisplayName=\"Search\">
    <FieldRefs><FieldRef Name="Title" /></FieldRefs></Field>' } }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  }
  success: successHandler,
  error: errorHandler
});

計算フィールドを作成してスキーマ XML を指定した後に、XSL レンダリングファイルを作成する必要があります。「XSLT リストビューレンダリングシステムの概要」を参照してください。

MERGE 要求の例: 計算フィールドを変更します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldComputed' }, 'SchemaXml': '<Field Type=\"Computed\" DisplayName=\"Search\">
    <FieldRefs><FieldRef Name="ID" /><FieldRef Name="Title" /></FieldRefs></Field>' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

MERGE 要求または PUT 要求のフィールド型を指定する方法についての詳細は、「実装メモ」を参照してください。

DELETE 要求の例: 計算フィールドを削除します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldComputed プロパティ

プロパティを取得するには、以下の例に示されているように、GET 要求をプロパティエンドポイントに送信します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

プロパティ	型	R/W	リソースとともに返される	説明
SP.Field から継承されるプロパティについての詳細は、「Field プロパティ」を参照してください。
EnableLookup	Boolean	RW	はい	ルックアップフィールドがこのフィールドを参照できるかどうかを指定する値を取得または設定します。

FieldComputed メソッド

メソッドは SP.Field から継承されます。

DeleteObject (または、DELETE 要求をフィールドエンドポイントに送信する)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表現

次の例は、JSON 形式での SP.FieldComputed リソースを表しています。

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'dceca14e-c897-4988-ae4f-f7c21bea80e5')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'dceca14e-c897-4988-ae4f-f7c21bea80e5')",
        "type":"SP.FieldComputed"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Search",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"dceca14e-c897-4988-ae4f-f7c21bea80e5",
      "Indexed":false,
      "InternalName":"Search",
      "JSLink":null,
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field Type=\"Computed\" DisplayName=\"Search\" ID=\"{dceca14e-c897-4988-ae4f-f7c21bea80e5}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Search\" Name=\"Search\"><FieldRefs><FieldRef Name=\"Title\" /></FieldRefs></Field>",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Search",
      "Title":"Search",
      "FieldTypeKind":12,
      "TypeAsString":"Computed",
      "TypeDisplayName":"Computed",
      "TypeShortDescription":"Computed",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "EnableLookup":false
    }}

FieldDateTime リソース

エンドポイント URI | プロパティ | メソッド | OData 表現

日付と時刻の値を含むフィールドを指定します。SP.Field から継承します。フィールド型の値 = 4。

エンドポイント URI

http://<サイト url>_api/web/fields('<フィールド id>')
http://<サイト url>/_api/web/lists(guid'<リスト id>')/fields('<フィールド id>')

サポートされる HTTP メソッド

GET | POST | DELETE | MERGE | PUT

要求の例

GET 要求の例: 日時フィールドを取得します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST 要求の例: 日時フィールドを作成します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldDateTime' }, 'FieldTypeKind': 4,
    'Title': 'Handoff Date', 'DisplayFormat': 1 }";
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

フィールドを作成する他の方法についての詳細は、「FieldCollection メソッド」を参照してください。

MERGE 要求の例: 日時フィールドを変更します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldDateTime' }, 'FriendlyDisplayFormat': 2 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

MERGE 要求または PUT 要求のフィールド型を指定する方法についての詳細は、「実装メモ」を参照してください。

DELETE 要求の例: 日時フィールドを削除します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldDateTime プロパティ

プロパティを取得するには、以下の例に示されているように、GET 要求をプロパティエンドポイントに送信します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

プロパティ	型	R/W	リソースとともに返される	説明
SP.Field から継承されるプロパティについての詳細は、「Field プロパティ」を参照してください。
DateTimeCalendarType	Int32	RW	はい	フィールドのカレンダーの種類を指定する値を取得または設定します。CalendarType 値を表します。グレゴリオ暦 (ローカライズ済み) = 1、和暦 = 3、台湾暦 = 4、檀君暦 = 5、ヒジュラ暦 (アラビア暦) = 6、タイ仏歴 = 7、ヘブライ太陰暦 = 8、グレゴリオ暦 (中東フランス語) = 9、グレゴリオ暦 (アラビア語) = 10、グレゴリオ暦 (英語音訳) = 11、グレゴリオ暦 (フランス語音訳) = 12、韓国および日本の太陰暦 = 14、中国の太陰暦 = 15、サカ歴 = 16。
DisplayFormat	Int32	RW	はい	フィールドに表示される日付と時刻の形式を取得または設定します。DateTimeFieldFormatType 値を表します。DateOnly = 0、DateTime = 1。
FriendlyDisplayFormat	Int32	RW	はい	DateTimeFieldFriendlyFormat 値を表します。指定なし = 0、無効 (標準的な絶対値) = 1、相対 (標準的なフレンドリ相対値) = 2。

FieldDateTime メソッド

メソッドは SP.Field から継承されます。

DeleteObject (または、DELETE 要求をフィールドエンドポイントに送信する)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表現

次の例は、JSON 形式での SP.FieldDateTime リソースを表しています。

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'd6b835d3-820f-4926-85bd-7711cc31c4c8')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'd6b835d3-820f-4926-85bd-7711cc31c4c8')",
        "type":"SP.FieldDateTime"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Handoff_x0020_Date",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"d6b835d3-820f-4926-85bd-7711cc31c4c8",
      "Indexed":false,
      "InternalName":"Handoff_x0020_Date",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Handoff Date\" Type=\"DateTime\" Required=\"FALSE\" ID=\"{d6b835d3-820f-4926-85bd-7711cc31c4c8}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Handoff_x0020_Date\" Name=\"Handoff_x0020_Date\" ColName=\"datetime3\" RowOrdinal=\"0\" Format=\"DateTime\" FriendlyDisplayFormat=\"Unspecified\" Version=\"9\" />",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Handoff_x0020_Date",
      "Title":"Handoff Date",
      "FieldTypeKind":4,
      "TypeAsString":"DateTime",
      "TypeDisplayName":"Date and Time",
      "TypeShortDescription":"Date and Time",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "DateTimeCalendarType":0,
      "DisplayFormat":1,
      "FriendlyDisplayFormat":0
    }}

FieldGeolocation リソース

エンドポイント URI | プロパティ | メソッド | OData 表現

地理的な位置の値を含むフィールドを表します。SP.Field から継承します。フィールド型の値 = 31。

位置フィールドの使用方法についての詳細は、「SharePoint 2013 でロケーションとマップ機能を組み込む」を参照してください。

エンドポイント URI

http://<サイト url>_api/web/fields('<フィールド id>')
http://<サイト url>/_api/web/lists(guid'<リスト id>')/fields('<フィールド id>')

サポートされる HTTP メソッド

GET | POST | DELETE | MERGE | PUT

要求の例

GET 要求の例: 位置フィールドを取得します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST 要求の例: 位置フィールドを作成します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Field' }, 'FieldTypeKind': 31, 'Title': 'Location' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

フィールドを作成する他の方法についての詳細は、「FieldCollection メソッド」を参照してください。

MERGE 要求の例: 位置フィールドを変更します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'City' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

MERGE 要求または PUT 要求のフィールド型を指定する方法についての詳細は、「実装メモ」を参照してください。

DELETE 要求の例: 位置フィールドを削除します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldGeolocation プロパティ

プロパティを取得するには、以下の例に示されているように、GET 要求をプロパティエンドポイントに送信します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

プロパティ	型	R/W	リソースとともに返される	説明
SP.Field から継承されるプロパティについての詳細は、「Field プロパティ」を参照してください。

FieldGeolocation メソッド

メソッドは SP.Field から継承されます。

DeleteObject (または、DELETE 要求をフィールドエンドポイントに送信する)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表現

次の例は、JSON 形式での SP.FieldGeolocation リソースを表しています。

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'aec4b49c-573e-42a5-8844-cb1a9e1a720e')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'aec4b49c-573e-42a5-8844-cb1a9e1a720e')",
        "type":"SP.FieldGeolocation"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Location",
      "Filterable":false,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"aec4b49c-573e-42a5-8844-cb1a9e1a720e",
      "Indexed":false,
      "InternalName":"Location",
      "JSLink":"Geolocationfieldtemplate.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Location\" Type=\"Geolocation\" Required=\"FALSE\" ID=\"{aec4b49c-573e-42a5-8844-cb1a9e1a720e}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Location\" Name=\"Location\" ColName=\"geography1\" RowOrdinal=\"0\" Version=\"3\" />",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":false,
      "StaticName":"Location",
      "Title":"Location",
      "FieldTypeKind":31,
      "TypeAsString":"Geolocation",
      "TypeDisplayName":"Geolocation",
      "TypeShortDescription":"Geographic location that represents a point on a map",
      "ValidationFormula":null,
      "ValidationMessage":null
    }}

FieldGuid リソース

エンドポイント URI | プロパティ | メソッド | OData 表現

SP.Field から継承します。フィールド型の値 = 14。

エンドポイント URI

http://<サイト url>_api/web/fields('<フィールド id>')
http://<サイト url>/_api/web/lists(guid'<リスト id>')/fields('<フィールド id>')

サポートされる HTTP メソッド

GET | POST | DELETE | MERGE | PUT

要求の例

GET 要求の例: GUID フィールドを取得します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST 要求の例: GUID フィールドを作成します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldGuid' }, 'FieldTypeKind': 14,
    'Title': 'Project ID' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

フィールドを作成する他の方法についての詳細は、「FieldCollection メソッド」を参照してください。

MERGE 要求の例: GUID フィールドを変更します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldGuid' }, 'Title': 'Project GUID', 'EnforceUniqueValues': true }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

MERGE 要求または PUT 要求のフィールド型を指定する方法についての詳細は、「実装メモ」を参照してください。

DELETE 要求の例: GUID フィールドを削除します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldGuid プロパティ

プロパティを取得するには、以下の例に示されているように、GET 要求をプロパティエンドポイントに送信します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

プロパティ	型	R/W	リソースとともに返される	説明
SP.Field から継承されるプロパティについての詳細は、「Field プロパティ」を参照してください。

FieldGuid メソッド

メソッドは SP.Field から継承されます。

DeleteObject (または、DELETE 要求をフィールドエンドポイントに送信する)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表現

次の例は、JSON 形式での SP.FieldGuid リソースを表しています。

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'53f865f8-675b-47d2-b4d6-1c8803eb6295')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'53f865f8-675b-47d2-b4d6-1c8803eb6295')",
        "type":"SP.FieldGuid"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Project_x0020_ID",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"53f865f8-675b-47d2-b4d6-1c8803eb6295",
      "Indexed":false,
      "InternalName":"Project_x0020_ID",
      "JSLink":null,
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Project ID\" Type=\"Guid\" Required=\"FALSE\" ID=\"{53f865f8-675b-47d2-b4d6-1c8803eb6295}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Project_x0020_ID\" Name=\"Project_x0020_ID\" ColName=\"uniqueidentifier1\" RowOrdinal=\"0\" Version=\"1\" />",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Project_x0020_ID",
      "Title":"Project ID",
      "FieldTypeKind":14,
      "TypeAsString":"Guid",
      "TypeDisplayName":"Guid",
      "TypeShortDescription":"Guid",
      "ValidationFormula":null,
      "ValidationMessage":null
    }}

FieldLookup および FieldUser リソース

エンドポイント URI | プロパティ | メソッド | OData 表現

リソース	説明	フィールドの型の値
FieldLookup	ルックアップフィールドを指定します。SP.Field から継承します。	7
FieldUser	ユーザーを含むフィールドを指定します。SP.FieldLookup から継承します。	20

エンドポイント URI

http://<サイト url>_api/web/fields('<フィールド id>')
http://<サイト url>/_api/web/lists(guid'<リスト id>')/fields('<フィールド id>')

サポートされる HTTP メソッド

GET | POST | DELETE | MERGE | PUT

要求の例

GET 要求の例: 参照フィールドまたはユーザーフィールドを取得します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST 要求の例: 参照フィールドを作成します。参照フィールドを作成するには AddField メソッドを使用します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields/addfield",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.FieldCreationInformation' }, 'FieldTypeKind': 7,
    'Title': 'Project Rollup', 'LookupListId': '4635daeb-7206-4513-ad17-ea06e09187ad',
    'LookupFieldName': 'Title' } }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

POST 要求の例: ユーザーフィールドを作成します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldUser' }, 'FieldTypeKind': 20,
    'Title': 'Owner', 'SelectionGroup': 7, 'SelectionMode': 0 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

フィールドを作成する他の方法についての詳細は、「FieldCollection メソッド」を参照してください。

MERGE 要求の例: 参照フィールドを変更します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldLookup' }, 'AllowMultipleValues': true }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

MERGE 要求または PUT 要求のフィールド型を指定する方法についての詳細は、「実装メモ」を参照してください。

DELETE 要求の例: 参照フィールドまたはユーザーフィールドを削除します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldLookup および FieldUser プロパティ

プロパティを取得するには、以下の例に示されているように、GET 要求をプロパティエンドポイントに送信します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

プロパティ	型	R/W	リソースとともに返される	説明
SP.Field から継承されるプロパティについては、「Field プロパティ」を参照してください。 * は、プロパティが FieldLookup から継承されないことを示します。
AllowDisplay *	Boolean	RW	はい	アンケートリストにユーザーの名前を表示するかどうかを指定する値を取得または設定します。 *FieldUser にのみ適用されます。
AllowMultipleValues	Boolean	RW	はい	ルックアップフィールドで複数の値を使用できるかどうかを指定する値を取得または設定します。複数の値が許可されている参照フィールドでは、削除制約を設定できません。
IsRelationship	Boolean	RW	はい	このルックアップフィールドが SP.List.getRelatedFields によってルックアップ先のリストから返されるかどうかを指定する値を取得または設定します。フィールドが複数列の参照のセカンダリ列を表す場合、常に false を返します。セカンダリ列は、ソースリストからは探索できません。このプロパティについての詳細は, .NET クライアントオブジェクトモデルリファレンスの IsRelationship を参照してください。
LookupField	String	RW	はい	ルックアップ値として使用されるフィールドの内部フィールド名を指定する値を取得または設定します。
LookupList	String	RW	はい	ルックアップ値として使用するフィールドが含まれているリストのリスト識別子を指定する値を取得または設定します。
LookupWebId	GUID	RW	はい	このフィールドの値のソースであるリストを含む Web サイトの ID を取得または設定します。
Presence*	Boolean	RW	はい	プレゼンスがフィールドで有効かどうかを指定する値を取得または設定します。 *FieldUser にのみ適用されます。
PrimaryFieldId	String	RW	はい	依存ルックアップフィールドの場合は、プライマリルックアップフィールドの識別子を指定する値を取得または設定します。それ以外の場合、値は空の文字列です。
RelationshipDeleteBehavior	Int32	RW	はい	ルックアップフィールドの削除動作を指定する値を取得または設定します。RelationshipDeleteBehaviorType 値を表します。なし = 0、カスケード = 1、制限 = 2。このプロパティについての詳細は, .NET クライアントオブジェクトモデルリファレンスの RelationshipDeleteBehavior を参照してください。
SelectionGroup *	Int32	RW	はい	メンバーをフィールドの値として選択できる SharePoint グループの識別子を指定する値を取得または設定します。 *FieldUser にのみ適用されます。
SelectionMode *	Int32	RW	はい	ユーザーとグループを選択できるのか、それともユーザーのみを選択できるのかを指定する値を取得または設定します。FieldUserSelectionMode 値を表します。PeopleOnly = 0、PeopleAndGroups = 1。 *FieldUser にのみ適用されます。

FieldLookup および FieldUser メソッド

メソッドは SP.Field から継承されます。

DeleteObject (または、DELETE 要求をフィールドエンドポイントに送信する)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表現

次の例は、JSON 形式での SP.FieldLookup リソースを表しています。

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'2ee42785-f5b4-4af3-9011-96a9dea67d23')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'2ee42785-f5b4-4af3-9011-96a9dea67d23')",
        "type":"SP.FieldLookup"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Project_x0020_Rollup",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"2ee42785-f5b4-4af3-9011-96a9dea67d23",
      "Indexed":false,
      "InternalName":"Project_x0020_Rollup",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Project Rollup\" Type=\"Lookup\" Required=\"FALSE\" List=\"{4635DAEB-7206-4513-AD17-EA06E09187AD}\" ID=\"{2ee42785-f5b4-4af3-9011-96a9dea67d23}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Project_x0020_Rollup\" Name=\"Project_x0020_Rollup\" ColName=\"int1\" RowOrdinal=\"0\" ShowField=\"Title\" Version=\"1\" />",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Project_x0020_Rollup",
      "Title":"Project Rollup",
      "FieldTypeKind":7,
      "TypeAsString":"Lookup",
      "TypeDisplayName":"Lookup",
      "TypeShortDescription":"Lookup (information already on this site)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "AllowMultipleValues":false,
      "IsRelationship":true,
      "LookupField":"Title",
      "LookupList":"{4635DAEB-7206-4513-AD17-EA06E09187AD}",
      "LookupWebId":"0d787dd7-3d5b-481f-93a3-085687dbb644",
      "PrimaryFieldId":null,
      "RelationshipDeleteBehavior":0
    }}

次の例は、JSON 形式での SP.FieldUser リソースを表しています。

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'7feaefbb-c501-4539-8973-839da0d2e6f6')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'7feaefbb-c501-4539-8973-839da0d2e6f6')",
        "type":"SP.FieldUser"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Owner",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"7feaefbb-c501-4539-8973-839da0d2e6f6",
      "Indexed":false,
      "InternalName":"Owner",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Owner\" Type=\"User\" Required=\"FALSE\" List=\"UserInfo\" ID=\"{7feaefbb-c501-4539-8973-839da0d2e6f6}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Owner\" Name=\"Owner\" ColName=\"int2\" RowOrdinal=\"0\" UserSelectionScope=\"7\" UserSelectionMode=\"PeopleOnly\" Version=\"1\" />",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Owner",
      "Title":"Owner",
      "FieldTypeKind":20,
      "TypeAsString":"User",
      "TypeDisplayName":"Person or Group",
      "TypeShortDescription":"Person or Group",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "AllowMultipleValues":false,
      "IsRelationship":false,
      "LookupField":"",
      "LookupList":"{a63367c0-83e8-48eb-9b88-d2c0d2db001c}",
      "LookupWebId":"0d787dd7-3d5b-481f-93a3-085687dbb644",
      "PrimaryFieldId":null,
      "RelationshipDeleteBehavior":0,
      "AllowDisplay":true,
      "Presence":true,
      "SelectionGroup":7,
      "SelectionMode":0
    }

FieldMultiChoice、FieldChoice、および FieldRatingScale リソース

エンドポイント URI | プロパティ | メソッド | OData 表現

リソース	説明	フィールドの型の値
FieldMultiChoice	指定された値の集合のうち 1 つ以上の値を含むフィールドを指定します。SP.Field から継承します。	15
FieldChoice	選択肢フィールドコントロールを表します。SP.FieldMultiChoice から継承します。	6
FieldRatingScale	アンケートリストに対する段階評価の値を含むフィールドを指定します。SP.FieldMultiChoice から継承します。GridChoice とも呼ばれます。	16

エンドポイント URI

http://<サイト url>_api/web/fields('<フィールド id>')
http://<サイト url>/_api/web/lists(guid'<リスト id>')/fields('<フィールド id>')

サポートされる HTTP メソッド

GET | POST | DELETE | MERGE | PUT

要求の例

GET 要求の例: フィールドを取得します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST 要求の例: 複数選択フィールドを作成します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldMultiChoice' }, 'FieldTypeKind': 15,
    'Title': 'Features', 'Choices': { '__metadata': { 'type': 'Collection(Edm.String)' },
    'results': [ 'ECM', 'Workflow', 'Collaboration' ] }, 'FillInChoice': true, 'DefaultValue': 'ECM' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

POST 要求の例: 選択フィールドを作成します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldChoice' }, 'FieldTypeKind': 6,
    'Title': 'Scope', 'Choices': { '__metadata': { 'type': 'Collection(Edm.String)' },
    'results': [ 'Internal', 'External' ] }, 'EditFormat': 1 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

POST 要求の例: 段階評価フィールドを作成します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldRatingScale' }, 'FieldTypeKind': 16,
    'Title': 'How frequently do you use these features?', 'Choices':  { '__metadata':
    { 'type': 'Collection(Edm.String)' }, 'results': [ 'ECM', 'Workflow', 'Collaboration' ] },
    'GridTextRangeLow': 'Rarely', 'GridTextRangeAverage': 'Sometimes', 'GridTextRangeHigh': 'Often',
    'GridStartNumber': 1, 'GridEndNumber': 3, 'RangeCount': 3 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

フィールドを作成する他の方法についての詳細は、「FieldCollection メソッド」を参照してください。

MERGE 要求の例: 選択フィールドを変更します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'43c6d385-122f-4b77-a7cd-538ede2a047f')
    /fields('509e9ac8-7ee6-4452-aaf9-1d2c42909187')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldChoice' }, 'DefaultValue': 'External', 'EditFormat': 0 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

MERGE 要求または PUT 要求のフィールド型を指定する方法についての詳細は、「実装メモ」を参照してください。

DELETE 要求の例: フィールドを削除します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldMultiChoice、FieldChoice、および FieldRatingScale プロパティ

プロパティを取得するには、以下の例に示されているように、GET 要求をプロパティエンドポイントに送信します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

プロパティ	型	R/W	リソースとともに返される	説明
SP.Field から継承されるプロパティについては、「Field プロパティ」を参照してください。 * は、プロパティが FieldMultiChoice から継承されないことを示します。
Choices	Collection(Edm.String)	RW	はい	フィールドでの選択に使用できる値を指定する値を取得または設定します。
EditFormat *	Int32	RW	はい	選択肢フィールドをオプションボタン ("ラジオボタン" とも呼ばれます) として表示するか、それともドロップダウンリストとして表示するかを決定します。ChoiceFormatType 値を表します。ドロップダウン = 0、ラジオボタン = 1。 *FieldChoice にのみ適用されます。
FillInChoice	Boolean	RW	はい	Choices プロパティで指定された値以外の値をフィールドが受け入れることができるかどうかを指定する値を取得または設定します。
GridEndNumber *	Int32	RW	はい	段階評価の終了番号を指定する値を取得または設定します。 *FieldRatingScale にのみ適用されます。
GridNAOptionText *	String	RW	はい	適用できないオプションを示す段階評価での選択肢に対応する表示テキストを指定する値を取得または設定します。 *FieldRatingScale にのみ適用されます。
GridStartNumber *	Int32	RW	はい	段階評価の開始番号を指定する値を取得または設定します。 *FieldRatingScale にのみ適用されます。
GridTextRangeAverage *	String	RW	はい	段階評価の平均に対応する表示テキストを指定する値を取得または設定します。 *FieldRatingScale にのみ適用されます。
GridTextRangeHigh *	String	RW	はい	最も高い段階評価に対応する表示テキストを指定する値を取得または設定します。 *FieldRatingScale にのみ適用されます。
GridTextRangeLow *	String	RW	はい	最も低い段階評価に対応する表示テキストを指定する値を取得または設定します。 *FieldRatingScale にのみ適用されます。
Mappings	String	R	はい	選択肢に対応する内部値を示す値を取得します。
RangeCount *	Int32	R	はい	段階評価でのオプションの数を示す値を取得します。 *FieldRatingScale にのみ適用されます。

FieldMultiChoice、FieldChoice、および FieldRatingScale メソッド

メソッドは SP.Field から継承されます。

DeleteObject (または、DELETE 要求をフィールドエンドポイントに送信する)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表現

次の例は、JSON 形式での SP.FieldMultiChoice リソースを表しています。

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'de0a7921-f807-4806-a4b6-a611224f19e5')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'de0a7921-f807-4806-a4b6-a611224f19e5')",
        "type":"SP.FieldMultiChoice"
      },
      "CanBeDeleted":true,
      "DefaultValue":"ECM",
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Features",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"de0a7921-f807-4806-a4b6-a611224f19e5",
      "Indexed":false,
      "InternalName":"Features",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":true,
      "SchemaXml":"<Field Type=\"MultiChoice\" DisplayName=\"Features\" Required=\"TRUE\" EnforceUniqueValues=\"FALSE\" Indexed=\"FALSE\" FillInChoice=\"TRUE\" ID=\"{de0a7921-f807-4806-a4b6-a611224f19e5}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Features\" Name=\"Features\" ColName=\"ntext6\" RowOrdinal=\"0\"><Default>ECM</Default><CHOICES><CHOICE>ECM</CHOICE><CHOICE>Workflow</CHOICE><CHOICE>Collaboration</CHOICE></CHOICES></Field>",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":false,
      "StaticName":"Features",
      "Title":"Features",
      "FieldTypeKind":15,
      "TypeAsString":"MultiChoice",
      "TypeDisplayName":"Choice",
      "TypeShortDescription":"Choice (menu to choose from)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "FillInChoice":true,
      "Mappings":null,
      "Choices":{"__metadata":{"type":"Collection(Edm.String)"},"results":["ECM","Workflow","Collaboration"]}
    }}

次の例は、JSON 形式での SP.FieldChoice リソースを表しています。

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'509e9ac8-7ee6-4452-aaf9-1d2c42909187')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'509e9ac8-7ee6-4452-aaf9-1d2c42909187')",
        "type":"SP.FieldChoice"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Impact",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"509e9ac8-7ee6-4452-aaf9-1d2c42909187",
      "Indexed":false,
      "InternalName":"Impact",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Impact\" Type=\"Choice\" Required=\"FALSE\" ID=\"{509e9ac8-7ee6-4452-aaf9-1d2c42909187}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Impact\" Name=\"Impact\" ColName=\"nvarchar6\" RowOrdinal=\"0\" Version=\"1\"><CHOICES><CHOICE>High</CHOICE><CHOICE>Medium</CHOICE><CHOICE>Low</CHOICE></CHOICES></Field>",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Impact",
      "Title":"Impact",
      "FieldTypeKind":6,
      "TypeAsString":"Choice",
      "TypeDisplayName":"Choice",
      "TypeShortDescription":"Choice (menu to choose from)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "FillInChoice":false,
      "Mappings":null,
      "Choices":{"__metadata":{"type":"Collection(Edm.String)"},"results":["High","Medium","Low"]},
      "EditFormat":0
    }}

次の例は、JSON 形式での SP.FieldRatingScale リソースを表しています。

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'7804ea60-6093-489d-a483-bafd70ea01e9')/Fields(guid'8eac1672-8a47-4d44-a261-f5620db71402')",
        "uri":"http://<site url>/_api/Web/Lists(guid'7804ea60-6093-489d-a483-bafd70ea01e9')/Fields(guid'8eac1672-8a47-4d44-a261-f5620db71402')",
        "type":"SP.FieldRatingScale"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"How_x0020_frequently_x0020_do_x02",
      "Filterable":false,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"8eac1672-8a47-4d44-a261-f5620db71402",
      "Indexed":false,
      "InternalName":"How_x0020_frequently_x0020_do_x02",
      "JSLink":"",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"How frequently do you use these features?\" Type=\"GridChoice\" Required=\"FALSE\" ID=\"{8eac1672-8a47-4d44-a261-f5620db71402}\" SourceID=\"{7804ea60-6093-489d-a483-bafd70ea01e9}\" StaticName=\"How_x0020_frequently_x0020_do_x02\" Name=\"How_x0020_frequently_x0020_do_x02\" ColName=\"ntext6\" RowOrdinal=\"0\" Version=\"2\" GridTxtRng1=\"Rarely\" GridTxtRng2=\"Sometimes\" GridTxtRng3=\"Often\" GridStartNum=\"1\" GridEndNum=\"3\"><CHOICES><CHOICE>ECM</CHOICE><CHOICE>Workflow</CHOICE><CHOICE>Collaboration</CHOICE></CHOICES></Field>",
      "Scope":"/Lists/Survey",
      "Sealed":false,
      "Sortable":false,
      "StaticName":"How_x0020_frequently_x0020_do_x02",
      "Title":"How frequently do you use these features?",
      "FieldTypeKind":16,
      "TypeAsString":"GridChoice",
      "TypeDisplayName":"Rating Scale",
      "TypeShortDescription":"Rating Scale (a matrix of choices or a Likert scale)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "FillInChoice":false,
      "Mappings":null,
      "Choices":{"__metadata":{"type":"Collection(Edm.String)"},"results":["ECM","Workflow","Collaboration"]},
      "GridEndNumber":3,
      "GridNAOptionText":null,
      "GridStartNumber":1,
      "GridTextRangeAverage":"Sometimes",
      "GridTextRangeHigh":"Often",
      "GridTextRangeLow":"Rarely",
      "RangeCount":3
    }}

FieldMultiLineText リソース

エンドポイント URI | プロパティ | メソッド | OData 表現

複数のテキスト行を含めることができるフィールドを指定します。SP.Field から継承します。フィールド型の値 = 3。

エンドポイント URI

http://<サイト url>_api/web/fields('<フィールド id>')
http://<サイト url>/_api/web/lists(guid'<リスト id>')/fields('<フィールド id>')

サポートされる HTTP メソッド

GET | POST | DELETE | MERGE | PUT

要求の例

GET 要求の例: 複数行テキストフィールドを取得します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST 要求の例: 複数行テキストフィールドを作成します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldMultiLineText' }, 'FieldTypeKind': 3,
    'Title': 'Justification', 'NumberOfLines': 8 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

フィールドを作成する他の方法についての詳細は、「FieldCollection メソッド」を参照してください。

MERGE 要求の例: 複数行テキストフィールドを変更します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldMultiLineText' }, 'RichText': true }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

MERGE 要求または PUT 要求のフィールド型を指定する方法についての詳細は、「実装メモ」を参照してください。

DELETE 要求の例: 複数行テキストフィールドを削除します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldMultiLineText プロパティ

プロパティを取得するには、以下の例に示されているように、GET 要求をプロパティエンドポイントに送信します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

プロパティ	型	R/W	リソースとともに返される	説明
SP.Field から継承されるプロパティについての詳細は、「Field プロパティ」を参照してください。
AllowHyperlink	Boolean	RW	はい	ハイパーリンクをフィールドの値として使用できるかどうかを指定する値を取得または設定します。
AppendOnly	Boolean	RW	はい	フィールドの値に対するすべての変更がリストフォームに表示されるかどうかを指定する値を取得または設定します。
NumberOfLines	Int32	RW	はい	フィールドに表示するテキストの行数を指定する値を取得または設定します。
RestrictedMode	Boolean	RW	はい	高度な書式設定のサブセットをフィールドがサポートするかどうかを指定する値を取得または設定します。
RichText	Boolean	RW	はい	フィールドが高度な書式設定をサポートするかどうかを指定する値を取得または設定します。
WikiLinking	Boolean	R	はい	Wiki ページのリンク設定のための、実装に固有のメカニズムがサポートされているかどうかを示す値を取得します。

FieldMultiLineText メソッド

メソッドは SP.Field から継承されます。

DeleteObject (または、DELETE 要求をフィールドエンドポイントに送信する)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表現

次の例は、JSON 形式での SP.FieldMultiLineText リソースを表しています。

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'c9569638-28a9-498d-9ed7-8151f54da247')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'c9569638-28a9-498d-9ed7-8151f54da247')",
        "type":"SP.FieldMultiLineText"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Justification",
      "Filterable":false,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"c9569638-28a9-498d-9ed7-8151f54da247",
      "Indexed":false,
      "InternalName":"Justification",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Justification\" Type=\"Note\" Required=\"FALSE\" ID=\"{c9569638-28a9-498d-9ed7-8151f54da247}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Justification\" Name=\"Justification\" ColName=\"ntext8\" RowOrdinal=\"0\" NumLines=\"8\" Version=\"3\" AllowHyperlink=\"TRUE\" RichText=\"TRUE\" />",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":false,
      "StaticName":"Justification",
      "Title":"Justification",
      "FieldTypeKind":3,
      "TypeAsString":"Note",
      "TypeDisplayName":"Multiple lines of text",
      "TypeShortDescription":"Multiple lines of text",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "AllowHyperlink":false,
      "AppendOnly":false,
      "NumberOfLines":8,
      "RestrictedMode":true,
      "RichText":true,
      "WikiLinking":false
    }}

FieldNumber および FieldCurrency リソース

エンドポイント URI | プロパティ | メソッド | OData 表現

リソース	説明	フィールドの型の値
FieldNumber	数値を含むフィールドを指定します。SP.Field から継承します。	9
FieldCurrency	通貨値を含むフィールドを指定します。SP.FieldNumber から継承します。	10

エンドポイント URI

http://<サイト url>_api/web/fields('<フィールド id>')
http://<サイト url>/_api/web/lists(guid'<リスト id>')/fields('<フィールド id>')

サポートされる HTTP メソッド

GET | POST | DELETE | MERGE | PUT

要求の例

GET 要求の例: 数値または通貨フィールドを取得します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST 要求の例: 数値フィールドを作成します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldNumber' }, 'FieldTypeKind': 9, 'Title': 'Target',
    'Minimum Value': 1 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

POST 要求の例: 通貨フィールドを作成します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldCurrency' }, 'FieldTypeKind': 10, 'Title': 'Est Cost',
    'CurrencyLocaleId': 2058, 'Minimum Value': 0 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

フィールドを作成する他の方法についての詳細は、「FieldCollection メソッド」を参照してください。

MERGE 要求の例: 数値または通貨フィールドを変更します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldNumber' }, 'Minimum Value': 0, 'Maximum Value': 10000 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

MERGE 要求または PUT 要求のフィールド型を指定する方法についての詳細は、「実装メモ」を参照してください。

DELETE 要求の例: 数値または通貨フィールドを削除します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldNumber および FieldCurrency プロパティ

プロパティを取得するには、以下の例に示されているように、GET 要求をプロパティエンドポイントに送信します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

プロパティ	型	R/W	リソースとともに返される	説明
SP.Field から継承されるプロパティについては、「Field プロパティ」を参照してください。 * は、プロパティが FieldNumber から継承されないことを示します。
CurrencyLocaleId *	Int32	RW	はい	フィールドの値の書式設定に使用される言語コード識別子 (LCID) を指定する値を取得または設定します。「ロケール識別子の一覧」を参照してください。 *FieldCurrency にのみ適用されます。
MaximumValue	Double	RW	はい	フィールドで使用できる最小値を指定する値を取得または設定します。
MinimumValue	Double	RW	はい	フィールドで使用できる最小値を指定する値を取得または設定します。

FieldNumber および FieldCurrency メソッド

メソッドは SP.Field から継承されます。

DeleteObject (または、DELETE 要求をフィールドエンドポイントに送信する)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表現

次の例は、JSON 形式での SP.FieldNumber リソースを表しています。

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'6b98a3a1-0b14-4495-b184-4de33c32de92')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'6b98a3a1-0b14-4495-b184-4de33c32de92')",
        "type":"SP.FieldNumber"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Target",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"6b98a3a1-0b14-4495-b184-4de33c32de92",
      "Indexed":false,
      "InternalName":"Target",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Target\" Type=\"Number\" Required=\"FALSE\" ID=\"{6b98a3a1-0b14-4495-b184-4de33c32de92}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Target\" Name=\"Target\" ColName=\"float1\" RowOrdinal=\"0\" Min=\"1\" Version=\"1\" />",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Target",
      "Title":"Target",
      "FieldTypeKind":9,
      "TypeAsString":"Number",
      "TypeDisplayName":"Number",
      "TypeShortDescription":"Number (1, 1.0, 100)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "MaximumValue":1.7976931348623157e+308,
      "MinimumValue":1
    }}

次の例は、JSON 形式での SP.FieldCurrency リソースを表しています。

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'63ea3717-a47f-4cec-858d-7fcae10de409')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'63ea3717-a47f-4cec-858d-7fcae10de409')",
        "type":"SP.FieldCurrency"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Est_x0020_Cost",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"63ea3717-a47f-4cec-858d-7fcae10de409",
      "Indexed":false,
      "InternalName":"Est_x0020_Cost",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Est Cost\" Type=\"Currency\" Required=\"FALSE\" ID=\"{63ea3717-a47f-4cec-858d-7fcae10de409}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Est_x0020_Cost\" Name=\"Est_x0020_Cost\" ColName=\"float3\" RowOrdinal=\"0\" LCID=\"2058\" Min=\"0\" Version=\"1\" />",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Est_x0020_Cost",
      "Title":"Est Cost",
      "FieldTypeKind":10,
      "TypeAsString":"Currency",
      "TypeDisplayName":"Currency",
      "TypeShortDescription":"Currency ($, ¥, €)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "MaximumValue":1.7976931348623157e+308,
      "MinimumValue": 0,
      "CurrencyLocaleId":2058
    }}

FieldText リソース

エンドポイント URI | プロパティ | メソッド | OData 表現

1 行テキストを含むフィールドを指定します。SP.Field から継承します。フィールド型の値 = 2。

エンドポイント URI

http://<サイト url>_api/web/fields('<フィールド id>')
http://<サイト url>/_api/web/lists(guid'<リスト id>')/fields('<フィールド id>')

サポートされる HTTP メソッド

GET | POST | DELETE | MERGE | PUT

要求の例

GET 要求の例: テキストフィールドを取得します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST 要求の例: テキストフィールドを作成します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldText' }, 'FieldTypeKind': 2,
    'Title': 'Project Name', 'MaxLength': '22' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

フィールドを作成する他の方法についての詳細は、「FieldCollection メソッド」を参照してください。

MERGE 要求の例: テキストフィールドを変更します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldText' }, 'Title': 'Code Name', 'MaxLength': '15' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

MERGE 要求または PUT 要求のフィールド型を指定する方法についての詳細は、「実装メモ」を参照してください。

DELETE 要求の例: テキストフィールドを削除します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldText プロパティ

プロパティを取得するには、以下の例に示されているように、GET 要求をプロパティエンドポイントに送信します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

プロパティ	型	R/W	リソースとともに返される	説明
SP.Field から継承されるプロパティについての詳細は、「Field プロパティ」を参照してください。
MaxLength	Int32	RW	はい	フィールドの値で使用できる最大文字数を指定する値を取得または設定します。

FieldText メソッド

メソッドは SP.Field から継承されます。

DeleteObject (または、DELETE 要求をフィールドエンドポイントに送信する)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表現

次の例は、JSON 形式での SP.FieldText リソースを表しています。

    {"d":{
      "__metadata":{,
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'bab9754a-3779-4862-8a8f-efcfef4fe073')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'bab9754a-3779-4862-8a8f-efcfef4fe073')",
        "type":"SP.FieldText"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Project_x0020_Name",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"bab9754a-3779-4862-8a8f-efcfef4fe073",
      "Indexed":false,
      "InternalName":"Project_x0020_Name",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Project Name\" Type=\"Text\" Required=\"FALSE\" ID=\"{bab9754a-3779-4862-8a8f-efcfef4fe073}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Project_x0020_Name\" Name=\"Project_x0020_Name\" ColName=\"nvarchar5\" RowOrdinal=\"0\" MaxLength=\"22\" Version=\"1\" />",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Project_x0020_Name",
      "Title":"Project Name",
      "FieldTypeKind":2,
      "TypeAsString":"Text",
      "TypeDisplayName":"Single line of text",
      "TypeShortDescription":"Single line of text",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "MaxLength":22
    }}

FieldUrl リソース

エンドポイント URI | プロパティ | メソッド | OData 表現

URL を含むフィールドを指定します。SP.Field から継承します。フィールド型の値 = 11。

エンドポイント URI

http://<サイト url>_api/web/fields('<フィールド id>')
http://<サイト url>/_api/web/lists(guid'<リスト id>')/fields('<フィールド id>')

サポートされる HTTP メソッド

GET | POST | DELETE | MERGE | PUT

要求の例

GET 要求の例: URL フィールドを取得します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST 要求の例: URL フィールドを作成します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldUrl' }, 'FieldTypeKind': 11,
    'Title': 'Avatar', 'DisplayFormat': 1 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

フィールドを作成する他の方法についての詳細は、「FieldCollection メソッド」を参照してください。

MERGE 要求の例: URL フィールドを変更します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldUrl' }, 'Title': 'Team pics', 'DisplayFormat': 0 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

MERGE 要求または PUT 要求のフィールド型を指定する方法についての詳細は、「実装メモ」を参照してください。

DELETE 要求の例: URL フィールドを削除します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldUrl プロパティ

プロパティを取得するには、以下の例に示されているように、GET 要求をプロパティエンドポイントに送信します。

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

プロパティ	型	R/W	リソースとともに返される	説明
SP.Field から継承されるプロパティについての詳細は、「Field プロパティ」を参照してください。
DisplayFormat	Int32	RW	はい	フィールド内の値の表示形式を指定する値を取得または設定します。UrlFieldFormatType 値を表します。ハイパーリンク = 0、イメージ = 1。

FieldUrl メソッド

メソッドは SP.Field から継承されます。

DeleteObject (または、DELETE 要求をフィールドエンドポイントに送信する)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表現

次の例は、JSON 形式での SP.FieldUrl リソースを表しています。

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'ac80888e-9373-4886-8496-2ee2461cdf03')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'ac80888e-9373-4886-8496-2ee2461cdf03')",
        "type":"SP.FieldUrl"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Avatar",
      "Filterable":false,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"ac80888e-9373-4886-8496-2ee2461cdf03",
      "Indexed":false,
      "InternalName":"Avatar",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Avatar\" Type=\"URL\" Required=\"FALSE\" ID=\"{ac80888e-9373-4886-8496-2ee2461cdf03}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Avatar\" Name=\"Avatar\" ColName=\"nvarchar13\" RowOrdinal=\"0\" ColName2=\"nvarchar14\" RowOrdinal2=\"0\" Format=\"Image\" Version=\"1\" />",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Avatar",
      "Title":"Avatar",
      "FieldTypeKind":11,
      "TypeAsString":"URL",
      "TypeDisplayName":"Hyperlink or Picture",
      "TypeShortDescription":"Hyperlink or Picture",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "DisplayFormat":1
    }}

実装メモ

継承されたプロパティを変更する場合、本文データの type 値は、フィールドを定義する親フィールド型またはそれを継承する子フィールド型を指定できます。たとえば、以下の本文データにより、SP.Field から取られた任意のフィールドの Title プロパティが変更されます。"{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Comments' }"。ただし、継承されないプロパティを変更する場合は、プロパティが含まれるフィールドの型を指定する必要があります。たとえば、以下の本文データにより NumberOfLines プロパティも変更されるため、SP.FieldMultiLineText 型が指定されます。"{ '__metadata': { 'type': 'SP.FieldMultiLineText' }, 'Title': 'Comments', 'NumberOfLines': 6 }"