シートの検索(Search API)
Search APIでは、任意の項目を検索条件として指定し、任意の項目を取得できます。各項目のアイテムキーは、各シートのページをご覧ください。
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/{sheetName}/search
HTTP Method
POST
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | sheetName | ○ | string | - | 対象シート名 |
Request Body
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | searchCondition | 検索条件 | object | ||
| - condition | 検索条件 | array(object) | カラムを指定して検索をする際に使用。keywordと同時に指定した場合はAND検索になる。 | ||
| -- column | 検索条件対象アイテムキー | string | 設定する項目はtargetsへの指定が必須 | ||
| -- operator | 演算子 | string | 使用できる演算子 | ||
| -- value | 検索条件に設定する値 | string/array(string) | 検索条件の比較右辺（「in」「like」演算子の場合の場合リスト形式も許容） | ||
| -- connection | 結合演算子 | string | OR,AND のいずれかで指定。（無指定の場合はAND） | ||
| -- conditions | 結合検索条件 | array(object) | conditionの配列で指定 | ||
| - keyword | 検索キーワード | keyword検索をする際に使用。conditionと同時に指定した場合はAND検索になる。keyword検索対象項目について | |||
| 2 | order | ソート条件 | object | ||
| - itemKey | 対象アイテムキー | string | |||
| - sort | 昇順/降順 | string | "ASC" or "DESC" | ||
| 3 | pagination | ページネーション | object | ||
| - limit | 1ページ当たりの取得数 | integer | 1以上・50以下 | ||
| - page | ページ番号 | integer | 1以上 | ||
| 4 | targets | 検索対象 | array(object) | 検索をする対象の項目 targetsの概念と指定方法 | |
| - relationItemDefKey | 紐づきアイテムキー | string | 紐づき項目のアイテムキー。一階層目の場合はnull | ||
| - targetCols | 検索対象アイテムキー | string | 対象のアイテムキー。relationItemDefKeyがあるときはその中の対象 |
Example
{
"searchCondition": {
"keyword": "ソフトブレーン",
"condition": [
{
"column": "business_cards.business_card.mobile_email",
"operator": "like",
"value": "%@customer%"
},
{
"column": "business_cards.business_card.relational_customer@customers.customer.customer_name",
"operator": "=",
"value": "顧客株式会社",
"connection": "AND"
},
{
"column": "business_cards.business_card.receiver@business_cards.receiver.received_date",
"operator": ">",
"value": "2024-11-11"
},
{
"conditions": [
{
"column": "business_cards.business_card.business_card_full_name",
"operator": "=",
"value": "営業太郎"
},
{
"column": "business_cards.business_card.business_card_full_name",
"operator": "=",
"value": "営業二郎"
}
],
"connection": "OR"
}
]
},
"order": [
{
"itemKey": "business_cards.business_card.department_name",
"sort": "ASC"
}
],
"pagination": {
"limit": 10,
"page": 1
},
"targets": [
{
"relationItemDefKey": null,
"targetCols": [
"business_cards.business_card.id",
"business_cards.business_card.mobile_email",
"business_cards.business_card.business_card_full_name",
"business_cards.business_card.department_name",
"business_cards.business_card.position_name",
"business_cards.business_card.relational_customer",
"business_cards.business_card.receiver"
]
},
{
"relationItemDefKey": "business_cards.business_card.relational_customer",
"targetCols": [
"business_cards.business_card.relational_customer@customers.customer.id",
"business_cards.business_card.relational_customer@customers.customer.customer_name"
]
},
{
"relationItemDefKey": "business_cards.business_card.receiver",
"targetCols": [
"business_cards.business_card.receiver@business_cards.receiver.received_date"
]
}
]
}