Developers

スケジュールの検索(Search API)

検索条件に従いスケジュールの一覧を取得します。
システムユーザーの場合は、スケジュールの公開／非公開設定に関係なく、すべてのスケジュール情報を取得できます。

必要な権限

スケジュール参照

Request

URL

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

HTTP Method

POST

Parameter

Path Parameter

No.パラメータ必須タイプデフォルト値説明
1tenant○string-会社ID

Request Body

No.プロパティ名必須項目名タイプ備考
1searchCondition検索条件object
- condition検索条件array(object)
-- column検索条件対象アイテムキーstring検索条件項目について
-- operator演算子string使用できる演算子について
-- value検索条件に設定する値string/array(string)検索条件の比較右辺（「in」「not in」演算子の場合の場合リスト形式も許容）
-- 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": [
            {
                "column": "schedules.schedule.start_datetime",
                "operator": "=",
                "value": "2025/07/01 9:00"
            },
            {
                "conditions": [
                    {
                        "column": "schedules.schedule.end_datetime",
                        "operator": ">=",
                        "value": "2024/07/01 09:30"
                    },
                    {
                        "column": "schedules.schedule.end_datetime",
                        "operator": "<=",
                        "value": "2025/07/01 12:00"
                    }
                ]
            }
        ],
        "keyword": "営業会議"
    },
    "order": {
        "itemKey": "schedules.schedule.start_datetime",
        "sort": "DESC"
    },
    "pagination": {
        "limit": 10,
        "page": 1
    }
}

Response

Response Body

No.プロパティ名項目名タイプ備考
1items(最上位)array(object)
2- schedules.schedule.schedule_idIDnumber
3- schedules.schedule.subject件名string
4- schedules.schedule.is_all_day終日フラグboolean
5- schedules.schedule.start_datetime開始日時stringis_all_day=trueの場合は、"yyyy/mm/dd"形式。
それ以外は、"yyyy/MM/dd HH:mm"形式
6- schedules.schedule.end_datetime終了日時stringis_all_day=trueの場合は、"yyyy/mm/dd"形式。
それ以外は、"yyyy/MM/dd HH:mm"形式
7- schedules.schedule.interviewer_business_card当日面談者（紐づき名刺）array(object)
8-- schedules.schedule.interviewer_business_card
 @business_cards.business_card.id		名刺IDnumber
9-- schedules.schedule.interviewer_business_car
 d@business_cards.business_card.business_card_name		名刺氏名string
10- schedules.schedule.interviewer_text_business_card当日面談者（テキスト名刺）string
11- schedules.schedule.schedule_member参加者array(object)
12-- attendance_status参加者ステータスstring「参加/欠席/共有/未確認」のいずれか
13-- schedules.schedule_member.relational_employee紐づき社員object
14--- schedules.schedule_member.relational_employee
 @employees.employee.id		社員IDnumber
15--- schedules.schedule_member.relational_employee
 @employees.employee.employee_name		社員氏名string
16- schedules.schedule.address住所object
17-- zipcode郵便番号string
18-- street番地string
19-- building建物string
20- schedules.schedule.memoメモstring
21- schedules.schedule.attachment添付ファイルarray(object)複数添付可能
22-- fileidファイルIDstring
23-- filenameファイル名string
24- schedules.schedule.is_published公開フラグboolean
25- schedules.schedule.is_non_owner_edit本人以外編集可boolean
26- schedules.schedule.schedule_typeスケジュール種別名stringスケジュール種別名
マスタ選択肢の取得方法
27- schedules.schedule.repeat_schedule_id繰り返しスケジュールIDstring繰り返しスケジュール共通で発行されるUUID
28- schedules.schedule.relational_customerリレーショナル紐づき顧客array(object)
29-- schedules.schedule.relational_customer
 @customers.customer.id		顧客IDnumber
30-- schedules.schedule.relational_customer
 @customers.customer.customer_name		顧客名string
31- schedules.schedule.relational_businessplanリレーショナル紐づき案件array(object)
32-- schedules.schedule.relational_businessplan
 @businessplans.businessplan.id		案件IDnumber
33-- schedules.schedule.relational_businessplan
 @businessplans.businessplan.businessplan_name		案件名string
34- facility_asset_reserves予約施設・資産array(object)設備・備品の取得方法
35-- asset.id予約施設・資産番号number
36-- asset_reserve_status.start_date_time予約開始日string"yyyy/MM/dd HH:mm"形式
37-- asset_reserve_status.end_date_time予約終了日string"yyyy/MM/dd HH:mm"形式
38- system_reg_date登録日string"yyyy/MM/dd HH:mm"形式
39- system_reg_user登録ユーザーnumber登録者ユーザーID
40- system_reg_employee登録社員number登録者社員ID
41- system_upd_date更新日string"yyyy/MM/dd HH:mm"形式
42- system_upd_user最終更新ユーザーnumber最終更新社ユーザーID
43- system_upd_employee最終更新社員number最終更新社員ID
44metaメタ情報object
45- paginationページング情報object
46-- count検索件数number
47-- currentPageページ番号number
48-- totalCount総件数number
49-- totalPage総ページ数number

Example

{
    "items": [
        {
            "schedules.schedule.id": 31268617259891,
            "schedules.schedule.subject": "営業会議",
            "schedules.schedule.start_datetime": "2025/05/01 09:30",
            "schedules.schedule.end_datetime": "2025/05/01 11:00",
            "schedules.schedule.interviewer_business_card": [
                {
                    "schedules.schedule.interviewer_business_card@business_cards.business_card.id": 14852199177902,
                    "schedules.schedule.interviewer_business_card@business_cards.business_card.business_card_name": "営業 太郎"
                }
            ],
            "schedules.schedule.interviewer_text_business_card": "営業 次郎",
            "schedules.schedule.address": {
                "street": "東京都中央区銀座6-18-2",
                "zipcode": "03-6779-98",
                "building": "野村不動産銀座ビル 11階"
            },
            "schedules.schedule.memo": "",
            "schedules.schedule.attachment": [
                {
                    "fileid": "6b1be1e8c8c14cf9a7b84948a70b1861",
                    "filename": "営業会議スケジュール.pdf"
                }
            ],
            "schedules.schedule.schedule_type": "外出",
            "schedules.schedule.repeat_schedule_id": "bb2c20e9-a754-45a2-9293-7ab49592a599",
            "schedules.schedule.relational_customer": [
                {
                    "schedules.schedule.relational_customer@customers.customer.id": 14852199177900,
                    "schedules.schedule.relational_customer@customers.customer.customer_name": "井上 拓也"
                }
            ],
            "schedules.schedule.relational_businessplan": [
                {
                    "schedules.schedule.relational_businessplan@businessplans.businessplan.id": 14852199177901,
                    "schedules.schedule.relational_businessplan@businessplans.businessplan.businessplan_name": "営業"
                }
            ],
            "facility_asset_reserves": [
                {
                    "asset.id": 40,
                    "asset_reserve_status.start_date_time": "2025/05/01 09:30",
                    "asset_reserve_status.end_date_time": "2025/05/01 11:00"
                }
            ],
            "schedules.schedule.schedule_member": [
                {
                    "attendance_status": "出席",
                    "schedules.schedule_member.relational_employee": {
                        "schedules.schedule_member.relational_employee@employees.employee.id": 14852199177905,
                        "schedules.schedule_member.relational_employee@employees.employee.employee_name": "田中 真一"
                    }
                },
                {
                    "attendance_status": "出席",
                    "schedules.schedule_member.relational_employee": {
                        "schedules.schedule_member.relational_employee@employees.employee.id": 14852199177906,
                        "schedules.schedule_member.relational_employee@employees.employee.employee_name": "鈴木 剛"
                    }
                }
            ],
            "system_reg_date": "2025/04/01 10:00",
            "system_upd_date": "2025/04/01 14:30",
            "system_reg_user": 100,
            "system_reg_employee": 14852199177906,
            "system_upd_user": 100,
            "system_upd_employee": 14852199177906,
            "schedules.schedule.is_published": true,
            "schedules.schedule.is_non_owner_edit": true,
            "schedules.schedule.is_all_day": false
        },
        {
            "schedules.schedule.id": 31268617259892,
            "schedules.schedule.subject": "社内作業",
            "schedules.schedule.start_datetime": "2025/05/01 09:30",
            "schedules.schedule.end_datetime": "2025/05/01 11:00",
            "schedules.schedule.interviewer_business_card": [],
            "schedules.schedule.interviewer_text_business_card": null,
            "schedules.schedule.address": null,
            "schedules.schedule.memo": "",
            "schedules.schedule.attachment": [],
            "schedules.schedule.schedule_type": "個人作業",
            "schedules.schedule.repeat_schedule_id": "bb2c20e9-a754-45a2-9293-7ab49592a599",
            "schedules.schedule.relational_customer": [],
            "schedules.schedule.relational_businessplan": [],
            "facility_asset_reserves": [],
            "schedules.schedule.schedule_member": [
                {
                    "attendance_status": "出席",
                    "schedules.schedule_member.relational_employee": {
                        "schedules.schedule_member.relational_employee@employees.employee.id": 14852199177905,
                        "schedules.schedule_member.relational_employee@employees.employee.employee_name": "中村 和也"
                    }
                }
            ],
            "system_reg_date": "2025/05/01 09:00",
            "system_upd_date": "2025/05/01 09:30",
            "system_reg_user": 200,
            "system_reg_employee": 14852199177905,
            "system_upd_user": 200,
            "system_upd_employee": 14852199177905,
            "schedules.schedule.is_published": false,
            "schedules.schedule.is_non_owner_edit": true,
            "schedules.schedule.is_all_day": false
        }
    ],
    "meta": {
        "pagination": {
            "count": 2,
            "currentPage": 1,
            "totalCount": 2,
            "totalPage": 1
        }
    }
}