SharePoint BCS REST API リファレンスBCS REST API reference for SharePoint

クラス ライブラリおよびリファレンス

Representation State Transfer (REST) URL を構築して、SharePointの Business Connectivity Services (BCS) を使用して外部データ ソースに対するアクセスと操作を行うための参照情報を示します。Contains reference information for constructing Representational State Transfer (REST) URLs to access and manipulate external data sources using Business Connectivity Services (BCS) in SharePoint.

SharePoint で外部データへアクセスするための REST 対応 API の使用Using RESTful APIs to access external data in SharePoint

SharePoint によって提供される REST インターフェイスを使用すれば、特別に構築された URL を介して大部分の SharePoint リソースにアクセスできます。Business Connectivity Services (BCS) では、このアーキテクチャを使用して外部データにアクセスします。The REST interface provided by SharePoint enables you to access most SharePoint resources through specially constructed URLs. Business Connectivity Services (BCS) uses this architecture to provide access to external data.

標準のリスト アイテムにアクセスするときと同様に URL を作成することで、外部データにアクセスできます。You can access external data by constructing URLs just as you would to access standard list items.

注意

BDC を使用してエンティティに直接アクセスすることはできません。外部データを操作するには、外部リストを作成してから、REST URL を使用してその外部リストに含まれるリスト アイテムにアクセスします。Access to entities through the BDC directly is not provided. To work with external data, you must create an external list and use the REST URLs to access the list items contained in the external list.

外部リストの操作のためにサポートされている HTTP 動詞は、GETPUTPOST、および DELETE です。The supported HTTP verbs for working with external lists are GET, PUT, POST, and DELETE.

通常のリストとは異なり、外部リストは REST を使用して作成することはできません。それを行うには、Visual Studio 2012 を使用して BDC モデルと外部リストを作成します。Unlike with normal lists, you can't create an external list using REST. You must do that by creating a BDC model and an external list using Visual Studio 2012.

表 1 は REST 対応の URL と、それに対応する外部データ ソースからデータへのアクセスや操作をするために呼び出すクライアント オブジェクト モデルの作成方法を示します。The information in Table 1 shows how to construct RESTful URLs and the corresponding client object model calls to access and manipulate data from external data sources.

表 1. 外部データ アクセスのための REST 対応 URL の形式Table 1. RESTful URL formats for accessing external data

URLURL 説明Description HTTP メソッドHTTP method
http://[sharepointsite]/_api
すべての REST リクエストの基礎です。_api 仮想ディレクトリは、クライアント オブジェクト モデルが使用される client.svc への呼び出しにマッピングされます。The base of any REST request. The _api virtual directory is mapped to call into client.svc, where the client object model can be used.
GETGET
http://[sharepointsite]/_api/web/title
現在の Web のタイトルを取得します。Retrieves the title of the current web.
GETGET
http://[sharepointsite]/_api/lists
サイトのすべてのリストを取得します。Retrieves all lists on a site.
GETGET
http://[sharepointsite]/_api/lists/getbytitle('listname')
指定したリストのメタデータを取得します。Retrieves the metadata for a specified list.
GETGET
http://[sharepointsite]/_api/lists/getbytitle('listname')/items
指定したリスト内のリスト項目を取得します。Retrieves the list items in a specified list.
GETGET
http://[sharepointsite]/_api/lists/getbytitle('listname')?select=Title
指定したリストのタイトルを取得します。Retrieves the title of a specific list.
GETGET

データをフィルタリングするためのクエリ文字列の作成Constructing query strings for filtering data

返されるデータ量を制限する場合、またはそのデータ量をユーザーにより深く関連させる場合には、表 2 に示したフィルター演算子を使用できます。In order to limit the amount of data returned, or make it more relevant to the user, you can use the filter operations found in Table 2.

表 2. データをフィルタリングするための演算子Table 2. Operators for filtering data

演算子Operator 説明Description
EQEQ
等しいEquals
注: EQ を使用してフィルタリングを実行すると、フィルター条件は、サーバー上でフィルタリングが実行される外部システムに渡されます。Note: When you use EQ to filter, the filter criteria are passed to the external system where the filtering happens on the server.
GTGT
次の値より大きいGreater Than
注: GT 演算子を使用すると、クライアント側のフィルタリングのみが実行されます。例: web/lists/getByTitle('ListName')/Items?$select=Title&$filter=AverageRating gt 3 は、平均レートが 3 を超えるタイトルをすべて返します。Note: When you use the GT operator, only client-side filtering is executed.> For example: web/lists/getByTitle('ListName')/Items?$select=Title&$filter=AverageRating gt 3 returns all titles with an average rating over 3.

注意

関連付けの一部である列を取得するには、クエリ文字列に $select を使用して、URL にその列を明示的に含める必要があります。To retrieve columns that are part of an association, you must explicitly include the column in the URL using $select in the query string.

関連項目See also