フローサービス API での応答の並べ替えとフィルタリング

リスト (GET) リクエストを フローサービス APIに値を入力する場合は、クエリーパラメーターを使用して応答を並べ替えたり、フィルター処理したりできます。 このガイドでは、様々な使用例でこれらのパラメーターを使用する方法について説明します。

並べ替え

回答は、 orderby クエリパラメーター。 API では、次のリソースを並べ替えることができます。

• 接続
• ソース接続
• ターゲット接続
• 流れ
• 実行

パラメーターを使用するには、並べ替えの基準となる特定のプロパティにその値を設定する必要があります ( 例： ?orderby=name) をクリックします。 値の前にプラス記号 (+) を使用します。-) を降順に表示します。 並べ替えプレフィックスが指定されない場合、リストはデフォルトで昇順で並べ替えられます。

GET /flows?orderby=name
GET /flows?orderby=-name

並べ替えパラメーターとフィルタリングパラメーターを組み合わせるには、「and」記号 (&) をクリックします。

GET /flows?property=state==enabled&orderby=createdAt

フィルター

回答は、 property パラメーターにキーと値の式を含める必要があります。 例： ?property=id==12345 が返すリソースのみが id プロパティが完全に等しい 12345.

フィルタリングは、そのプロパティの有効なパスがわかっている限り、エンティティ内の任意のプロパティに一般的に適用できます。

ソース・テーブル名が次の値であるすべてのソース接続を返す lead:

GET /sourceConnections?property=params.tableName==lead

特定のセグメント ID のすべてのフローを返す：

GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a

フィルターの組み合わせ

複数 property フィルターは、「および」文字 (&) をクリックします。 フィルターを組み合わせる際には AND 関係が想定されます。つまり、応答に含めるには、エンティティがすべてのフィルターを満たす必要があります。

セグメント ID の有効なフローをすべて返す：

GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a&property=state==enabled

配列プロパティのフィルタリング

配列内の項目のプロパティに基づいてフィルタリングするには、次を追加します。 [] を配列プロパティの名前に追加します。

特定のソース接続に関連付けられたフローを返す：

GET /flows?property=sourceConnectionIds[]==9874984,6980696

特定のセレクター値 ID を含む変換を持つ戻りフローを返します。

GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a

特定の name 値：

GET /sourceConnections?property=params.columns[].name==firstName

セグメント ID でフィルタリングして、宛先のフロー実行 ID を検索します。

GET /runs?property=metrics.recordSummary.targetSummaries[].entitySummaries[].id==segment:068d6e2c-b546-4c73-bfb7-9a9d33375659

count

任意のフィルタークエリを count 値がのクエリパラメーター true 結果の数を返します。 API 応答には count プロパティの値は、フィルターされた項目の合計数を表します。 この呼び出しでは、実際にフィルターされた項目は返されません。

システム内の有効なフローの数を返します。

GET /flows?property=state==enabled&count=true

上記のクエリへの応答は、次のようになります。

{
  "count": 95
}

リソース別のフィルタリング可能なプロパティ

取得するフローサービスエンティティに応じて、様々なプロパティを使用してフィルタリングをおこなうことができます。 以下の表では、使用例のフィルタリングで一般的に使用される各リソースのルートレベルのフィールドを分類します。

connectionSpec

flowSpec

connection

sourceConnection

targetConnection

flow

run

次の手順

このガイドでは、 orderby および property フローサービス API で応答を並べ替えたり、フィルタリングしたりするクエリパラメーター。 Platform の一般的なワークフローで API を使用する手順に関するガイドについては、 ソース および 宛先 ドキュメント。

Business.Adobe.com リソース