LINQ を使ってApprovalMax のデータに連携する方法

この記事では、CData ADO.NET Data Provider for API 経由でLINQ を使ってApprovalMax テーブルにアクセスする方法を説明します。これを行うには、Entity Framework にLINQ を使います。これにより接続を作成し、あらゆる CData ADO.NET Data Providers からLINQ を使ってデータにアクセスできるようになります。

1. Visual Studio の新規プロジェクトで、プロジェクトを右クリックし［新しい項目の追加］を選択します。［ADO.NET Entity Data Model］を追加します。
2. ［データベースから生成］を選択し、［次へ］をクリックします。
3. ［接続の追加］をクリックし、データソースタイプを "CData ApprovalMax Data Source" に変更します。

4. データソースの接続情報を入力します。一般的な接続プロパティは以下のとおりです：

   まず、Profile 接続プロパティをディスク上の ApprovalMax プロファイルの場所に設定します（例：C:\profiles\ApprovalMax.apip）。次に、ProfileSettings 接続プロパティを ApprovalMax の接続文字列に設定します（以下を参照）。

   ApprovalMax API プロファイル設定

   ApprovalMax Public API では、OAuth 2.0 の認可コードフローで認証を行います。自分のデータに接続するだけでなく、他のユーザーが各自のデータに接続できるようにすることも可能です。

   まず、ApprovalMax に OAuth アプリケーションを登録する必要があります。ApprovalMax Developer Portal（https://developer.approvalmax.com/applications）にサインインし、新しいアプリケーションを作成します。OAuth アプリケーションには Client ID と Client Secret が割り当てられます。また、Redirect URI（Callback URL）を少なくとも1つ登録しておく必要があります。

   Public API を利用するには、ApprovalMax の Premium サブスクリプション（または有効なトライアル）が必要です。

   以下の接続プロパティを設定すると、接続できるようになります。

   • AuthScheme：OAuth に設定します。
   • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
   • OAuthClientId：ApprovalMax Developer Portal のアプリケーション設定に表示される Client ID に設定します。
   • OAuthClientSecret：ApprovalMax Developer Portal のアプリケーション設定に表示される Client Secret に設定します。
   • CallbackURL：アプリケーション設定で登録した Redirect URI に設定します。
   • Scope：（オプション）デフォルトの OAuth スコープを上書きします。デフォルト値の openid offline_access https://www.approvalmax.com/scopes/public_api/read は、このプロファイルのすべてのテーブルへの読み取り専用アクセスを許可し、リフレッシュトークンを有効にします。スコープを絞り込む際は、最小権限の原則に従ってください。

   OAuth の Authorization URL は https://identity.approvalmax.com/connect/authorize、Token URL は https://identity.approvalmax.com/connect/token です。グラントタイプは authorization_code と refresh_token の両方に対応しています。

   Below is a typical connection string:

   Profile=C:\profiles\ApprovalMax.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;


5. エンティティ接続をApp.Config に保存する場合は、エンティティ名を設定します。この例では、APIEntities をエンティティ接続としてApp.Config に設定しています。
6. モデル名を入力し、モデルに含めたいテーブルまたはビューを選択します。

作成したエンティティを使って、選択、更新、削除、および挿入コマンドが実行できます。例：

APIEntities context = new APIEntities();
var userprofilesQuery = from userprofiles in context.UserProfiles  select userprofiles;
foreach (var result in userprofilesQuery) {
	Console.WriteLine("{0} {1} ", result.Id, result.UserId);
}
	

サポートされたLINQ のクエリ例は、ヘルプドキュメントの「LINQ およびEntity Framework」をご参照ください。