検索項目について
URL APIを利用する際の検索項目ついては以下の通りです。
検索項目名の確認方法は検索項目名の確認方法をご参照ください。
検索オプションを使用する際は検索オプションについてをご参照ください。
各アプリで指定可能な検索項目
顧客アプリ
| No. | 検索項目名 | 項目名 | 検索指定方法 | 複数指定 | 備考 |
|---|---|---|---|---|---|
| 1 | customers.customer.id | 顧客ID | テキスト | ||
| 2 | customers.customer.customer_type | 顧客タイプ | チェックボックス | ||
| 3 | customers.customer.customer_logo | 顧客ロゴ | テキスト | ファイル添付無しの場合、$null=nullを指定すること | |
| 4 | customers.customer.customer_name | 顧客名 | テキスト | ||
| 5 | customers.customer.customer_name_other | 顧客名(かな/その他呼称) | テキスト | ||
| 6 | customers.customer.existing_flg | 存続フラグ | チェックボックス | ||
| 7 | customers.customer.address | 住所 | 住所 | ||
| 8 | customers.customer.tel_no | 電話番号 | テキスト | ||
| 9 | customers.customer.relational_trading_product | 取引商品 | 紐づけ型 | ||
| 10 | customers.customer.relational_parent_customer | 親顧客 | 紐づけ型 | ||
| 11 | customers.customer.url | URL | テキスト | ||
| 12 | customers.customer.memo | メモ | テキスト | ||
| 13 | customers.customer.system_reg_date | 登録日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 14 | customers.customer.system_reg_user | 登録者 | 紐づけ型(社員) | ||
| 15 | customers.customer.system_upd_date | 最終更新日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 16 | customers.customer.system_upd_user | 最終更新者 | 紐づけ型(社員) | ||
| 17 | customers.customer.business_type | 業種 | チェックボックス | ||
| 18 | customers.customer.valid_contact_date | 有効接触日 | 日時 | 絶対時間の場合、年月日、月日のいずれかを指定すること | |
| 19 | customers.customer.charge_employee | 自社担当者 | 自社担当者 | ||
| 20 | customers.customer.charge_department | 自社担当部署 | 自社担当部署 | ||
| 21 | customers.customer.charge_group | 自社担当グループ | 自社担当グループ | ||
| 22 | customers.customer.relational_milestone | マイルストーン・次回タスク | プルダウン | IDは次のように対応する 1:マイルストーン・次回タスクが存在する 2:マイルストーン・次回タスクが存在しない 3:期限切れのマイルストーン・次回タスクが存在する | |
| 23 | customers.customer.relational_schedule | 次回スケジュール | プルダウン | IDは次のように対応する 1:次回スケジュールが存在する 2:次回スケジュールが存在しない | |
| 24 | customers.customer.relational_business_card_info/name | 窓口氏名 | テキスト | オプション使用不可 | |
| 25 | customers.customer.relational_business_card_info/name_kana | 窓口氏名(かな) | テキスト | オプション使用不可 | |
| 26 | customers.customer.relational_business_card_info/position_name | 窓口役職 | テキスト | オプション使用不可 | |
| 27 | customers.customer.relational_business_card_info/email | 窓口email | テキスト | オプション使用不可 |
名刺アプリ
| No. | 検索項目名 | 項目名 | 検索指定方法 | 複数指定 | 備考 |
|---|---|---|---|---|---|
| 1 | business_cards.business_card.id | 名刺ID | テキスト | ||
| 2 | business_cards.business_card.relational_customer | 顧客 | 紐づけ型 | ||
| 3 | business_cards.business_card.business_card_full_name | 名刺氏名 | テキスト | ||
| 4 | business_cards.business_card.business_card_full_name_kana | 名刺氏名(かな) | テキスト | ||
| 5 | business_cards.business_card.department_name | 部署名 | テキスト | ||
| 6 | business_cards.business_card.position_name | 役職名 | テキスト | ||
| 7 | business_cards.business_card.address | 住所 | 住所 | ||
| 8 | business_cards.business_card.tel_no | 電話番号 | テキスト | ||
| 9 | business_cards.business_card.mobile_tel_no | 携帯番号 | テキスト | ||
| 10 | business_cards.business_card.mobile_email | 携帯メールアドレス | テキスト | ||
| 11 | business_cards.business_card.email | メールアドレス | テキスト | ||
| 12 | business_cards.business_card.url | URL | テキスト | ||
| 13 | business_cards.business_card.memo | メモ | テキスト | ||
| 14 | business_cards.business_card.is_enrolled | 在職フラグ | チェックボックス | ||
| 15 | business_cards.business_card.businesscard_image | 名刺画像 | テキスト | ファイル添付無しの場合、$null=nullを指定すること | |
| 16 | business_cards.business_card.system_reg_date | 登録日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 17 | business_cards.business_card.system_reg_user | 登録者 | 紐づけ型(社員) | ||
| 18 | business_cards.business_card.valid_contact_date | 有効接触日 | 日時 | 絶対時間の場合、年月日、月日のいずれかを指定すること | |
| 19 | business_cards.business_card.system_upd_date | 最終更新日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 20 | business_cards.business_card.system_upd_user | 最終更新者 | 紐づけ型(社員) | ||
| 21 | business_cards.business_card.receiver | 受取人 | 紐づけ型(社員) | ||
| 22 | business_cards.business_card.introduction_source | 紹介元 | 紐づけ型 | ||
| 23 | business_cards.business_card.receiver/date | 受取日 | 日時 | 絶対時間の場合、年月日、月日のいずれかを指定すること | |
| 24 | business_cards.business_card.introduction_source/date | 紹介日 | 日時 | 絶対時間の場合、年月日、月日のいずれかを指定すること |
案件アプリ
| No. | 検索項目名 | 項目名 | 検索指定方法 | 複数指定 | 備考 |
|---|---|---|---|---|---|
| 1 | businessplans.businessplan.id | 案件ID | テキスト | ||
| 2 | businessplans.businessplan.relational_customer | 顧客 | 紐づけ型 | ||
| 3 | businessplans.businessplan.businessplan_name_other | 案件名(呼称) | テキスト | ||
| 4 | businessplans.businessplan.businessplan_name | 案件名 | テキスト | ||
| 5 | businessplans.businessplan.business_type_id | 業務タイプ | チェックボックス | ||
| 6 | businessplans.businessplan.relational_trading_product | 取引商品 | 紐づけ型 | ||
| 7 | businessplans.businessplan.progress_id | 進捗状況 | チェックボックス | ||
| 8 | businessplans.businessplan.order_price | 受注(予定)金額 | 数値 | ||
| 9 | businessplans.businessplan.address | 住所 | 住所 | ||
| 10 | businessplans.businessplan.memo | メモ | テキスト | ||
| 11 | businessplans.businessplan.system_reg_date | 登録日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 12 | businessplans.businessplan.system_reg_user | 登録者 | 紐づけ型(社員) | ||
| 13 | businessplans.businessplan.valid_contact_period | 有効接触日 | 日時 | 絶対時間の場合、年月日、月日のいずれかを指定すること | |
| 14 | businessplans.businessplan.system_upd_date | 最終更新日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 15 | businessplans.businessplan.system_upd_user | 最終更新者 | 紐づけ型(社員) | ||
| 16 | businessplans.businessplan.charge_employee | 自社担当者 | 自社担当者 | ||
| 17 | businessplans.businessplan.charge_group | 自社担当グループ | 自社担当グループ | ||
| 18 | businessplans.businessplan.charge_department | 自社担当部署 | 自社担当部署 | ||
| 19 | businessplans.businessplan.continue_or_terminate_flg | 継続/終了 | チェックボックス | ||
| 20 | businessplans.businessplan.relational_schedule | 次回スケジュール | プルダウン | IDは次のように対応する 1:次回スケジュールが存在する 2:次回スケジュールが存在しない | |
| 21 | businessplans.businessplan.relational_milestone | マイルストーン・次回タスク | プルダウン | IDは次のように対応する 1:マイルストーン・次回タスクが存在する 2:マイルストーン・次回タスクが存在しない 3:期限切れのマイルストーン・次回タスクが存在する | |
| 22 | businessplans.businessplan.relational_business_card_info/name | 窓口氏名 | テキスト | オプション使用不可 | |
| 23 | businessplans.businessplan.relational_business_card_info/name_kana | 窓口氏名(かな) | テキスト | オプション使用不可 | |
| 24 | businessplans.businessplan.relational_business_card_info/position_name | 窓口役職 | テキスト | オプション使用不可 | |
| 25 | businessplans.businessplan.relational_business_card_info/email | 窓口email | テキスト | オプション使用不可 |
取引アプリ
| No. | 検索項目名 | 項目名 | 検索指定方法 | 複数指定 | 備考 |
|---|---|---|---|---|---|
| 1 | deals.deal.id | 取引ID | テキスト | ||
| 2 | deals.deal.relational_customer | 顧客 | 紐づけ型 | ||
| 3 | deals.deal.relational_businessplan | 案件 | 紐づけ型 | ||
| 4 | deals.deal.relational_product | 商品名 | 紐づけ型 | ||
| 5 | deals.deal.memo | メモ | テキスト | ||
| 6 | deals.deal.continue_or_terminate_flg | 継続/終了 | チェックボックス | ||
| 7 | deals.deal.business_type | 業務タイプ | チェックボックス | ||
| 8 | deals.deal.unit_price | 金額(単価) | 数値 | ||
| 9 | deals.deal.amount | 数量 | 数値 | ||
| 10 | deals.deal.order_price | 受注(予定)金額 | 数値 | ||
| 11 | deals.deal.progress | 進捗状況 | チェックボックス | ||
| 12 | deals.deal.charge_employee | 自社担当者 | 自社担当者 | ||
| 13 | deals.deal.charge_department | 自社担当部署 | 自社担当部署 | ||
| 14 | deals.deal.charge_group | 自社担当グループ | 自社担当グループ | ||
| 15 | deals.deal.last_contact_date | 有効接触日 | 日時 | 絶対時間の場合、年月日、月日のいずれかを指定すること | |
| 16 | deals.deal.system_reg_date | 登録日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 17 | deals.deal.system_reg_user | 登録者 | 紐づけ型(社員) | ||
| 18 | deals.deal.system_upd_date | 最終更新日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 19 | deals.deal.system_upd_user | 最終更新者 | 紐づけ型(社員) |
活動アプリ
| No. | 検索項目名 | 項目名 | 検索指定方法 | 複数指定 | 備考 |
|---|---|---|---|---|---|
| 1 | activities.activity.id | 活動ID | テキスト | ||
| 2 | activities.activity.relational_customer | 顧客 | 紐づけ型 | ||
| 3 | activities.activity.relational_businessplan | 案件 | 紐づけ型 | ||
| 4 | activities.activity.relational_trading_product | 取引 | 紐づけ型 | ||
| 5 | activities.activity.memo | メモ | テキスト | ||
| 6 | activities.activity.business_type | 業務タイプ | チェックボックス | ||
| 7 | activities.activity.action_id | 活動内容 | チェックボックス | ||
| 8 | activities.activity.visit_start_datetime | 活動時間(開始) | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 9 | activities.activity.visit_end_datetime | 活動時間(終了) | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 10 | activities.activity.action_time | 活動時間(分) | 数値 | ||
| 11 | activities.activity.next_task_date | 次回タスク | 日時 | 絶対時間の場合、年月日、月日のいずれかを指定すること | |
| 12 | activities.activity.next_schedule_date | 次回スケジュール | 日時 | 絶対時間の場合、年月日、月日のいずれかを指定すること | |
| 13 | activities.activity.interviewer | 当日面談者 | テキスト | or,andは使用不可 | |
| 14 | activities.activity.target_employee | 報告者 | 紐づけ型(社員) | ||
| 15 | activities.activity.system_reg_date | 登録日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 16 | activities.activity.system_reg_user | 登録者 | 紐づけ型(社員) | ||
| 17 | activities.activity.system_upd_date | 最終更新日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 18 | activities.activity.system_upd_user | 最終更新者 | 紐づけ型(社員) |
社員アプリ
| No. | 検索項目名 | 項目名 | 検索指定方法 | 複数指定 | 備考 |
|---|---|---|---|---|---|
| 1 | employees.employee.id | 社員ID | テキスト | ||
| 2 | employees.employee.employee_name | 社員氏名 | テキスト | ||
| 3 | employees.employee.name_kana | 社員氏名(かな) | テキスト | ||
| 4 | employees.employee.relational_department | 部署名 | 紐づけ型(社員) | 以下の指定方法は使用不可 ・commonGroup-{id} ・myGroup-{id} ・myself | |
| 5 | employees.employee.position_master_id | 役職名 | チェックボックス | ||
| 6 | employees.employee.charge_work/main | 主担当業務 | チェックボックス | ||
| 7 | employees.employee.charge_work | 他の担当業務 | チェックボックス | ||
| 8 | employees.employee.memo | メモ | テキスト | ||
| 9 | employees.employee.address | 住所 | 住所 | ||
| 10 | employees.employee.tel_no | 電話番号 | テキスト | ||
| 11 | employees.employee.mobile_tel_no | 携帯番号 | テキスト | ||
| 12 | employees.employee.relational_manager | マネージャー | 紐づけ型(社員) | ||
| 13 | employees.employee.email | ユーザーID(メールアドレス) | テキスト | ||
| 14 | employees.employee.employee_icon | 写真 | テキスト | ファイル添付無しの場合、$null=nullを指定すること | |
| 15 | employees.employee.system_reg_date | 登録日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 16 | employees.employee.system_reg_user | 登録者 | 紐づけ型(社員) | ||
| 17 | employees.employee.system_upd_date | 最終更新日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 18 | employees.employee.system_upd_user | 最終更新者 | 紐づけ型(社員) |
商品アプリ
| No. | 検索項目名 | 項目名 | 検索指定方法 | 複数指定 | 備考 |
|---|---|---|---|---|---|
| 1 | products.product.id | 商品ID | テキスト | ||
| 2 | products.product.product_category_id | 所属カテゴリ | 商品カテゴリ | ||
| 3 | products.product.product_name | 商品名 | テキスト | ||
| 4 | products.product.product_name_designation | 商品名(呼称) | テキスト | ||
| 5 | products.product.available_flg | 使用可否 | チェックボックス | ||
| 6 | products.product.product_picture | 商品画像 | テキスト | ファイル添付無しの場合、$null=nullを指定すること | |
| 7 | products.product.memo | メモ | テキスト | ||
| 8 | products.product.unit_price | 単価 | 数値 | ||
| 9 | products.product.system_reg_date | 登録日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 10 | products.product.system_reg_user | 登録者 | 紐づけ型(社員) | ||
| 11 | products.product.system_upd_date | 最終更新日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 12 | products.product.system_upd_user | 最終更新者 | 紐づけ型(社員) |
タスクアプリ
| No. | 検索項目名 | 項目名 | 検索指定方法 | 複数指定 | 備考 |
|---|---|---|---|---|---|
| 1 | tasks.task.id | タスクID | テキスト | ||
| 2 | tasks.task.expected_completion_date | 完了(予定)日 | 日時 | 絶対時間の場合、年月日、月日のいずれかを指定すること | |
| 3 | tasks.task.relational_milestone | マイルストーン | テキスト | ||
| 4 | tasks.task.relational_customer | 顧客 | 紐づけ型 | ||
| 5 | tasks.task.relational_businessplan | 案件 | 紐づけ型 | ||
| 6 | tasks.task.task_name | タスク名 | テキスト | ||
| 7 | tasks.task.priority_id | 優先度 | チェックボックス | ||
| 8 | tasks.task.address | 住所 | 住所 | ||
| 9 | tasks.task.relational_employee | 担当者 | 紐づけ型(社員) | ||
| 10 | tasks.task.outside_manager | 社外担当者 | テキスト | or,andは使用不可 | |
| 11 | tasks.task.status_id | ステータス | チェックボックス | IDは次のように対応する 1:未着手 2:対応中 3:処理済 4:完了 | |
| 13 | tasks.task.memo | メモ | テキスト | ||
| 14 | tasks.task.attached_file | ファイル | テキスト | ファイル添付無しの場合、$null=nullを指定すること | |
| 15 | tasks.task.publishing_setting | 公開設定 | チェックボックス | IDは次のように対応する 1:公開 2:非公開 | |
| 16 | tasks.task.is_editable | 他ユーザーが変更/削除 | チェックボックス | IDは次のように対応する 1:可 2:不可 | |
| 17 | tasks.task.system_reg_date | 登録日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 18 | tasks.task.system_reg_user | 登録者 | 紐づけ型(社員) | ||
| 19 | tasks.task.system_upd_date | 最終更新日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 20 | tasks.task.system_upd_user | 最終更新者 | 紐づけ型(社員) |
拡張アプリ
sheetNameは以下のページの「拡張アプリ(appextender)のsheetNameの取得方法」にて確認可能です。
sheetNameの確認方法
| No. | 検索項目名 | 項目名 | 検索指定方法 | 複数指定 | 備考 |
|---|---|---|---|---|---|
| 1 | appextender.{sheetName}.id | 拡張アプリID | テキスト | ||
| 2 | appextender.{sheetName}.name_kana | 名前(かな) | テキスト | ||
| 3 | appextender.{sheetName}.name | 名前 | テキスト | ||
| 4 | appextender.{sheetName}.memo | メモ | テキスト | ||
| 5 | appextender.{sheetName}.system_reg_date | 登録日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 6 | appextender.{sheetName}.system_reg_user | 登録者 | 紐づけ型(社員) | ||
| 7 | appextender.{sheetName}.system_upd_date | 最終更新日 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 8 | appextender.{sheetName}.system_upd_user | 最終更新者 | 紐づけ型(社員) |
追加項目
拡張アプリと、各アプリの追加項目の検索項目は以下のページの「拡張項目のitem_idを確認する方法」にて確認可能です。
拡張アプリと、各アプリの追加項目の検索項目の確認方法
| No. | 項目型 | 検索指定方法 | 複数指定 | 備考 |
|---|---|---|---|---|
| 1 | プルダウン | チェックボックス | ||
| 2 | ラジオボタン | チェックボックス | ||
| 3 | チェックボックス | チェックボックス | ||
| 4 | 数値 | 数値 | ||
| 5 | 日付 | 日時 | 絶対時間の場合、年月日、月日のいずれかを指定すること | |
| 6 | 時間 | 日時 | 絶対時間の場合、時間のみ使用可能 | |
| 7 | 日時 | 日時 | 絶対時間の場合、日時、年月日、月日のいずれかを指定すること | |
| 8 | テキスト | テキスト | ||
| 9 | テキスト(複数行) | テキスト | ||
| 10 | ファイル | テキスト | ファイル添付無しの場合、$null=nullを指定すること | |
| 11 | リンク | テキスト | ||
| 12 | 電話番号 | テキスト | ||
| 13 | 住所 | 住所 | ||
| 14 | メールアドレス | テキスト | ||
| 15 | 演算(文字) | テキスト | ||
| 16 | 演算(数値) | 数値 | ||
| 17 | 紐づけ項目 | 紐づけ型 | 紐づけ先が社員アプリの場合、検索指定方法が紐づけ型(社員) |