基本的な URI 構造およびパス
このトピックでは、Excel Services で REST サービスのコマンドの URI 構造とパスを構築する方法を説明します。
注:
Excel Services REST API は、SharePoint および SharePoint 2016 オンプレミスに適用されます。 Office 365 Education、Business、Enterprise の各アカウントでは、Microsoft Graph エンドポイントの一部である Excel REST API を使用します。
URL の基本構造およびパス
Excel Services の REST API を使用すると、直接 URL を介してブック内のグラフ、ピボットテーブル、表、名前付き範囲などのリソースにアクセスできます。 Excel Services の各 REST URL は 3 つのパーツでできています。 ブック内のリソースにアクセスする URL の基本構造を次に示します。
- REST aspx ページの URI.aspx ページのエントリ ポイント
- ブックの場所 ブックへのパス
- リソースの場所 ブック内の要求されたリソースのパス
ブック内の特定の要素に対する REST URL の構造を次に示します。
http://<ServerName>/_vti_bin/ExcelRest.aspx/<DocumentLibrary>/<FileName>/<ResourceLocation>
次は、3 つのパーツすべてを組み合わせると Excel Services の REST URL がどのように見えるかの例です。 この例では、"SampleChart" というグラフを含む "sampleWorkbook.xlsx" というブックにアクセスします。
http://<ServerName>/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('SampleChart')
ブックはドキュメント ライブラリに格納されます。 ブックの完全なパスは http://<ServerName です>/Docs/Documents/sampleWorkbook.xlsx。
REST URL の 3 つのパーツは次のとおりです。
- REST aspx ページの URI:
http://<ServerName>/_vti_bin/ExcelRest.aspx - ブックの場所:
/Docs/Documents/sampleWorkbook.xlsx - リソースの場所:
/model/Ranges('nameOfTheNamedRange')
探索ユーザー インターフェイスを使用したアクセス
グラフには、探索ユーザー インターフェイスを使用してアクセスすることもできます。 次のスクリーン ショットに示す検出メカニズムを使用して、グラフ、テーブル、ピボットテーブル、範囲などのリソースにアクセスする方法については、「Excel Services REST API での検出」を参照してください。
マーカーのパス
Excel Services の REST サービスの aspx ページを次に示します。
http://<ServerName>/_vti_bin/ExcelRest.aspx
Excel Servicesの REST サービスにアクセスするには、ServerName> で URL の先頭を付ける<http://必要があります。/_vti_bin/ExcelRest.aspx
ブックの場所
ブックの場所は、アクセスしようと考えているリソースがあるブックへの相対パスです。 たとえば、信頼できる SharePoint ドキュメント ライブラリに保存された、sampleWorkbook.xlsx という名前のブックがあるとします。 この場合、sampleWorkbook.xlsx の場所へのパスは次のとおりです。
http://<ServerName>/Docs/Documents/sampleWorkbook.xlsx
ブック ( Docs/Documents/sampleWorkbook.xlsx) の相対パスを、マーカー パスの後に追加します。 マーカー パスとブックの場所が後に追加された URL は次のとおりです。
http://<ServerName>/_vti_bin/ExcelRest.aspx
リソースの場所
リソースの場所は、ブック内の要求する要素へのパスです。 たとえば、グラフを取得する場合、リソースの場所は のようになります /model/Charts('Chart 1')。
完全な URL では、これをブックへのマーカー パスおよび相対パスの後に追加します。 完全な URL の例は次のとおりです。
http://<ServerName>/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('Chart 1')