SharePoint REST API が JSON Light に対応

対象: 新Office365 Office 365 Enterprise, Office 365 Small Business, Office 365 Midsize Business

(この記事は 2014 年 8 月 13 日に Office Blogs に投稿された記事 JSON Light support in REST SharePoint API releasedの翻訳です。最新情報については、翻訳元の記事をご参照ください。)

SharePoint REST API は、Office 365 の開発者の皆様が SharePoint サイト、リスト/ライブラリ、リスト アイテム/ドキュメントを操作するための手段として、きわめて一般的になりました。この API を利用している開発者の皆様から寄せられたご意見の中でも特に多かったのは、返されるデータのペイロードに関するものでした。マイクロソフトはこれを受けて、JSON Light のサポートを追加しました。JSON Light はオープン標準であり、これによって、返されるメタデータのサイズを要求のヘッダーで指定することができます。JSON Light の詳細については、Microsoft による OData JSON の仕様書 (英語)を参照してください。また MSDN では、SharePoint REST API のすべてのエンドポイントをご確認いただけます。

これまで、Office 365 の開発者が SharePoint REST API を呼び出すときは、要求ヘッダーに "accept: application/json; odata=verbose" を含める必要がありました。しかし今回、このヘッダーは省略可能になり、さらなる OData オプションが追加されました。開発するビジネス ソリューションで一部のメタデータしか使用しない場合は、新しく追加されたオプションを使用することで、呼び出しにおけるペイロードのサイズを大幅に減らすことが可能です。以下に OData の例をご紹介します。リスト内の一連のリスト アイテムに対して要求を発行するという一般的なシナリオを前提としたものです。対応する応答のサイズもご確認いただけます。

要求ヘッダーの OData プロパティは必須項目ではなくなったため、上記のどの値も指定する必要がなければ、指定しなくてかまいません。指定しない場合は既定で minimalmetadata オプションが適用されます。