OData

ODataとは「Webアプリケーションにおけるデータアクセス方法を標準化したプロトコル」です。Microsoft、IBM、SAP、Citrix社など中心となり仕様が策定され、2014年3月に国際標準化団体OASIS（Organization for the Advancement of Structured Information Standards, 構造化情報標準促進協会）によりOData 4.0が標準化されています。

ForguncyはOData、およびODataのリソースパスを使用したテーブルデータの取得のみをサポートしています。また、ODataの一部のクエリオプション、演算子、関数をサポートしています。ODataを使ったデータの取得方法には、以下の4種類の方法があります。

サーバーサイドAPI

GetTableData メソッド (String)オーバーロードを使用することで、ODataのリソースパスを使ってテーブルデータを取得できます。

Web API

getTableDataByODataメソッドを使用することで、ODataのリソースパスを使ってテーブルデータを取得できます。詳細はレコードの取得を参照してください。

URL

以下のようなURLのルールで、ODataを使用したテーブルデータの取得が行えます。

http://＜サーバー名、またはIPアドレス＞/＜アプリケーションパス＞/OData/GetData/＜ODataのリソースパス＞

たとえば、サーバー名が「srv01」、アプリケーション名が「app01」である場合に、「Categories」テーブルの「CategoryID」フィールドの値が「2」のレコードを取得するURLは以下のようになります。

なお、Forguncyアプリケーションにログインしていない場合には、URLを使用した方法は使用できません。以下にC#コードを使用してForguncyアプリケーションの認証を取得し、URLによるODataを使用したテーブルデータの取得例を示します。

public string GetOData(string baseUrl, string odataParam, CookieContainer loginCookie)
{
    HttpWebRequest rq = HttpWebRequest.Create(baseUrl + "OData/GetData/" + odataParam) as HttpWebRequest;
    rq.CookieContainer = loginCookie;
    rq.Method = WebRequestMethods.Http.Get;
    var response = rq.GetResponse();
    return new StreamReader(response.GetResponseStream()).ReadToEnd();
}
CookieContainer GetLoginCookie(string baseUrl, string userName, string passWord)
{
    var login = baseUrl + "Account/Login";
    HttpWebRequest rq = HttpWebRequest.Create(login) as HttpWebRequest;
    rq.CookieContainer = new CookieContainer();
    rq.Method = WebRequestMethods.Http.Post;
    rq.Accept = "application/json";
    rq.ContentType = "application/json";
    var loginStr = "{userName:\"" + userName + "\", password:\"" + passWord + "\",rememberMe:true }";
    var data = Encoding.UTF8.GetBytes(loginStr);
    using (Stream stream = rq.GetRequestStream())
    {
        stream.Write(data, 0, data.Length);
    }
    var response = rq.GetResponse();
    return rq.CookieContainer;
}
 
//テストコード
var baseUrl = "http://localhost:42515/Forguncy/";
var loginCookie = GetLoginCookie(baseUrl, "Administrator", "123456");
Console.WriteLine(GetOData(baseUrl, "table", loginCookie));
Console.WriteLine(GetOData(baseUrl, "table(2)", loginCookie));

public static string GetODataWindows(string baseUrl, string odataParam, string userName, string password, string domain)
{
    HttpWebRequest rq = HttpWebRequest.Create(baseUrl + "OData/GetData/" + odataParam) as HttpWebRequest;
    rq.Credentials = new NetworkCredential(userName,password, domain); 
    rq.Method = WebRequestMethods.Http.Get;
    var response = rq.GetResponse();
    return new StreamReader(response.GetResponseStream()).ReadToEnd();
}
 
// テストコード
Console.WriteLine(GetOData(baseUrl, "table", "budoutaro", "123456","abccompany"));

関数

Excelには存在しないForguncy固有の関数としてODATA関数を提供しています。ODATAを使用することで、ODataのリソースパスを使ってテーブルデータを取得できます。なお、ODATA関数はリストビュー上のセルでは使用できません。

「Categories」テーブルの「CategoryID」フィールドの値が「2」のレコードを取得する場合の数式は以下のようになります。

上記の場合で、値「2」の部分をA1セルの値で置き換えたい場合の数式は以下のようになります。

ODATA関数を使って複数レコードのデータを表示したい場合、配列数式と組み合わせることで実現可能です。詳しくは配列数式を使用するを参照してください。

ODataの具体例

このようなODataのURLをForguncyがサポートする4種類の方法で表現した場合、以下のようになります。

Forguncy.getTableDataByOData("Categories(1)/Products?$top=2&$orderby=Name", function (data) { }, function (e) { });

URL（サーバー名が「srv01」、アプリケーション名が「app01」である場合）

以下に代表的な具体例を示します。記載する具体例は「リソースパス」以降の部分のみです。

●基本的なクエリ

括弧を使用して評価の優先順位を制御した場合を除き、各クエリオプションの評価順序はSQLにおけるselect文の評価順序に従います。クエリオプションの並び順は関係しませんので、注意してください。

●filterオプション

●selectオプション

●topオプション

●orderbyオプション

●Countオプション

●expand

●特定レコードの関連テーブルのデータ取得

サポートされる演算子や関数

ForguncyのODataでは、以下の演算子や関数がサポートされます。

演算子	説明	例
eq	等号	`Accounts?$filter=City eq '仙台'`
ne	不等号	`Accounts?$filter=City ne null`
gt	より大きい	`Accounts?$filter=SupportIncidents/Value gt 1000`
ge	以上	`Accounts?&$filter=SupportIncidents/Value ge 1000`
lt	より小さい	`Accounts?$filter=SupportIncidents/Value lt 1000`
le	以下	`Accounts?$filter=SupportIncidents/Value le 1000`
and	論理積	`Accounts?$filter=SupportIncidents/Value ge 1000 andPrefecture eq '宮城'`
or	論理和	`Accounts?$filter=AccountCategoryCode/Value eq 2 or AccountRank/Value eq 1`
not	論理否定	`Accounts?$filter=(AccountCategoryCode/Value ne null) and not (AccountCategoryCode/Value eq 1)`

関数	説明
contains/not contains	指定した文字列を含むかどうかを返します。
startswith/not startswith	指定した文字列で始まるかどうかを返します。
endswith/not endswith	指定した文字列で終わるかどうかを返します。
year	指定した日付の年を返します。
month	指定した日付の月を返します。
day	指定した日付の日を返します。

データ型	リテラル形式	例
Null	null	null
Boolean	true\|false	例1：true 例2：false
DateTime	yyyy-mm-dd \| yyyy-mm-ddThh:mm[:ss[.fffffff]]Z	例1：2000-01-01 例2：2000-01-01T12:00:00Z
Decimal	[0-9]+.[0-9]+M\|m	2.345M
Double	[0-9]+ ((.[0-9]+) \| [E[+ \| -][0-9]+])d	例1：1E+10d 例2：2.029d 例3：2.0d
Single	[0-9]+.[0-9]+f	2.0f
Guid	[A-Fa-f0-9]	12345678-aaaa-bbbb-cccc-ddddeeeeffff
Int	[-][0-9]+	例1：16 例2：-16
String	'<任意のUTF-8文字>'	'ハローOData'