サポートされている OData 関数と句

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

この記事では、Analytics が複数の OData 関数をサポートする方法について説明します。 サポートされていない関数も一覧表示されます。 OData (Open Data Protocol) は、REST API を構築および使用するためのベスト プラクティスを定義する ISO/IEC 承認済みの OASIS 標準です。 詳細については、 OData のドキュメントを参照してください。

注意

Analytics サービスは、すべてのAzure DevOps Servicesの運用環境で自動的に有効になり、サポートされます。 Power BI 統合 と Analytics Service の OData フィード へのアクセスが一般提供されています。 これを使用し、フィードバックをお寄せください。 使用可能なデータはバージョンによって異なります。 サポートされている最新バージョンは で v2.0、最新のプレビュー バージョンは です v4.0-preview。 詳細については、「 OData API のバージョン管理」を参照してください。

サポートされる句

• $apply
• $compute
• $count
• $expand
• $filter
• $orderby
• $select
• $skip
• $top

クエリで複数の句が使用されている場合は、上で指定した順序で適用されます。 クエリ文字列内の句の順序は無視されます。 たとえば、次のクエリでは、作業項目は最初にグループ化されて集計されます。 次に、グループがフィルター処理されます。 その後、フィルター処理されたグループが並べ替えられます。 最後に、最初の 5 つのレコードが返されます。 クエリは、少なくとも 100 回使用された上位 5 種類の作業項目の種類を返します。

WorkItems?$filter=Count ge 100&$apply=groupby((WorkItemType), aggregate($count as Count))&$orderby=Count&top=5

集計拡張機能のサポート

連続して適用されることを表すために、スラッシュで区切られた一連のセット変換が必要です。 各変換の結果は、次の変換への入力です。 たとえば、次のクエリでは、作業項目がフィルター処理され、作業項目の種類と状態によってグループ化されます。 次に、グループが再びフィルター処理され、グループ化されます。

注意

OData 集計拡張機能は比較的新しく、一部のクライアント ツールではまだ完全にはサポートされていません。

Workitems?$apply=filter(State ne 'Closed')/groupby((WorkItemType, State), aggregate($count as Count))/filter(Count gt 100)/groupby((State),aggregate(Count with max as MaxCount))  

次の変換がサポートされています。

変換	Notes
aggregate	、、 のいずれかのメソッドを$countaveragemaxmin使用して集計を許可しますsum
compute	計算プロパティを追加できます
expand	指定したプロパティによる拡張を許可します
filter	フィルター入力セットを許可します。 と同じ式をサポートします $filter
groupby	プロパティによるグループ化を許可します

詳細については、「 作業追跡データの集計」を参照してください。

サポートされる関数

正規関数	説明
cast	指定した型にキャストされた現在のインスタンスの式を返します。
contains	2 番目のパラメーター文字列値が最初のパラメーター文字列値の部分文字列である場合は true を返し、それ以外の場合は false を返します。
endswith	最初のパラメーター文字列値が 2 番目のパラメーター文字列値で終わる場合は true を返し、それ以外の場合は false を返します。
startswith	最初のパラメーター文字列値が 2 番目のパラメーター文字列値で始まる場合は true を返し、それ以外の場合は false を返します。
length	パラメーター値の文字数を返します。
indexof	最初のパラメーター値で 2 番目のパラメーター値が最初に出現した位置の 0 から始まる文字位置を返します。2 番目のパラメーター値が最初のパラメーター値で発生しない場合は -1 を返します。
substring	最初のパラメーター文字列値の部分文字列を返します。N 番目の文字から始まり、最後の文字 (N は 2 番目のパラメーター整数値) で終了します。
tolower	すべての大文字が小文字に変換された入力パラメーター文字列値を返します。
toupper	すべての小文字が大文字に変換された入力パラメーター文字列値を返します。
trim	先頭と末尾のすべての空白文字を含む入力パラメーター文字列値を返します。
year	Date または DateTimeOffset パラメーター値の年コンポーネントを返します。
month	Date または DateTimeOffset パラメーター値の月コンポーネントを返します。
day	Date または DateTimeOffset パラメーター値の日のコンポーネントを返します。
date	DateTimeOffset パラメーター値の日付部分を返します。
time	DateTimeOffset パラメーター値の時刻部分を返します。
totaloffsetminutes	DateTimeOffset パラメーター値のタイム ゾーン オフセット部分の符号付き分数を返します。
now	DateTimeOffset 値として現在の時点 (タイム ゾーンを含む日付と時刻) を返します。
maxdatetime	DateTimeOffset 値として、可能な最新の時点を返します。
mindatetime	DateTimeOffset 値として最も早い時点を返します。

OData 関数は 句で $filter 使用されますが、SQL ステートメントで $select 使用される方法の句では使用されません。

たとえば、次の条件を指定できます。

/WorkItems?$filter=toupper(Title) eq 'HELP' 

ただし、次の文字列を入力することはできません。

/WorkItems?$select=WorkItemId,State,toupper(Title)

サポートされていない機能

• bottomcount
• bottomsum
• bottompercent
• $crossjoin
• concat
• countdistinct
• from
• isdefined
• $rollup
• $search
• topcount
• topsum
• toppercent

関連記事

• 作業追跡データのクエリを実行する
• データの集計
• OData v4.0 仕様
• OData v4.0 パート 2: URL 規則と Errata 02
• OData v4.0 集計拡張機能