USER MANUALS

SharePoint REST API

SharePoint には、SharePoint の既存の クライアントオブジェクトモデル に相当する REST サービスがあります。これで、標準的な REST 機能をサポートするテクノロジーを使用して、SharePoint オブジェクトと直接連携できます。

OAuth 2.0 資格情報の取得

SharePoint REST API ウィザードを構成するための OAuth 資格情報を取得するには、[Tools] > [OAuth credential wizards] > [OAuth 2.0 wizard] をクリックします。

OAuth トークンを取得するためのダイアログがツールに表示されます。

OAuth 2.0 credentials wizard

OAuth 2.0 資格情報ウィザード

OAuth トークンを取得するには、以下のパラメータを入力します。

  • Client identifier: 新しく作成された Azure アプリケーションのクライアント ID。

  • Client secret: 新しく作成されたアプリケーションに対して、前の手順で生成されたシークレットの値。

  • Token endpoint URL: https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token

  • Authorization server URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

  • Redirect URI: Azure でのアプリ登録時に使用したリダイレクト URI。

  • Scopes: 次の内容を入力します。

    • offline_access

    • https:/<tenant_name>.sharepoint.com/AllSites.Read

    これらの スコープ には、データにクエリを実行するために必要な権限が必須です。

すべての値を指定した後、[Generate Authorization URL] をクリックし、認可 URL が生成されたら、[open URL link] をクリックします。ブラウザーにウィンドウが開き、ページで権限を入力します。権限が指定されると、コード付きの URL が生成されます。URL の形式はhttps://<tenant_name>.sharepoint.com/?code=<>&state=<>&session_state=<># です。

同じ内容を [Paste the authorized response URL] に貼り付け、[Obtain OAuth 2.0 credentials] を選択します。

最後に [Copy the credentials to clipboard] をクリックして、OAuth トークンを保存します。

アーティファクトのインポート

これで、SharePoint ウィザードの使用に必要なデータがすべて揃いました。[File] メニュー > [New] > [Data source] をクリックして、[Microsoft SharePoint REST API] を選択します。

Microsoft SharePoint REST API wizard

Microsoft SharePoint REST API ウィザード

以下のパラメータを入力します。

  • Database: SharePoint のデータソースとビューが作成されるデータベースの名前。

  • View name prefix: VDP ビューを SharePoint Online サイトに関連付けるために作成されたすべてのビューの名前の接頭辞。このパラメータは最長で 10 文字です。

  • SharePoint Online service name: OAuth 2.0 の VDP ウィザードで生成されるアクセストークン。

  • Realm: ディレクトリのテナント ID。

  • Client ID: Azure アプリの登録時に生成されたクライアント ID。

  • Client Secret: Azure アプリの登録時に生成されたクライアントシークレット。

  • Redirect URI: Azure アプリの作成時に登録されたリダイレクト URI。

  • Access token: 前の手順で生成されたアクセストークン。

  • Refresh token: 前の手順で生成された更新トークン。

  • Site name: リストとフォルダの内容を取得する特定の SharePoint Online サイトのサイト名。

ここで [Execute import] をクリックして、SharePoint にクエリを実行するためのデータソースとビューを作成します。

注釈

作成されたビューは読み取り専用です。

注釈

以下の例では、 site2 を [View name prefix] 構成パラメータの値として使用しています。

SharePoint data source and views created

作成された SharePoint のデータソースとビュー

  • ${view.prefix}_all_lists: [Site name] プロパティで指定された SharePoint サイトのリストをすべて取得します。

  • ${view.prefix}_file: ファイルを取得します。

    • 必要なパラメータ:

      • file_path: ファイルのパス。

  • ${view.prefix}_file_list_item_all_fields: ファイルの ListItemAllFields プロパティの値を取得します。

    • 必要なパラメータ:

      • file_path: ファイルのパス。

  • ${view.prefix}_file_modified_by: ファイルの ModifiedBy プロパティの値を取得します。

    • 必要なパラメータ:

      • file_path: ファイルのパス。

  • bv_${view.prefix}_file_version_events: ファイルの VersionEvents プロパティの値を取得します。

    • 必要なパラメータ:

      • file_path: ファイルのパス。

  • bv_${view.prefix}_file_versions: ファイルの Version プロパティの値を取得します。

    • 必要なパラメータ:

      • file_path: ファイルのパス。

  • bv_${view.prefix}_files_attached_to_list: リストアイテムに添付されるすべてのファイルを取得します。

    • 必要なパラメータ:

      • list_name: リストの名前。

      • item_id: アイテムの ID。

  • ${view.prefix}_files_in_folder: フォルダ内のファイルを取得します。

    • 必要なパラメータ:

      • folder_path: フォルダのパス。

  • ${view.prefix}_folder: フォルダに関する情報を取得します。

    • 必要なパラメータ:

      • folder_path: フォルダのパス。

  • ${view.prefix}_folder_parent: フォルダの ParentFolder プロパティの値を取得します。

    • 必要なパラメータ:

      • folder_path: フォルダのパス。

      • property_name: プロパティの名前。

  • bv_${view.prefix}_items_by_list_name: リストのすべてのアイテムを取得します。

    • 必要なパラメータ:

      • list_name: リストの名前。

  • bv_${view.prefix}_list_as_stream: アイテムをストリームとして取得します。

    • 必要なパラメータ:

      • list_name: リストの名前。

  • ${view.prefix}_list_by_guid: リストの詳細を GUID 別に取得します。

    • 必要なパラメータ:

      • guid: リストの GUID。

  • ${view.prefix}_list_by_name: リストを名前別に取得します。

    • 必要なパラメータ:

      • list_name: リストの名前。

  • ${view.prefix}_subfolders_in_folder: フォルダ内のフォルダを取得します。

    • 必要なパラメータ:

      • folder_path: フォルダのパス。

  • ${view.prefix}_web: [Site name] プロパティで指定されたサイトの詳細を取得します。

  • bv_${view.prefix}_web_title: [Site name] プロパティで指定されたサイトのタイトルを取得します。

  • bv_${view.prefix}_excel_file: Excel ファイルを取得します。

    • 必要なパラメータ:

      • file_path: 取得するファイルのパス。

  • ${view.prefix}_folder_full_content: フォルダ内のファイルとフォルダをどちらも取得します。

    • 必要なパラメータ:

      • folder_path: フォルダのパス。

注釈

すべてのパスは /sites/${sharepoint.site.name}/ の相対パスになります。

クエリ例

作成された SharePoint Online のビューに対してクエリを実行できます。

  • クエリ 1.フォルダ MyLibrary の内容をすべて取得します。

    Querying site2_folder_full_content view

    site2_folder_full_content ビューへのクエリの実行

    site2_folder_full_content query result

    site2_folder_full_content のクエリ結果

  • クエリ 2.``MyList`` リストに添付のアイテム 2 に添付されるファイルを取得します。

    Querying bv_site2_files_attached_to_list view

    bv_site2_files_attached_to_list ビューへのクエリの実行

    bv_site2_files_attached_to_list query result

    bv_site2_files_attached_to_list のクエリ結果

  • クエリ 3.Excel ファイルを取得します。

    Querying bv_site2_excel_filet view

    bv_site2_excel_file ビューへのクエリの実行

    bv_site2_excel_file query result

    bv_site2_excel_file のクエリ結果

Add feedback