Developers

リストの検索(Search API)

検索条件に従いアプリに登録されているリストの一覧を取得します 。

リスト一覧はログインユーザに閲覧権限のあるリストのみを取得します。閲覧権限のないリストはnullオブジェクトで返却されます。
システムユーザーの場合、全ユーザーのリストを対象として取得します。

必要な権限

該当アプリ参照

Request

URL

https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/lists/{sheetName}/search

HTTP Method

POST

Parameter

Path Parameter

No.パラメータ必須タイプデフォルト値説明
1tenant○string-会社ID
2sheetName○string-対象アプリ名、リストをサポートしているアプリのみ
リストをサポートするアプリは以下の通り。
No.アプリ名備考
1businesscard名刺
2customer顧客
3businessplan案件
4activity活動
5product商品
6deal取引商品
7taskタスク
8ー拡張アプリ

Request Body

No.プロパティ名必須項目名タイプ備考
1searchCondition検索条件object
- condition検索条件array(object)
-- column検索条件対象アイテムキーstring検索条件項目について
-- operator演算子string使用できる演算子について
-- value検索条件に設定する値string/array(string)検索条件の比較右辺（「in」「like」演算子の場合はリスト形式も許容）
-- connection結合演算子stringOR, AND のいずれかを指定（無指定の場合はAND）
-- conditions結合検索条件array(object)conditionの配列を指定
- keyword検索キーワードstringkeyword検索に使用。conditionと同時に指定した場合はAND検索
keyword検索対象項目について
2orderソート条件object
- itemKey対象アイテムキーstring検索・ソート検索の対象項目について
- sort降順/昇順string"ASC" or "DESC"
3paginationページネーションobjectページング情報
- limit1ページあたりの取得数number1以上・50以下
- pageページ番号number1以上

Example

{
  "searchCondition": {
    "condition": [
      {
        "conditions": [
          {
            "conditions": [
              {
                "conditions": [
                  {
                    "column": "employeeName",
                    "value": "%太郎%",
                    "operator": "like"
                  }
                ]
              },
              {
                "conditions": [
                  {
                    "connection": "or",
                    "column": "departmentName",
                    "value": "%営業%",
                    "operator": "like"
                  }
                ],
                "connection": "or"
              }
            ]
          },
          {
            "column": "participantType",
            "value": 1,
            "operator": "="
          }
        ]
      },
      {
        "column": "listId",
        "value": "%123%",
        "operator": "not like",
        "connection": "and"
      },
      {
        "column": "isAutoUpdate",
        "value": true,
        "operator": "=",
        "connection": "and"
      }
    ],
    "keyword": "案件リスト"
  },
  "order": [
    {
      "itemKey": "systemUpdDate",
      "sort": "asc"
    }
  ],
  "pagination": {
    "limit": 50,
    "page": 1
  }
}

Response

Response Body

No.プロパティ名項目名タイプ備考
1items(最上位)array(object)※閲覧権限のないリストはnullオブジェクトとして返却
2- listIdリストIDnumber
3- listNameリスト名string
4- listAuthoritiesリスト権限array(object)
5-- participantType権限タイプnumber1:オーナー、2:編集者、3:閲覧者
各権限タイプごとにまとめて返却
6-- employee社員array(object)
7--- employeeId社員IDnumber
8--- employeeName社員名string
9-- group共通グループarray(object)
10--- groupId共通グループIDnumber
11--- groupName共通グループ名string
12-- department部署array(object)
13--- departmentId部署IDnumber
14--- departmentName部署名string
15--- isIncludeChildDepartment子部署含むフラグboolean・trueの場合、子部署を権限の対象に含む
・falseの場合、子部署を権限の対象に含まない
16- isUpdating更新中フラグboolean
17- lastSyncDate最終同期日時string"yyyy/MM/dd HH:mm"形式
18- isAutoUpdate自動更新フラグbooleantrueの場合、自動更新の対象
19- isOverwiteAutoUpdate上書き自動更新フラグboolean・trueの場合、リスト更新時にリスト対象から外れたアプリをリストから除去
・falseの場合、リスト更新時にリスト対象から外れたアプリもそのままリスト対象として残り続ける
20- sheetCountTODOnumberリスト内にアプリ対象の数量
21- systemRegDate登録日string"yyyy/MM/dd HH:mm"形式
22- systemRegUser登録ユーザnumber登録者ユーザID
23- systemRegEmployee登録社員number登録者社員ID
24- systemUpdDate更新日string"yyyy/MM/dd HH:mm"形式
25- systemUpdUser最終更新ユーザnumber最終更新者ユーザID
26- systemUpdEmployee最終更新社員number最終更新者社員ID
27metaメタ情報object
28- paginationページング情報object
29-- count検索件数number
30-- currentPageページ番号number
31-- totalCount総件数number
32-- totalPage総ページ数number

Example

{
    "items": [
        null,
        {
            "listId": 1,
            "listName": "案件リスト",
            "listAuthorities": [
                {
                    "participantType": 1,
                    "employee": [
                        {
                            "employeeId": 1,
                            "employeeName": "佐藤 健一"
                        }
                    ]
                },
                {
                    "participantType": 3,
                    "employee": [
                        {
                            "employeeId": 2,
                            "employeeName": "田中 美咲"
                        }
                    ],
                    "group": [
                        {
                            "groupId": 1,
                            "groupName": "マーケティング戦略チーム"
                        }
                    ],
                    "department": [
                        {
                            "departmentId": "2",
                            "departmentName": "営業第一課",
                            "isIncludeChildDepartment": true
                        },
                        {
                            "departmentId": "3",
                            "departmentName": "コンサルティング事業部",
                            "isIncludeChildDepartment": false
                        }
                    ]
                }
            ],
            "isUpdating": false,
            "lastSyncDate": "2025/02/05 01:00",
            "isAutoUpdate": true,
            "isOverwiteAutoUpdate": true,
            "sheetCount": 25,
            "systemRegDate": "2025/02/05 01:00",
            "systemRegUser": 1000,
            "systemRegEmployee": 1,
            "systemUpdDate": "2025/02/05 01:00",
            "systemUpdUser": 1000,
            "systemUpdEmployee": 1
        }
    ],
    "meta": {
        "pagination": {
            "count": 2,
            "currentPage": 1,
            "totalCount": 2,
            "totalPage": 1
        }
    }
}