
SharePointのRESTコマンドのまとめです。
今回は、フィールドのREST APIのまとめです。
SharePoint REST サービスとは
SharePoint の RESTの概要は以下を参照ください。
Field
エンドポイント URI
http://<サイト url>api/web/fields('<フィールド id>)
http://<サイト url>/api/web/lists(guid'<リスト id>')/fields('<フィールド id>')
| メソッド | HTTP method | 説明 |
|---|---|---|
| SetShowInDisplayForm | POST | このフィールドの ShowInDisplayForm プロパティの値を設定します。 |
| SetShowInEditForm | POST | このフィールドの ShowInEditForm プロパティの値を設定します。 |
| SetShowInNewForm | POST | このフィールドの ShowInNewForm プロパティの値を設定します。 |
FieldCalculated
エンドポイント URI
http://<サイト url>api/web/fields('<フィールド id>)
http://<サイト url>/api/web/lists(guid'<リスト id>')/fields('<フィールド id>')
| メソッド | HTTP method | 説明 |
|---|---|---|
| SetShowInDisplayForm | POST | このフィールドの ShowInDisplayForm プロパティの値を設定します。 |
| SetShowInEditForm | POST | このフィールドの ShowInEditForm プロパティの値を設定します。 |
| SetShowInNewForm | POST | このフィールドの ShowInNewForm プロパティの値を設定します。 |
FieldCollection
エンドポイント URI
http://<サイト url>/api/web/fields
http://<サイト url>/api/web/lists(guid'<リスト id>')/fields
| メソッド | HTTP method | 説明 |
|---|---|---|
| AddDependentLookupField | POST | リレーションシップに関してプライマリ ルックアップ フィールドに依存しているセカンダリ ルックアップ フィールドを、その情報の取得場所であるリストに追加します。 |
| AddField | POST | フィールド コレクションにフィールドを追加します。 |
| CreateFieldAsXml | POST | 指定されたスキーマ、Boolean 値、およびフィールド オプションに基づいてフィールドを作成します。 |
| GetById | GET | 指定された ID を持つフィールドを取得します。 |
| GetByInternalNameOrTitle | GET | 指定された内部名またはタイトルを持つ最初の Field オブジェクトをコレクションから取得します。 |
| GetByTitle | GET | 指定されたフィールドのタイトルに基づいてコレクション内の最初のフィールド オブジェクト返します。 |
AddFieldについては、下記を参照ください。
FieldComputed
エンドポイント URI
http://<サイト url>/api/web/fields
http://<サイト url>/api/web/lists(guid'<リスト id>')/fields
| メソッド | HTTP method | 説明 |
|---|---|---|
| SetShowInDisplayForm | POST | このフィールドの ShowInDisplayForm プロパティの値を設定します。 |
| SetShowInEditForm | POST | このフィールドの ShowInEditForm プロパティの値を設定します。 |
| SetShowInNewForm | POST | このフィールドの ShowInNewForm プロパティの値を設定します。 |
FieldDateTime
エンドポイント URI
http://<サイト url>/api/web/fields
http://<サイト url>/api/web/lists(guid'<リスト id>')/fields
| メソッド | HTTP method | 説明 |
|---|---|---|
| SetShowInDisplayForm | POST | このフィールドの ShowInDisplayForm プロパティの値を設定します。 |
| SetShowInEditForm | POST | このフィールドの ShowInEditForm プロパティの値を設定します。 |
| SetShowInNewForm | POST | このフィールドの ShowInNewForm プロパティの値を設定します。 |
FieldGeolocation
エンドポイント URI
http://<サイト url>/api/web/fields
http://<サイト url>/api/web/lists(guid'<リスト id>')/fields
| メソッド | HTTP method | 説明 |
|---|---|---|
| SetShowInDisplayForm | POST | このフィールドの ShowInDisplayForm プロパティの値を設定します。 |
| SetShowInEditForm | POST | このフィールドの ShowInEditForm プロパティの値を設定します。 |
| SetShowInNewForm | POST | このフィールドの ShowInNewForm プロパティの値を設定します。 |
FieldGuid
エンドポイント URI
http://<サイト url>/api/web/fields
http://<サイト url>/api/web/lists(guid'<リスト id>')/fields
| メソッド | HTTP method | 説明 |
|---|---|---|
| SetShowInDisplayForm | POST | このフィールドの ShowInDisplayForm プロパティの値を設定します。 |
| SetShowInEditForm | POST | このフィールドの ShowInEditForm プロパティの値を設定します。 |
| SetShowInNewForm | POST | このフィールドの ShowInNewForm プロパティの値を設定します。 |
FieldLookup および FieldUser
エンドポイント URI
http://<サイト url>/api/web/fields
http://<サイト url>/api/web/lists(guid'<リスト id>')/fields
| メソッド | HTTP method | 説明 |
|---|---|---|
| SetShowInDisplayForm | POST | このフィールドの ShowInDisplayForm プロパティの値を設定します。 |
| SetShowInEditForm | POST | このフィールドの ShowInEditForm プロパティの値を設定します。 |
| SetShowInNewForm | POST | このフィールドの ShowInNewForm プロパティの値を設定します。 |
FieldMultiChoice、FieldChoice、および FieldRatingScale
エンドポイント URI
http://<サイト url>/api/web/fields
http://<サイト url>/api/web/lists(guid'<リスト id>')/fields
| メソッド | HTTP method | 説明 |
|---|---|---|
| SetShowInDisplayForm | POST | このフィールドの ShowInDisplayForm プロパティの値を設定します。 |
| SetShowInEditForm | POST | このフィールドの ShowInEditForm プロパティの値を設定します。 |
| SetShowInNewForm | POST | このフィールドの ShowInNewForm プロパティの値を設定します。 |
FieldMultiLineText
エンドポイント URI
http://<サイト url>/api/web/fields
http://<サイト url>/api/web/lists(guid'<リスト id>')/fields
| メソッド | HTTP method | 説明 |
|---|---|---|
| SetShowInDisplayForm | POST | このフィールドの ShowInDisplayForm プロパティの値を設定します。 |
| SetShowInEditForm | POST | このフィールドの ShowInEditForm プロパティの値を設定します。 |
| SetShowInNewForm | POST | このフィールドの ShowInNewForm プロパティの値を設定します。 |
FieldNumber および FieldCurrency
エンドポイント URI
http://<サイト url>/api/web/fields
http://<サイト url>/api/web/lists(guid'<リスト id>')/fields
| メソッド | HTTP method | 説明 |
|---|---|---|
| SetShowInDisplayForm | POST | このフィールドの ShowInDisplayForm プロパティの値を設定します。 |
| SetShowInEditForm | POST | このフィールドの ShowInEditForm プロパティの値を設定します。 |
| SetShowInNewForm | POST | このフィールドの ShowInNewForm プロパティの値を設定します。 |
FieldText
エンドポイント URI
http://<サイト url>/api/web/fields
http://<サイト url>/api/web/lists(guid'<リスト id>')/fields
| メソッド | HTTP method | 説明 |
|---|---|---|
| SetShowInDisplayForm | POST | このフィールドの ShowInDisplayForm プロパティの値を設定します。 |
| SetShowInEditForm | POST | このフィールドの ShowInEditForm プロパティの値を設定します。 |
| SetShowInNewForm | POST | このフィールドの ShowInNewForm プロパティの値を設定します。 |
FieldUrl
エンドポイント URI
http://<サイト url>/api/web/fields
http://<サイト url>/api/web/lists(guid'<リスト id>')/fields
| メソッド | HTTP method | 説明 |
|---|---|---|
| SetShowInDisplayForm | POST | このフィールドの ShowInDisplayForm プロパティの値を設定します。 |
| SetShowInEditForm | POST | このフィールドの ShowInEditForm プロパティの値を設定します。 |
| SetShowInNewForm | POST | このフィールドの ShowInNewForm プロパティの値を設定します。 |