スケジュール(schedule)
スケジュールに関する情報の登録・更新・取得・削除ができます。
スケジュール取得
必要な権限
スケジュール参照
Request
URL
https://gateway-esm.softbrain.com/calendar-fs/{tenant}/pub/esms/v1/schedule/{id}
HTTP Method
GET
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | id | ○ | string | - | 対象レコードID |
Response
| No. | プロパティ名 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|
| 1 | schedules.schedule.schedule_id | スケジュールID | number | |
| 2 | schedules.schedule.subject | 件名 | string | |
| 3 | schedules.schedule.is_all_day | 終日フラグ | boolean | |
| 4 | schedules.schedule.start_datetime | 開始日時 | string | is_all_day=trueの場合は、"yyyy/mm/dd"形式。 それ以外は、"yyyy/mm/dd hh:MM"形式 |
| 5 | schedules.schedule.end_datetime | 終了日時 | string | is_all_day=trueの場合は、"yyyy/mm/dd"形式。 それ以外は、"yyyy/mm/dd hh:MM"形式 |
| 6 | schedules.schedule.interviewer_business_card | 当日面談者 (紐づき名刺) | array(number) | |
| 7 | schedules.schedule.interviewer_text_business_card | 当日面談者 (テキスト名刺) | string | |
| 8 | schedules.schedule.schedule_member | 参加者 | array(object) | |
| - attendance_status | 参加者ステータス | string | 「出席/欠席/共有/未確認」のいずれか | |
| - relational_employee | 紐づき社員 | number | ||
| 9 | schedules.schedule.address | 住所 | object | |
| - zipcode | 郵便番号 | string | ||
| - country | 国 | string | ||
| - street | 番地 | string | ||
| - building | 建物 | string | ||
| 10 | schedules.schedule.memo | メモ | string | |
| 11 | schedules.schedule.attachment | 添付ファイル | array(object) | 複数添付可能 |
| - fileid | ファイルID | string | ||
| - filename | ファイル名 | string | ||
| 12 | schedules.schedule.is_published | 公開フラグ | boolean | |
| 13 | schedules.schedule.is_non_owner_edit | 本人以外編集可 | boolean | |
| 14 | schedules.schedule.schedule_type | スケジュール種別名 | string | スケジュール種別マスタの選択肢名。。マスタの選択肢取得方法 |
| 15 | schedules.schedule.repeat_schedule_id | 繰り返しスケジュールID | string | 繰り返しスケジュール共通で発行されるUUID |
| 16 | schedules.schedule.relational_customer | 紐づき顧客 | array(number) | |
| 17 | schedules.schedule.relational_businessplan | 紐づき案件 | array(number) | |
| 18 | facility_asset_reserves | 予約施設・資産 | array(object) | 設備・備品の取得方法 |
| - asset.id | 施設・資産ID | number | ||
| - asset_reserve_status.start_date_time | 予約開始日 | string | "yyyy/mm/dd hh:MM"形式 | |
| - asset_reserve_status.end_date_time | 予約終了日 | string | "yyyy/mm/dd hh:MM"形式 | |
| 19 | system_reg_date | 登録日 | string | "yyyy/mm/dd hh:MM"形式 |
| 20 | system_reg_user | 登録ユーザ | number | 登録者ユーザID |
| 21 | system_reg_employee | 登録社員 | number | 登録社員ID |
| 22 | system_upd_date | 更新日 | string | "yyyy/mm/dd hh:MM"形式 |
| 23 | system_upd_user | 最終更新ユーザ | number | 最終更新者ユーザID |
| 24 | system_upd_employee | 最終更新社員 | number | 最終更新者社員ID |
| 25 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のページを参照する |
Example
{
"schedules.schedule.id": 123,
"schedules.schedule.subject": "外出",
"schedules.schedule.is_all_day": false,
"schedules.schedule.start_datetime": "2025/01/28 09:00",
"schedules.schedule.end_datetime": "2025/01/28 09:30",
"schedules.schedule.interviewer_business_card": [
123
],
"schedules.schedule.interviewer_text_business_card": "営業太郎",
"schedules.schedule.schedule_member": [
{
"attendance_status": "出席",
"relational_employee": 123
}
],
"schedules.schedule.address": {
"street": "東京都中央区銀座6-18-2",
"country": "JPN",
"zipcode": "03-6779-98",
"building": "野村不動産銀座ビル 11階"
},
"schedules.schedule.memo": "メモ",
"schedules.schedule.attachment": [
{
"fileid": "6b1be1e8c8c14cf9a7b84948a70b1861"
}
],
"schedules.schedule.is_published": true,
"schedules.schedule.is_non_owner_edit": true,
"schedules.schedule.schedule_type": "外出",
"schedules.schedule.repeat_condition": {
"repeat_type": 1,
"repeat_interval": 2,
"repeat_end_condition": {
"repeat_count": 3
}
},
"schedules.schedule.relational_customer": [
123
],
"schedules.schedule.relational_businessplan": [
123
],
"facility_asset_reserves": [
{
"asset.id": "123",
"asset_reserve_status.start_date_time": "2025/01/28 09:00",
"asset_reserve_status.end_date_time": "2025/01/28 09:30"
}
]
}
スケジュール登録
必要な権限
スケジュール登録
Request
URL
https://gateway-esm.softbrain.com/calendar-fs/{tenant}/pub/esms/v1/schedule
HTTP Method
POST
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
Request Body
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | schedules.schedule.subject | 件名 | string | ||
| 2 | schedules.schedule.is_all_day | 終日フラグ | boolean | ||
| 3 | schedules.schedule.start_datetime | 開始日時 | string | is_all_day=trueの場合は、"yyyy/mm/dd"形式。 それ以外は、"yyyy/mm/dd hh:MM"形式 | |
| 4 | schedules.schedule.end_datetime | 終了日時 | string | is_all_day=trueの場合は、"yyyy/mm/dd"形式。 それ以外は、"yyyy/mm/dd hh:MM"形式 | |
| 5 | schedules.schedule.interviewer_business_card | ※ | 当日面談者 (紐づき名刺) | array(number) | テキスト名刺に値を設定する場合は、項目自体不要 |
| 6 | schedules.schedule.interviewer_text_business_card | ※ | 当日面談者 (テキスト名刺) | string | 紐づき名刺に値を設定する場合は、項目自体不要 |
| 7 | schedules.schedule.schedule_member | 参加者 | array(object) | ||
| - attendance_status | 参加者ステータス | string | 「出席/欠席/共有/未確認」のいずれかを指定 | ||
| - relational_employee | 紐づき社員 | number | |||
| 8 | schedules.schedule.address | 住所 | object | ||
| - zipcode | 郵便番号 | string | |||
| - country | 国 | string | |||
| - street | 番地 | string | |||
| - building | 建物 | string | |||
| 9 | schedules.schedule.memo | メモ | string | ||
| 10 | schedules.schedule.attachment | 添付ファイル | array(object) | 複数添付可能 | |
| - fileid | ファイルID | string | |||
| 11 | schedules.schedule.is_published | 公開フラグ | boolean | ||
| 12 | schedules.schedule.is_non_owner_edit | 本人以外編集可 | boolean | ||
| 13 | schedules.schedule.schedule_type | スケジュール種別名 | string | スケジュール種別名を指定 | |
| 14 | schedules.schedule.repeat_condition | 繰り返し条件 | object | 繰り返し条件。一度に50件以上のスケジュールを登録することはできない。 | |
| - repeat_type | 繰り返し種別 | number | 1:日ごと、2:週ごと、3:月ごと、4:年ごと | ||
| - repeat_interval | 繰り返し間隔 | number | 繰り返し種別が日、週、月、年の場合に指定 | ||
| - repeat_end_condition | 繰り返し終了条件 | object | 「繰り返し終了日」か「繰り返し終了回数」のどちらを指定したいかで、必要な項目が変化する。 | ||
| -- repeat_end_date | ※ | 繰り返し終了日 | string | 繰り返し終了条件を終了日で指定。 「繰り返し終了日」と「繰り返し終了回数」のどちらかのみ。"yyyy/mm/dd"形式。 | |
| -- repeat_count | ※ | 繰り返し回数 | number | 繰り返し終了条件を繰り返し回数で指定。 「繰り返し終了日」と「繰り返し終了回数」のどちらかのみ。 | |
| - repeat_option | ※ | 繰り返し条件オプション | object | 繰り返し種別が[2:週ごと、3:月ごと] の場合に指定。 | |
| -- week_repeat_day | ※ | 対象曜日 | array(number) | 繰り返し種別が[2:週ごと] の場合のみ有効（必須）。一つ以上を選択。 1:日、 2:月、 3:火、 4:水、 5:木、 6:金、 7:土 | |
| -- month_repeat_pattern | ※ | 月繰り返し種別 | number | 繰り返し種別が[3:月ごと] の場合のみ有効（必須）。1:固定日、 2:固定週、 3:月の末日 | |
| -- month_repeat_day | ※ | 固定日 | number | 繰り返し種別が[3:月ごと]、かつ月繰り返し種別が[1:固定日] の場合のみ有効（必須）。 | |
| -- month_repeat_week | ※ | 固定週 | number | 繰り返し種別が[3:月ごと]、かつ月繰り返し種別が[2:固定週] の場合のみ有効（必須）。 1:第１、 2:第２、 3:第３、 4:第４、 5:第５ | |
| -- month_repeat_week_day | ※ | 固定曜日 | number | 繰り返し種別が[3:月ごと]、かつ月繰り返し種別が[2:固定週] の場合のみ有効（必須）。 1:日、 2:月、 3:火、 4:水、 5:木、 6:金、 7:土 | |
| 15 | schedules.schedule.relational_customer | 紐づき顧客 | array(number) | ||
| 16 | schedules.schedule.relational_businessplan | 紐づき案件 | array(number) | ||
| 17 | facility_asset_reserves | 予約施設・資産 | array(object) | 設備・備品の取得方法 | |
| - asset.id | ※ | 施設・資産ID | number | ||
| - asset_reserve_status.start_date_time | ※ | 予約開始日 | string | "yyyy/mm/dd hh:MM"形式 | |
| - asset_reserve_status.end_date_time | ※ | 予約終了日 | string | "yyyy/mm/dd hh:MM"形式 | |
| is_skip_asset_reserve_error | 施設予約エラースキップフラグ | boolean | facility_asset_reservesが設定されている場合のみ意味を持つ項目。 Trueの場合に、施設予約の重複エラーが発生した場合、システムは予約情報を設定せずにスケジュール登録を行うようにする。 Falseの場合はそのまま施設予約の重複エラーを返却する。 |
Example
{
"schedules.schedule.subject": "外出",
"schedules.schedule.is_all_day": false,
"schedules.schedule.start_datetime": "2025/01/28 09:00",
"schedules.schedule.end_datetime": "2025/01/28 09:30",
"schedules.schedule.interviewer_business_card": [
123
],
"schedules.schedule.interviewer_text_business_card": "営業太郎",
"schedules.schedule.schedule_member": [
{
"attendance_status": "出席",
"relational_employee": 123
}
],
"schedules.schedule.address": {
"street": "東京都中央区銀座6-18-2",
"country": "JPN",
"zipcode": "03-6779-98",
"building": "野村不動産銀座ビル 11階"
},
"schedules.schedule.memo": "メモ",
"schedules.schedule.attachment": [
{
"fileid": "6b1be1e8c8c14cf9a7b84948a70b1861"
}
],
"schedules.schedule.is_published": true,
"schedules.schedule.is_non_owner_edit": true,
"schedules.schedule.schedule_type": "外出",
"schedules.schedule.repeat_condition": {
"repeat_type": 1,
"repeat_interval": 2,
"repeat_end_condition": {
"repeat_count": 3
}
},
"schedules.schedule.relational_customer": [
123
],
"schedules.schedule.relational_businessplan": [
123
],
"facility_asset_reserves": [
{
"asset.id": "123",
"asset_reserve_status.start_date_time": "2025/01/28 09:00",
"asset_reserve_status.end_date_time": "2025/01/28 09:30"
}
]
}
Response
リクエスト時に繰り返しスケジュールを登録した場合、それによって登録されたスケジュールがすべて返却されます。
Example
{
"schedules.schedule.id": 123,
"schedules.schedule.subject": "外出",
"schedules.schedule.is_all_day": false,
"schedules.schedule.start_datetime": "2025/01/28 09:00",
"schedules.schedule.end_datetime": "2025/01/28 09:30",
"schedules.schedule.interviewer_business_card": [
123
],
"schedules.schedule.interviewer_text_business_card": "営業太郎",
"schedules.schedule.schedule_member": [
{
"attendance_status": "出席",
"relational_employee": 123
}
],
"schedules.schedule.address": {
"street": "東京都中央区銀座6-18-2",
"country": "JPN",
"zipcode": "03-6779-98",
"building": "野村不動産銀座ビル 11階"
},
"schedules.schedule.memo": "メモ",
"schedules.schedule.attachment": [
{
"fileid": "6b1be1e8c8c14cf9a7b84948a70b1861"
}
],
"schedules.schedule.is_published": true,
"schedules.schedule.is_non_owner_edit": true,
"schedules.schedule.schedule_type": "外出",
"schedules.schedule.repeat_condition": {
"repeat_type": 1,
"repeat_interval": 2,
"repeat_end_condition": {
"repeat_count": 3
}
},
"schedules.schedule.relational_customer": [
123
],
"schedules.schedule.relational_businessplan": [
123
],
"facility_asset_reserves": [
{
"asset.id": "123",
"asset_reserve_status.start_date_time": "2025/01/28 09:00",
"asset_reserve_status.end_date_time": "2025/01/28 09:30"
}
]
}
スケジュール更新
必要な権限
スケジュール変更
Request
URL
https://gateway-esm.softbrain.com/calendar-fs/{tenant}/pub/esms/v1/schedule/{id}
HTTP Method
PUT
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | id | ○ | string | - | 対象レコードID |
Request Body
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | schedules.schedule.subject | 件名 | string | ||
| 2 | schedules.schedule.is_all_day | 終日フラグ | boolean | ||
| 3 | schedules.schedule.start_datetime | 開始日時 | string | is_all_day=trueの場合は、"yyyy/mm/dd"形式。 それ以外は、"yyyy/mm/dd hh:MM"形式 | |
| 4 | schedules.schedule.end_datetime | 終了日時 | string | is_all_day=trueの場合は、"yyyy/mm/dd"形式。 それ以外は、"yyyy/mm/dd hh:MM"形式 | |
| 5 | schedules.schedule.interviewer_business_card | ※ | 当日面談者 (紐づき名刺) | array(number) | テキスト名刺に値を設定する場合は、項目自体不要 |
| 6 | schedules.schedule.interviewer_text_business_card | ※ | 当日面談者 (テキスト名刺) | string | 紐づき名刺に値を設定する場合は、項目自体不要 |
| 7 | schedules.schedule.schedule_member | 参加者 | array(object) | ||
| - attendance_status | 参加者ステータス | string | 「出席/欠席/共有/未確認」のいずれかを指定 | ||
| - relational_employee | 紐づき社員 | number | |||
| 8 | schedules.schedule.address | 住所 | object | ||
| - zipcode | 郵便番号 | string | |||
| - country | 国 | string | |||
| - street | 番地 | string | |||
| - building | 建物 | string | |||
| 9 | schedules.schedule.memo | メモ | string | ||
| 10 | schedules.schedule.attachment | 添付ファイル | array(object) | 複数添付可能 | |
| - fileid | ファイルID | string | |||
| 11 | schedules.schedule.is_published | 公開フラグ | boolean | ||
| 12 | schedules.schedule.is_non_owner_edit | 本人以外編集可 | boolean | ||
| 13 | schedules.schedule.schedule_type | スケジュール種別名 | string | スケジュール種別マスタの選択肢名。。マスタの選択肢取得方法 | |
| 14 | schedules.schedule.repeat_condition | 繰り返し条件 | object | 繰り返し条件。一度に50件以上のスケジュールを登録することはできない。 | |
| - repeat_type | 繰り返し種別 | number | 1:日ごと、2:週ごと、3:月ごと、4:年ごと | ||
| - repeat_interval | 繰り返し間隔 | number | 繰り返し種別が日、週、月、年の場合に指定 | ||
| - repeat_end_condition | 繰り返し終了条件 | object | 「繰り返し終了日」か「繰り返し終了回数」で指定。 | ||
| -- repeat_end_date | ※ | 繰り返し終了日 | string | 繰り返し終了条件を終了日で指定。 「繰り返し終了日」と「繰り返し終了回数」のどちらかのみ。"yyyy/mm/dd"形式。 | |
| -- repeat_count | ※ | 繰り返し回数 | number | 繰り返し終了条件を繰り返し回数で指定。 「繰り返し終了日」と「繰り返し終了回数」のどちらかのみ。 | |
| - repeat_option | ※ | 繰り返し条件オプション | object | 繰り返し種別が[2:週ごと、3:月ごと] の場合に指定。 | |
| -- week_repeat_day | ※ | 対象曜日 | array(number) | 繰り返し種別が[2:週ごと] の場合のみ有効（必須）。一つ以上を選択。 1:日、 2:月、 3:火、 4:水、 5:木、 6:金、 7:土 | |
| -- month_repeat_pattern | ※ | 月繰り返し種別 | number | 繰り返し種別が[3:月ごと] の場合のみ有効（必須）。1:固定日、 2:固定週、 3:月の末日 | |
| -- month_repeat_day | ※ | 固定日 | number | 繰り返し種別が[3:月ごと]、かつ月繰り返し種別が[1:固定日] の場合のみ有効（必須）。 | |
| -- month_repeat_week | ※ | 固定週 | number | 繰り返し種別が[3:月ごと]、かつ月繰り返し種別が[2:固定週] の場合のみ有効（必須）。 1:第１、 2:第２、 3:第３、 4:第４、 5:第５ | |
| -- month_repeat_week_day | ※ | 固定曜日 | number | 繰り返し種別が[3:月ごと]、かつ月繰り返し種別が[2:固定週] の場合のみ有効（必須）。 1:日、 2:月、 3:火、 4:水、 5:木、 6:金、 7:土 | |
| 15 | schedules.schedule.relational_customer | 紐づき顧客 | array(number) | ||
| 16 | schedules.schedule.relational_businessplan | 紐づき案件 | array(number) | ||
| 17 | facility_asset_reserves | 予約施設・資産 | array(object) | 設備・備品の取得方法 | |
| - asset.id | ※ | 施設・資産ID | number | ||
| - asset_reserve_status.start_date_time | ※ | 予約開始日 | string | "yyyy/mm/dd hh:MM"形式 | |
| - asset_reserve_status.end_date_time | ※ | 予約終了日 | string | "yyyy/mm/dd hh:MM"形式 | |
| is_skip_asset_reserve_error | 施設予約エラースキップフラグ | boolean | facility_asset_reservesが設定されている場合のみ意味を持つ項目。 Trueの場合に、施設予約の重複エラーが発生した場合、システムは予約情報を設定せずにスケジュール登録を行うようにする。 Falseの場合はそのまま施設予約の重複エラーを返却する。 |
Example
{
"schedules.schedule.subject": "外出",
"schedules.schedule.is_all_day": false,
"schedules.schedule.start_datetime": "2025/01/28 09:00",
"schedules.schedule.end_datetime": "2025/01/28 09:30",
"schedules.schedule.interviewer_business_card": [
123
],
"schedules.schedule.interviewer_text_business_card": "営業太郎",
"schedules.schedule.schedule_member": [
{
"attendance_status": "出席",
"relational_employee": 123
}
],
"schedules.schedule.address": {
"street": "東京都中央区銀座6-18-2",
"country": "JPN",
"zipcode": "03-6779-98",
"building": "野村不動産銀座ビル 11階"
},
"schedules.schedule.memo": "メモ",
"schedules.schedule.attachment": [
{
"fileid": "6b1be1e8c8c14cf9a7b84948a70b1861"
}
],
"schedules.schedule.is_published": true,
"schedules.schedule.is_non_owner_edit": true,
"schedules.schedule.schedule_type": "外出",
"schedules.schedule.repeat_condition": {
"repeat_type": 1,
"repeat_interval": 2,
"repeat_end_condition": {
"repeat_count": 3
}
},
"schedules.schedule.relational_customer": [
123
],
"schedules.schedule.relational_businessplan": [
123
],
"facility_asset_reserves": [
{
"asset.id": "123",
"asset_reserve_status.start_date_time": "2025/01/28 09:00",
"asset_reserve_status.end_date_time": "2025/01/28 09:30"
}
]
}
Response
リクエスト時に繰り返しスケジュールを登録した場合、それによって登録されたスケジュールがすべて返却されます。
Example
{
"schedules.schedule.id": 123,
"schedules.schedule.subject": "外出",
"schedules.schedule.is_all_day": false,
"schedules.schedule.start_datetime": "2025/01/28 09:00",
"schedules.schedule.end_datetime": "2025/01/28 09:30",
"schedules.schedule.interviewer_business_card": [
123
],
"schedules.schedule.interviewer_text_business_card": "営業太郎",
"schedules.schedule.schedule_member": [
{
"attendance_status": "出席",
"relational_employee": 123
}
],
"schedules.schedule.address": {
"street": "東京都中央区銀座6-18-2",
"country": "JPN",
"zipcode": "03-6779-98",
"building": "野村不動産銀座ビル 11階"
},
"schedules.schedule.memo": "メモ",
"schedules.schedule.attachment": [
{
"fileid": "6b1be1e8c8c14cf9a7b84948a70b1861"
}
],
"schedules.schedule.is_published": true,
"schedules.schedule.is_non_owner_edit": true,
"schedules.schedule.schedule_type": "外出",
"schedules.schedule.repeat_condition": {
"repeat_type": 1,
"repeat_interval": 2,
"repeat_end_condition": {
"repeat_count": 3
}
},
"schedules.schedule.relational_customer": [
123
],
"schedules.schedule.relational_businessplan": [
123
],
"facility_asset_reserves": [
{
"asset.id": "123",
"asset_reserve_status.start_date_time": "2025/01/28 09:00",
"asset_reserve_status.end_date_time": "2025/01/28 09:30"
}
]
}
スケジュール削除
必要な権限
スケジュール削除・スケジュール一括削除
Request
URL
https://gateway-esm.softbrain.com/calendar-fs/{tenant}/pub/esms/v1/schedule/{id}
HTTP Method
DELETE
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | id | ○ | string | - | 対象レコードID |