サポートページFlexCRM APIはFlexCRMのデータ操作を可能とするAPIです。
各APIのエンドポイントに、取得したAPIキーを用いてアクセスし、各種データ操作を行います。
FlexCRMにログインします。
管理画面より、APIキーを取得します。
システム設定 → APIキーの取得(システム管理者のみログインできます。)
各APIのエンドポイントに、取得したAPIキーを用いてアクセスし、データ操作を行います。
API共通仕様
| HTTPメソッド | 操作 |
|---|---|
| GET | データ取得 |
| POST | データ登録 |
| PUT | データ更新 |
| DELETE | データ削除 |
HTTPリクエストパラメータは、URLエンコードして送信してください。
リクエストの成否は JSON の “status” 項目に格納されます。
APIはアクセス失敗時に以下のようはHTTPステータスコードを返します。
また、JSONデータの”status”項目に”error”を返します。
| ステータス | メッセージ |
|---|---|
| 200 OK | リクエストは正常に完了しました。 |
| 201 Created | 新規データが作成されました。 |
| 400 Bad Request | リクエストは不適切です。 |
| 401 Unauthorized | リクエストが許可されていません。 |
| 403 Forbidden | ユーザを認証出来ません。 |
| 405 Method Not Allowed | リクエストに指定されたエンドポイントは有りません。 |
例：エンドポイントが無かった場合
{
"status": "error",
"error": "Unknown method."
}
APIの認証は、APIキーをHTTPSによるAPIリクエスト時に付与することにより行います。
例：APIキーが mCuKeW2mYtceEZTS3Ei92b8mEr8YP0qz の場合
X-FlexCRM-API-KEY: mCuKeW2mYtceEZTS3Ei92b8mEr8YP0qz
FlexDBで作成した各テーブルのデータ一覧を取得します。
| 記号 | エンコードした値 | 説明 |
|---|---|---|
| != | %21%3D | 含まない |
| = | %3D | 完全一致 |
| > | %3E | 超える(数値、日付のみ) |
| >= | %3E%3D | 以上(数値、日付のみ) |
| <= | %3C%3D | 以下(数値、日付のみ) |
| < | %3C | 未満(数値、日付のみ) |
例1：titleが text のものを完全一致(=)で検索
/flexdb/{table_id}?title%3D=text
例2：dateが 2023/04/01 00:00:00 以上(>=)で検索
/flexdb/{table_id}?date%3E%3D=2023%2F04%2F01+00%3A00%3A00
| 記号 | エンコードした値 |
|---|---|
| 半角スペース | %20 |
| , | %2C |
例1：レコードIDを降順で並び替える
/flexdb/{table_id}?order-by=id%20desc
例2：titleを昇順で並び替えて、titleが同じ値の時にnumberを降順で並び替える
/flexdb/{table_id}?order-by=title%20asc%2Cnumber%20desc
※未指定の場合：レコードIDの昇順で取得します。
QUERY PARAMETERSのキー名は例となります。 正しいキー名は「FlexDB データフィールドの取得」から、取得してご利用ください。
| table_id required | string テーブルID |
| order-by | string |
| limit | integer 取得時のデータ制限数 ※未指定の場合：最大100件を取得します。 ※指定した場合：最大1000件まで取得が可能です。 |
| offset | integer 取得時のデータ取得位置 |
| title | string 1行テキスト[検索値] |
| text | string テキスト[検索値] |
| number | number 数値[検索値] |
| select | string 選択肢(ラジオ・プルダウン・チェックボックス・階層型)[検索値] ※「FlexDB データフィールドの取得」から、一意の選択肢IDを取得できます。 |
| date | string 日時[検索値] |
| address_zip | string 住所(郵便番号)[検索値] |
| address_state | string 住所(都道府県)[検索値] |
| address_city | string 住所(市区町村・番地)[検索値] |
| address_address | string 住所(ビル名・部屋番号)[検索値] |
| tel | string 電話番号[検索値] |
string メールアドレス[検索値] | |
| user | integer ユーザ[検索値] ユーザのレコード番号 |
| data | string リレーション[検索値] 参照元テーブルのプライマリキーの値 |
{- "status": "success",
- "limit": 100,
- "offset": 0,
- "count": 100,
- "maxCount": 1000,
- "data": [
- {
- "id": 1234,
- "create_user_id": 123,
- "update_user_id": 123,
- "update_date_for_user": "2022-09-21 13:00:00",
- "update_date": "2022-09-21 13:00:00",
- "create_date": "2022-09-21 13:00:00",
- "{フィールドID}": { },
- "title": "text",
- "text": "text",
- "number": 1234.1234,
- "select": "2,3",
- "date": "2019-01-01 23:59:59",
- "address_zip": 1000005,
- "address_state": 13,
- "address_city": "千代田区丸の内1丁目",
- "address_address": "東京駅",
- "tel": "03-xxxx-xxxx",
- "mail": "support@flex-crm.com",
- "user": 123,
- "file": "ファイル1.txt,ファイル2.txt",
- "file_file_list": [
- "ファイル1.txt",
- "ファイル2.txt"
], - "data": "2001",
- "computation": "2019/01/01 23:59:59"
}
]
}FlexDBで作成した各テーブルにデータを登録します。
| table_id required | string テーブルID |
| title | string <= 120 characters 1行テキスト |
| text | string <= 10000 characters テキスト |
| number | number <= 9999999999 数値 |
| select | string 選択肢(ラジオ・プルダウン・チェックボックス・階層型) 一意の選択肢ID ※「FlexDB データフィールドの取得」から、一意の選択肢IDを取得できます。 |
| date | string 日時 |
| address_zip | string 住所(郵便番号) |
| address_state | string 住所(都道府県) |
| address_city | string 住所(市区町村・番地) |
| address_address | string 住所(ビル名・部屋番号) |
| tel | string 電話番号 |
string メールアドレス | |
| user | integer ユーザ ユーザのレコード番号 |
| data | string リレーション 参照元テーブルのプライマリキーの値 |
{- "title": "text",
- "text": "text",
- "number": 1234.1234,
- "select": "2,3",
- "date": "2019-01-01 23:59:59",
- "address_zip": 1000005,
- "address_state": "東京都",
- "address_city": "千代田区丸の内1丁目",
- "address_address": "東京駅",
- "tel": "03-xxxx-xxxx",
- "mail": "support@flex-crm.com",
- "user": 123,
- "data": "2001"
}{- "status": "success",
- "id": 123
}FlexDBで作成した各テーブルに登録されているデータを取得します。
| table_id required | string テーブルID |
| record_id required | string レコード番号 |
{- "status": "success",
- "data": {
- "id": 1234,
- "create_user_id": 123,
- "update_user_id": 123,
- "update_date_for_user": "2022-09-21 13:00:00",
- "update_date": "2022-09-21 13:00:00",
- "create_date": "2022-09-21 13:00:00",
- "{フィールドID}": "string",
- "title": "text",
- "text": "text",
- "number": 1234.1234,
- "select": "2,3",
- "date": "2019-01-01 23:59:59",
- "address_zip": 1000005,
- "address_state": 13,
- "address_city": "千代田区丸の内1丁目",
- "address_address": "東京駅",
- "tel": "03-xxxx-xxxx",
- "mail": "support@flex-crm.com",
- "user": 123,
- "file": "ファイル1.txt,ファイル2.txt",
- "file_file_list": [
- "ファイル1.txt",
- "ファイル2.txt"
], - "data": "2001",
- "computation": "2019/01/01 23:59:59"
}
}FlexDBで作成した各テーブルのデータを更新します。
| table_id required | string テーブルID |
| record_id required | string レコード番号 |
| title | string <= 120 characters 1行テキスト |
| text | string <= 10000 characters テキスト |
| number | number <= 9999999999 数値 |
| select | string 選択肢(ラジオ・プルダウン・チェックボックス・階層型) 一意の選択肢ID ※「FlexDB データフィールドの取得」から、一意の選択肢IDを取得できます。 |
| date | string 日時 |
| address_zip | string 住所(郵便番号) |
| address_state | string 住所(都道府県) |
| address_city | string 住所(市区町村・番地) |
| address_address | string 住所(ビル名・部屋番号) |
| tel | string 電話番号 |
string メールアドレス | |
| user | integer ユーザ ユーザのレコード番号 |
| data | string リレーション 参照元テーブルのプライマリキーの値 |
{- "title": "text",
- "text": "text",
- "number": 1234.1234,
- "select": "2,3",
- "date": "2019-01-01 23:59:59",
- "address_zip": 1000005,
- "address_state": "東京都",
- "address_city": "千代田区丸の内1丁目",
- "address_address": "東京駅",
- "tel": "03-xxxx-xxxx",
- "mail": "support@flex-crm.com",
- "user": 123,
- "data": "2001"
}{- "status": "success"
}FlexDBで作成した各テーブルに登録されているデータを取得します。
| table_id required | string テーブルID |
| pkey required | string pkey(固定値) |
| key_value required | string プライマリキーの値 |
{- "status": "success",
- "data": {
- "id": 1234,
- "create_user_id": 123,
- "update_user_id": 123,
- "update_date_for_user": "2022-09-21 13:00:00",
- "update_date": "2022-09-21 13:00:00",
- "create_date": "2022-09-21 13:00:00",
- "{フィールドID}": "string",
- "title": "text",
- "text": "text",
- "number": 1234.1234,
- "select": "2,3",
- "date": "2019-01-01 23:59:59",
- "address_zip": 1000005,
- "address_state": 13,
- "address_city": "千代田区丸の内1丁目",
- "address_address": "東京駅",
- "tel": "03-xxxx-xxxx",
- "mail": "support@flex-crm.com",
- "user": 123,
- "file": "ファイル1.txt,ファイル2.txt",
- "file_file_list": [
- "ファイル1.txt",
- "ファイル2.txt"
], - "data": "2001",
- "computation": "2019/01/01 23:59:59"
}
}FlexDBで作成した各テーブルのデータを更新します。
| table_id required | string テーブルID |
| pkey required | string pkey(固定値) |
| key_value required | string プライマリキーの値 |
| title | string <= 120 characters 1行テキスト |
| text | string <= 10000 characters テキスト |
| number | number <= 9999999999 数値 |
| select | string 選択肢(ラジオ・プルダウン・チェックボックス・階層型) 一意の選択肢ID ※「FlexDB データフィールドの取得」から、一意の選択肢IDを取得できます。 |
| date | string 日時 |
| address_zip | string 住所(郵便番号) |
| address_state | string 住所(都道府県) |
| address_city | string 住所(市区町村・番地) |
| address_address | string 住所(ビル名・部屋番号) |
| tel | string 電話番号 |
string メールアドレス | |
| user | integer ユーザ ユーザのレコード番号 |
| data | string リレーション 参照元テーブルのプライマリキーの値 |
{- "title": "text",
- "text": "text",
- "number": 1234.1234,
- "select": "2,3",
- "date": "2019-01-01 23:59:59",
- "address_zip": 1000005,
- "address_state": "東京都",
- "address_city": "千代田区丸の内1丁目",
- "address_address": "東京駅",
- "tel": "03-xxxx-xxxx",
- "mail": "support@flex-crm.com",
- "user": 123,
- "data": "2001"
}{- "status": "success"
}FlexDBで作成した各レコードのプロセスデータ一覧を取得します。
| table_id required | string テーブルID |
| record_id required | string レコード番号 |
[- {
- "id": 1234,
- "type": 2,
- "type_name": "プロセス",
- "start_date": "2020-11-17 10:58:00",
- "end_date": "2020-11-17 10:58:00",
- "limit_date": "2020-11-17 10:58:00",
- "limit_date_allday_flg": 1,
- "completion_flg": 1,
- "completion_date": "2020-11-17 10:58:00",
- "completion_date_allday_flg": 1,
- "target_user_id": 1,
- "target_user_type": 1,
- "process_id": "1234",
- "process_name": "プロセス名",
- "rank": 1
}
]FlexDBで作成した各レコードのプロセスを更新します。
完了にする際にワークフローの設定があれば申請を開始します。
| table_id required | string テーブルID |
| record_id required | string レコード番号 |
| process_id required | string プロセスID |
| userid | integer ユーザのレコード番号 ※社員番号かどちらか必須 |
| employee_no | string 社員番号 ※ユーザのレコード番号かどちらか必須 |
| completion_date | string 完了日 |
| completion_flg | integer プロセス完了フラグ[1:完了,2:未完了] |
| limit_date | string 期限日 |
| target_user | integer 担当者ユーザのレコード番号 |
| notice_user | integer 通知ユーザのレコード番号 |
| validation_flg | integer バリデーションフラグ[0:無効,1:有効] 有効であればFlexDB上でプロセスを変更するとき同様のバリデーションチェックを行う |
{- "userid": 123,
- "employee_no": "0123",
- "completion_date": "2023-01-01 01:23:45",
- "completion_flg": 1,
- "limit_date": "2023-01-01 01:23:45",
- "target_user": 123,
- "notice_user": 123,
- "validation_flg": 0
}[- {
- "status": "success"
}
]FlexDBで作成した各テーブルにファイルをアップロードします。
| table_id required | string テーブルID |
| record_id required | string レコード番号 |
| field_id required | string フィールドID |
| file required | string <binary> 添付ファイル |
{- "status": "success"
}指定した申請IDのワークフローを取得します。
| format_id required | string フォーマットID |
| application_id required | string 申請ID |
{- "status": "success",
- "count": "1",
- "data": {
- "id": "1234"
}, - "basicdata": {
- "id": 1234,
- "workflow_setting_id": 1234,
- "h_number": 1,
- "applicant": 123,
- "application_date": "2022-09-21 00:00:00",
- "deadline": "2022-09-21 00:00:00",
- "subject": "件名",
- "contents": "内容",
- "supplier_id": null,
- "contract_type": null,
- "contract_date": null,
- "approval_routes": "[{\"rank\":1,\"org_rank\":\"1\",\"name\":\"承認者１\",\"route_type\":\"1\",\"approval_type\":\"0\",\"userIds\":[],\"groupIds\":[],\"departmentIds\":[],\"approver_unchangeable\":null,\"users\":[]},{\"rank\":2,\"org_rank\":\"2\",\"name\":\"承認者２\",\"route_type\":\"1\",\"approval_type\":\"0\",\"userIds\":[],\"groupIds\":[],\"departmentIds\":[],\"approver_unchangeable\":null,\"users\":[]},{\"rank\":3,\"org_rank\":\"3\",\"name\":\"承認者３\",\"route_type\":\"1\",\"approval_type\":\"0\",\"userIds\":[\"1734\"],\"groupIds\":[],\"departmentIds\":[],\"approver_unchangeable\":null,\"users\":[\"9876549027\"]}]",
- "status": 5,
- "proxy_flg": 0,
- "progress": 3,
- "times": 1,
- "intermediate_reject_times": 0,
- "approval_name": "承認ルート名",
- "create_user_id": 123,
- "update_user_id": 123,
- "update_date_for_user": "2022-09-21 13:00:00",
- "update_date": "2022-09-21 13:00:00",
- "create_date": "2022-09-21 13:00:00",
- "create_user_name": "ユーザ名",
- "update_user_name": "ユーザ名",
- "status_name": "完了"
}
}ワークフローを作成します。
作成したデータは下書き状態となります。
| format_id required | integer フォーマットID |
| user_id required | string ユーザID |
| applicant_date required | string 申請日 |
| applicant_deadline | string 期限 |
| applicant_title | string ワークフロータイトル |
{- "format_id": 1234,
- "user_id": "user",
- "applicant_date": "2022-05-17",
- "applicant_deadline": "2022-05-17",
- "applicant_title": "ワークフロータイトル"
}{- "status": "success",
- "id": 1234
}ワークフロー申請データを作成します。
作成したデータは申請状態となります。
| format_id required | integer フォーマットID |
| user_id required | string ユーザID |
| applicant_date required | string 申請日 |
| applicant_deadline | string 期限 |
| applicant_title required | string ワークフロータイトル |
object 承認ルート(JSON) |
{- "format_id": 1234,
- "user_id": "user",
- "applicant_date": "2022-05-17",
- "applicant_deadline": "2022-05-17",
- "applicant_title": "ワークフロータイトル",
- "approval_routes": "[{\"rank\":1,\"name\":\"承認者１\",\"route_type\":\"1\",\"approval_type\":\"0\",\"users\":[]},{\"rank\":2,\"org_rank\":\"2\",\"name\":\"承認者２\",\"route_type\":\"1\",\"approval_type\":\"0\",\"users\":[]},{\"rank\":3,\"org_rank\":\"3\",\"name\":\"承認者３\",\"route_type\":\"1\",\"approval_type\":\"0\",\"users\":[\"9876549027\"]}]"
}{- "status": "success",
- "id": 1234
}{- "approvalList": [
- {
- "application_id": 1234,
- "approval_route_rank": 1,
- "authorizer": "123",
- "name": "承認者名",
- "issue": 1,
- "issue_name": "承認",
- "comment": "コメント",
- "times": 1,
- "intermediate_reject_times": 0,
- "remand_route": 0,
- "remand_route_name": "承認１",
- "remand_authorizer": "承認者１",
- "comment_notice_target": "{\\\"all\\\":\\\"\\\",\\\"group\\\":\\\"\\\",\\\"user\\\":\\\"123\\\"}",
- "create_user_id": 123,
- "update_user_id": 123,
- "create_date": "2022-04-21 10:55:00",
- "update_date": "2022-04-21 10:55:00"
}
], - "status": "success"
}差し戻しのワークフローを再申請します。
| application_id required | integer 申請ID |
| user_id required | integer ユーザのレコード番号 |
| applicant_date | string 申請日 |
| applicant_deadline | string 期限 |
| applicant_title | string ワークフロータイトル |
{- "application_id": 1234,
- "user_id": 123,
- "applicant_date": "2022-05-17",
- "applicant_deadline": "2022-05-17",
- "applicant_title": "ワークフロータイトル"
}{- "status": "success",
- "id": 1234
}登録されているユーザのデータ一覧を取得します。
| limit | integer 取得時のデータ制限数 |
| offset | integer 取得時のデータ取得位置 |
{- "status": "success",
- "limit": 100,
- "offset": 0,
- "count": 100,
- "maxCount": 1000,
- "data": [
- {
- "id": 123,
- "userid": "userid",
- "name": "ユーザ名",
- "kana": "ユーザメイ",
- "employee_no": "12345678",
- "mail": "support@flex-crm.com",
- "status": 1,
- "del_flg": 0,
- "login_date": "2022-09-22 17:58:05",
- "last_login_date": "2022-09-22 17:58:05",
- "access_time": "2022-09-22 17:58:05",
- "create_user_id": 123,
- "update_user_id": 123,
- "update_date_for_user": "2022-09-21 13:00:00",
- "update_date": "2022-09-22 17:58:18",
- "create_date": "2022-09-22 17:58:18",
- "group": "[\"1\", \"2\", \"3\"]",
- "department": "[\"1\", \"2\", \"3\"]",
- "position": "[\"1\", \"2\", \"3\"]",
- "notification_setting": "[{\"menu\":\"flexdb\",\"email\":\"0\",\"browser\":\"1\",\"appli\":\"1\"},{\"menu\":\"flexdbcomment\",\"email\":\"1\",\"browser\":\"0\",\"appli\":\"0\"}]"
}
]
}ユーザデータを登録します。 登録データは POST form data として送信します。
| userid | string ユーザID |
| password | string パスワード |
| name | string ユーザ表示名 |
| kana | string フリガナ |
| employee_no | string 社員番号 |
string メールアドレス | |
| status | integer ステータス[1:有効,2:無効] |
| del_flg | integer 削除フラグ[0:有効,1:削除ユーザ] |
object お知らせ通知設定(JSON) |
{- "userid": "userid",
- "password": "password",
- "name": "ユーザ名",
- "kana": "ユーザメイ",
- "employee_no": "12345678",
- "mail": "support@flex-crm.com",
- "status": 0,
- "del_flg": 0,
- "notification_setting": "[{\"menu\":\"flexdb\",\"email\":\"0\",\"browser\":\"1\",\"appli\":\"1\"},{\"menu\":\"flexdbcomment\",\"email\":\"1\",\"browser\":\"0\",\"appli\":\"0\"}]"
}{- "status": "success"
}{- "id": 123,
- "userid": "userid",
- "name": "ユーザ名",
- "kana": "ユーザメイ",
- "employee_no": "12345678",
- "mail": "support@flex-crm.com",
- "status": 1,
- "del_flg": 0,
- "login_date": "2022-09-22 17:58:05",
- "last_login_date": "2022-09-22 17:58:05",
- "access_time": "2022-09-22 17:58:05",
- "create_user_id": 123,
- "update_user_id": 123,
- "update_date_for_user": "2022-09-21 13:00:00",
- "update_date": "2022-09-22 17:58:18",
- "create_date": "2022-09-22 17:58:18",
- "group": "[\"1\", \"2\", \"3\"]",
- "department": "[\"1\", \"2\", \"3\"]",
- "position": "[\"1\", \"2\", \"3\"]",
- "notification_setting": "[{\"menu\":\"flexdb\",\"email\":\"0\",\"browser\":\"1\",\"appli\":\"1\"},{\"menu\":\"flexdbcomment\",\"email\":\"1\",\"browser\":\"0\",\"appli\":\"0\"}]"
}ユーザデータを更新します。
| record_id required | string レコード番号 |
| userid | string ユーザID |
| password | string パスワード |
| name | string ユーザ表示名 |
| kana | string フリガナ |
| employee_no | string 社員番号 |
string メールアドレス | |
| status | integer ステータス[1:有効,2:無効] |
| del_flg | integer 削除フラグ[0:有効,1:削除ユーザ] |
object お知らせ通知設定(JSON) |
{- "userid": "userid",
- "password": "password",
- "name": "ユーザ名",
- "kana": "ユーザメイ",
- "employee_no": "12345678",
- "mail": "support@flex-crm.com",
- "status": 0,
- "del_flg": 0,
- "notification_setting": "[{\"menu\":\"flexdb\",\"email\":\"0\",\"browser\":\"1\",\"appli\":\"1\"},{\"menu\":\"flexdbcomment\",\"email\":\"1\",\"browser\":\"0\",\"appli\":\"0\"}]"
}{- "status": "success"
}グループ一覧データを取得します。
| limit | integer 取得時のデータ制限数 |
| offset | integer 取得時のデータ取得位置 |
{- "status": "status",
- "limit": 100,
- "offset": 0,
- "count": 100,
- "maxCount": 1000,
- "data": [
- {
- "id": 1234,
- "name": "グループ名",
- "memo": "メモ",
- "rank": 1,
- "manager_user_id": 123,
- "create_user_id": 123,
- "update_user_id": 123,
- "update_date_for_user": "2021-12-27 15:42:22",
- "update_date": "2021-12-27 15:42:22",
- "create_date": "2021-12-27 15:42:22"
}
]
}{- "id": 1234,
- "name": "グループ名",
- "memo": "メモ",
- "rank": 1,
- "manager_user_id": 123,
- "create_user_id": 123,
- "update_user_id": 123,
- "update_date_for_user": "2021-12-27 15:42:22",
- "update_date": "2021-12-27 15:42:22",
- "create_date": "2021-12-27 15:42:22"
}グループデータを更新します。
| record_id required | string レコード番号 |
| name | string グループ名 |
| memo | string メモ |
| rank | integer 表示順 |
{- "name": "グループ名",
- "memo": "メモ",
- "rank": 1
}{- "status": "success"
}{- "status": "success",
- "limit": 100,
- "offset": 0,
- "count": 100,
- "maxcount": 1000,
- "data": [
- {
- "id": 1234,
- "name": "部署名",
- "code": "12345678",
- "rank": 1,
- "hierarchy": "/255/256/291/2428/",
- "manager_user_id": "123",
- "create_user_id": 123,
- "update_user_id": 123,
- "update_date_for_user": "2021-02-19 08:58:08",
- "update_date": "2021-02-19 08:58:08",
- "create_date": "2021-02-19 08:58:08",
- "parent": 10
}
]
}部署データを登録します。
| name | string 部署表示名 |
| code | string コード |
| rank | integer 表示順 |
| parent | integer 親部署ID |
{- "name": "部署表示名",
- "code": "12345678",
- "rank": 1,
- "parent": 10
}{- "status": "success"
}{- "id": 1234,
- "name": "部署名",
- "code": "12345678",
- "rank": 1,
- "hierarchy": "/255/256/291/2428/",
- "manager_user_id": "123",
- "create_user_id": 123,
- "update_user_id": 123,
- "update_date_for_user": "2021-02-19 08:58:08",
- "update_date": "2021-02-19 08:58:08",
- "create_date": "2021-02-19 08:58:08",
- "parent": 10,
- "status": "success"
}部署データを更新します。
| record_id required | string レコード番号 |
| id | integer レコード番号 |
| name | string 部署表示名 |
| code | string コード |
| rank | integer 表示順 |
| parent | integer 親部署ID |
{- "id": 1234,
- "name": "部署名",
- "code": "12345678",
- "rank": 1,
- "parent": 10
}{- "status": "success"
}{- "status": "success",
- "limit": 100,
- "offset": 0,
- "count": 100,
- "maxCount": 1000,
- "data": [
- {
- "id": 1234,
- "name": "職責名",
- "rank": 1,
- "manager_user_id": 123,
- "create_user_id": 123,
- "update_user_id": 123,
- "update_date_for_user": "2021-01-25 10:21:51",
- "update_date": "2021-01-25 10:21:51",
- "create_date": "2021-01-25 10:21:51"
}
]
}{- "id": 1234,
- "name": "職責名",
- "rank": 1,
- "manager_user_id": 123,
- "create_user_id": 123,
- "update_user_id": 123,
- "update_date_for_user": "2021-01-25 10:21:51",
- "update_date": "2021-01-25 10:21:51",
- "create_date": "2021-01-25 10:21:51"
}スケジュール一覧を取得します。
| limit | integer 取得時のデータ制限数 |
| offset | integer 取得時のデータ取得位置 |
| start_date | string 開始日時 |
| end_date | string 終了日時 |
| participant | string 参加者 |
{- "status": "success",
- "scheduleList": [
- {
- "id": 123,
- "start_date": "2022-04-03 12:00:00",
- "end_date": "2022-04-03 13:00:00",
- "category_id": "予定区分",
- "allday_flg": 0,
- "title": "件名、目的",
- "remarks": "説明",
- "private": 0,
- "create_user_id": 123,
- "update_user_id": 123,
- "update_date_for_user": "2022-04-03 00:00:00",
- "update_date": "2022-04-03 00:00:00",
- "create_date": "2022-04-03 00:00:00",
- "participants": [
- {
- "id": 123456,
- "type": 0,
- "user_id": 123
}
]
}
]
}スケジュールを登録します。
| user_id | integer 作成者 |
| start_date | string 開始日時 |
| end_date | string 終了日時 |
| category_id | integer 予定区分 |
| allday_flg | integer 終日フラグ[0:公開,1:非公開] |
| title | string 件名、目的 |
| remarks | string 説明 |
Array of objects 参加者(カンマ区切り) | |
| private | integer 非公開[0:公開,1:非公開,2:詳細を伏せて公開] |
{- "user_id": 123,
- "start_date": "2022-08-02 14:00",
- "end_date": "2022-08-02 15:00",
- "category_id": 1,
- "allday_flg": 1,
- "title": "予定１",
- "remarks": "メモ",
- "participants": [
- {
- "type": 0,
- "user_id": 123
}
], - "private": "0"
}{- "status": "success",
- "id": "success"
}{- "status": "success",
- "scheduleInfo": {
- "id": 123,
- "start_date": "2022-04-03 12:00:00",
- "end_date": "2022-04-03 13:00:00",
- "category_id": "予定区分",
- "allday_flg": 0,
- "title": "件名、目的",
- "remarks": "説明",
- "private": 0,
- "create_user_id": 123,
- "update_user_id": 123,
- "update_date_for_user": "2022-04-03 00:00:00",
- "update_date": "2022-04-03 00:00:00",
- "create_date": "2022-04-03 00:00:00",
- "participants": [
- {
- "id": 123456,
- "type": 0,
- "user_id": 123
}
]
}
}スケジュールを更新します。
| record_id required | string レコード番号 |
| user_id | integer 作成者 |
| start_date | string 開始日時 |
| end_date | string 終了日時 |
| category_id | integer 予定区分 |
| allday_flg | integer 終日フラグ[0:公開,1:非公開] |
| title | string 件名、目的 |
| remarks | string 説明 |
Array of objects 参加者(カンマ区切り) | |
| private | integer 非公開[0:公開,1:非公開,2:詳細を伏せて公開] |
{- "user_id": 123,
- "start_date": "2022-08-02 14:00",
- "end_date": "2022-08-02 15:00",
- "category_id": 1,
- "allday_flg": 1,
- "title": "予定１",
- "remarks": "メモ",
- "participants": [
- {
- "type": 0,
- "user_id": 123
}
], - "private": "0"
}{- "status": "success"
}