flexcrmサポートページ

API docs by Redocly

FlexCRM (1.0)

APIのご利用方法

FlexCRM APIはFlexCRMのデータ操作を可能とするAPIです。

各APIのエンドポイントに、取得したAPIキーを用いてアクセスし、各種データ操作を行います。

  1. FlexCRMにログインします。

  2. 管理画面より、APIキーを取得します。

  3. システム設定　→　APIキーの取得(システム管理者のみログインできます。)

  4. 各APIのエンドポイントに、取得したAPIキーを用いてアクセスし、データ操作を行います。

共通仕様

API共通仕様

  • APIは原則 RESTful に準拠します。
  • レスポンスフォーマットは JSON です。
  • 文字コードは UTF-8 です。
  • 通信プロトコルは HTTPS です。
  • HTTPリクエストヘッダに以下の情報を含めて送信してください。
  • 　認証情報(APIキー)
  • 　User-Agent　※セキュリティ強化のため2024/06/01より必須となります。
  • 　
  • 以下の HTTP メソッドにより操作を区別します。
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キーは管理画面より取得します。(システム設定->APIキーの取得)
  • 取得可能なAPIキーは1契約につき、1つです。APIの再発行は可能です。
  • APIキーによるアクセスに、IPアドレス制限を付与する事も可能です。
  • 取得したAPIキーはHTTPリクエストヘッダー(X-FlexCRM-API-KEY)に付与して使用します。

例：APIキーが　mCuKeW2mYtceEZTS3Ei92b8mEr8YP0qz　の場合 

 X-FlexCRM-API-KEY: mCuKeW2mYtceEZTS3Ei92b8mEr8YP0qz

FlexDB

FlexDB データフィールドの取得

FlexDBで作成した各テーブルのデータフィールド(データ項目)一覧を取得します。

path Parameters
table_id
required
string

テーブルID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "fields": {
    }
}

FlexDB 一覧データの取得

FlexDBで作成した各テーブルのデータ一覧を取得します。

検索対象のキー名の後ろに記号をURLエンコードしたものを付与することにより以下の検索が行えます。

記号 エンコードした値 説明
!= %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

QUERY PARAMETERSのキー名は例となります。 正しいキー名は「FlexDB データフィールドの取得」から、取得してご利用ください。

path Parameters
table_id
required
string

テーブルID

query Parameters
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

電話番号[検索値]

mail
string

メールアドレス[検索値]

user
integer

ユーザ[検索値]

ユーザのレコード番号

data
string

リレーション[検索値]

参照元テーブルのプライマリキーの値

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "limit": 100,
  • "offset": 0,
  • "count": 100,
  • "maxCount": 1000,
  • "data": [
    ]
}

FlexDB データの登録

FlexDBで作成した各テーブルにデータを登録します。

path Parameters
table_id
required
string

テーブルID

Request Body schema: application/json
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

電話番号

mail
string

メールアドレス

user
integer

ユーザ

ユーザのレコード番号

data
string

リレーション

参照元テーブルのプライマリキーの値

Responses

Request samples

Content type
application/json
{
  • "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"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "id": 123
}

FlexDB データの取得

FlexDBで作成した各テーブルに登録されているデータを取得します。

path Parameters
table_id
required
string

テーブルID

record_id
required
string

レコード番号

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

FlexDB データの更新

FlexDBで作成した各テーブルのデータを更新します。

path Parameters
table_id
required
string

テーブルID

record_id
required
string

レコード番号

Request Body schema: application/json
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

電話番号

mail
string

メールアドレス

user
integer

ユーザ

ユーザのレコード番号

data
string

リレーション

参照元テーブルのプライマリキーの値

Responses

Request samples

Content type
application/json
{
  • "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"
}

Response samples

Content type
application/json
{
  • "status": "success"
}

FlexDB データの削除

FlexDBで作成した各テーブルのデータを削除します。

path Parameters
table_id
required
string

テーブルID

record_id
required
string

レコード番号

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

FlexDB データの取得(プライマリキー指定)

FlexDBで作成した各テーブルに登録されているデータを取得します。

path Parameters
table_id
required
string

テーブルID

pkey
required
string

pkey(固定値)

key_value
required
string

プライマリキーの値

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    }
}

FlexDB データの更新(プライマリキー指定)

FlexDBで作成した各テーブルのデータを更新します。

path Parameters
table_id
required
string

テーブルID

pkey
required
string

pkey(固定値)

key_value
required
string

プライマリキーの値

Request Body schema: application/json
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

電話番号

mail
string

メールアドレス

user
integer

ユーザ

ユーザのレコード番号

data
string

リレーション

参照元テーブルのプライマリキーの値

Responses

Request samples

Content type
application/json
{
  • "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"
}

Response samples

Content type
application/json
{
  • "status": "success"
}

FlexDBプロセスデータ取得

FlexDBで作成した各レコードのプロセスデータ一覧を取得します。

path Parameters
table_id
required
string

テーブルID

record_id
required
string

レコード番号

Responses

Response samples

Content type
application/json
[
  • {
    }
]

FlexDBプロセスデータ更新

FlexDBで作成した各レコードのプロセスを更新します。

完了にする際にワークフローの設定があれば申請を開始します。

path Parameters
table_id
required
string

テーブルID

record_id
required
string

レコード番号

process_id
required
string

プロセスID

Request Body schema: application/json
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上でプロセスを変更するとき同様のバリデーションチェックを行う

Responses

Request samples

Content type
application/json
{
  • "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
}

Response samples

Content type
application/json
[
  • {
    }
]

FlexDBファイル登録

FlexDBで作成した各テーブルにファイルをアップロードします。

path Parameters
table_id
required
string

テーブルID

record_id
required
string

レコード番号

Request Body schema: application/x-www-form-urlencoded
field_id
string

フィールドID

file
string <binary>

添付ファイル

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

FlexDBファイル削除

FlexDBで作成した各テーブルのファイルを削除します。

path Parameters
table_id
required
string

テーブルID

record_id
required
string

レコード番号

Request Body schema: application/json
field_id
string

フィールドID

Responses

Request samples

Content type
application/json
{
  • "field_id": "1234"
}

Response samples

Content type
application/json
{
  • "status": "success"
}

ファイル取得

FlexDBで作成した各テーブルのファイルを取得します。

path Parameters
table_id
required
string

テーブルID

record_id
required
string

レコード番号

field_id
required
string

フィールドID

file_name
required
string

ファイル名

Responses

Response samples

Content type
application/json
{ }

ファイル取得(プライマリキー指定)

FlexDBで作成した各テーブルのファイルを取得します。

path Parameters
table_id
required
string

テーブルID

pkey
required
string

pkey(固定値)

key_value
required
string

プライマリキーの値

field_id
required
string

フィールドID

file_name
required
string

ファイル名

Responses

Response samples

Content type
application/json
{ }

ワークフロー

ワークフロー取得

指定した申請IDのワークフローを取得します。

path Parameters
format_id
required
string

フォーマットID

application_id
required
string

申請ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "count": "1",
  • "data": {
    },
  • "basicdata": {
    }
}

ワークフロー削除

指定した申請IDのワークフローを削除します。

path Parameters
format_id
required
string

フォーマットID

application_id
required
string

申請ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "delete_ids": [
    ]
}

ワークフロー取得(承認者を社員番号に変換)

指定した申請IDのワークフローを取得します。

path Parameters
format_id
required
string

フォーマットID

application_id
required
string

申請ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "count": "1",
  • "data": {
    },
  • "basicdata": {
    }
}

ワークフローの拡張フィールド情報取得

指定したワークフローの拡張フィールド情報を取得します。

path Parameters
format_id
required
string

フォーマットID

Responses

Response samples

Content type
application/json
{
  • "fields": { },
  • "status": "success"
}

ワークフロー下書き登録

ワークフローを作成します。

作成したデータは下書き状態となります。

Request Body schema: application/json
format_id
required
integer

フォーマットID

user_id
required
string

ユーザID

applicant_date
required
string

申請日

applicant_deadline
string

期限

applicant_title
string

ワークフロータイトル

Responses

Request samples

Content type
application/json
{
  • "format_id": 1234,
  • "user_id": "user",
  • "applicant_date": "2022-05-17",
  • "applicant_deadline": "2022-05-17",
  • "applicant_title": "ワークフロータイトル"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "id": 1234
}

ワークフロー申請登録

ワークフロー申請データを作成します。

作成したデータは申請状態となります。

Request Body schema: application/json
format_id
required
integer

フォーマットID

user_id
required
string

ユーザID

applicant_date
required
string

申請日

applicant_deadline
string

期限

applicant_title
string

ワークフロータイトル

object

承認ルート(JSON)

Responses

Request samples

Content type
application/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\"]}]"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "id": 1234
}

ワークフロー申請登録(社員番号でユーザを指定)

ワークフロー申請データを作成します。

作成したデータは申請状態となります。

Request Body schema: application/json
format_id
required
integer

フォーマットID

user_id
required
string

社員番号

applicant_date
required
string

申請日

applicant_deadline
string

期限

applicant_title
string

ワークフロータイトル

object

承認ルート(JSON)

Responses

Request samples

Content type
application/json
{
  • "format_id": 1234,
  • "user_id": "1234",
  • "applicant_date": "2022-05-17",
  • "applicant_deadline": "2022-05-17",
  • "applicant_title": "ワークフロータイトル",
  • "approval_routes": "[{\"rank\":1,\"org_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\"]}]"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "id": 1234
}

承認者を取得

事業所コード(部署)、社員番号、職責ランクが指定されるので、それらを組み合わせて承認者を取得する。

officecodeがあれば事業所コード(部署コード)と職責ランクに該当するユーザを取得する。

officecodeが指定されていなくて、employeeno(社員番号)があれば、その社員番号のユーザが所属する部署と職責ランクに該当するユーザを取得する。

query Parameters
officecode
string

事業所コード

employeeno
string

社員番号

position
string

職責ランク

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "authorizers": [
    ]
}

承認、コメント情報の取得

指定したワークフローの承認、コメント情報を取得します。

path Parameters
application_id
required
string

申請ID

Responses

Response samples

Content type
application/json
{
  • "approvalList": [
    ],
  • "status": "success"
}

ワークフロー再申請

差し戻しのワークフローを再申請します。

Request Body schema: application/json
application_id
required
integer

申請ID

user_id
required
integer

ユーザID

applicant_date
string

申請日

applicant_deadline
string

期限

applicant_title
string

ワークフロータイトル

Responses

Request samples

Content type
application/json
{
  • "application_id": 1234,
  • "user_id": 123,
  • "applicant_date": "2022-05-17",
  • "applicant_deadline": "2022-05-17",
  • "applicant_title": "ワークフロータイトル"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "id": 1234
}

ワークフロー再申請(社員番号で指定)

差し戻しのワークフローを再申請します。

Request Body schema: application/json
application_id
required
integer

申請ID

user_id
required
string

社員番号

applicant_date
string

申請日

applicant_deadline
string

期限

applicant_title
string

ワークフロータイトル

Responses

Request samples

Content type
application/json
{
  • "application_id": 0,
  • "user_id": "string",
  • "applicant_date": "2022-05-17",
  • "applicant_deadline": "2022-05-17",
  • "applicant_title": "ワークフロータイトル"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "id": 1234
}

ユーザ／グループ

ユーザ一覧データの取得

登録されているユーザのデータ一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "limit": 100,
  • "offset": 0,
  • "count": 100,
  • "maxCount": 1000,
  • "data": [
    ]
}

ユーザ登録

ユーザデータを登録します。 登録データは POST form data として送信します。

Request Body schema: application/json
userid
string

ユーザID

password
string

パスワード

name
string

ユーザ表示名

kana
string

フリガナ

employee_no
string

社員番号

mail
string

メールアドレス

status
integer

ステータス[1:有効,2:無効]

del_flg
integer

削除フラグ[0:有効,1:削除ユーザ]

Responses

Request samples

Content type
application/json
{
  • "userid": "userid",
  • "password": "password",
  • "name": "ユーザ名",
  • "kana": "ユーザメイ",
  • "employee_no": "12345678",
  • "mail": "support@flex-crm.com",
  • "status": 0,
  • "del_flg": 0
}

Response samples

Content type
application/json
{
  • "status": "success"
}

ユーザ取得

登録されているユーザのデータを取得します。

path Parameters
record_id
required
string

レコード番号

Responses

Response samples

Content type
application/json
{
  • "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"
}

ユーザ更新

ユーザデータを更新します。

path Parameters
record_id
required
string

レコード番号

Request Body schema: application/json
userid
string

ユーザID

password
string

パスワード

name
string

ユーザ表示名

kana
string

フリガナ

employee_no
string

社員番号

mail
string

メールアドレス

status
integer

ステータス[1:有効,2:無効]

del_flg
integer

削除フラグ[0:有効,1:削除ユーザ]

Responses

Request samples

Content type
application/json
{
  • "userid": "userid",
  • "password": "password",
  • "name": "ユーザ名",
  • "kana": "ユーザメイ",
  • "employee_no": "12345678",
  • "mail": "support@flex-crm.com",
  • "status": 0,
  • "del_flg": 0
}

Response samples

Content type
application/json
{
  • "status": "success"
}

ユーザ削除

ユーザデータを削除します。

path Parameters
record_id
required
string

レコード番号

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

ユーザプロフィール画像取得

ユーザプロフィール画像を取得します。

path Parameters
record_id
required
string

レコード番号

Responses

Response samples

Content type
application/json
{ }

ユーザプロフィール画像取得(社員番号指定)

指定した社員番号からユーザプロフィール画像を取得します。

path Parameters
employee_no
required
string

社員番号

Responses

Response samples

Content type
application/json
{ }

グループ一覧取得

グループ一覧データを取得します。

Responses

Response samples

Content type
application/json
{
  • "status": "status",
  • "limit": 100,
  • "offset": 0,
  • "count": 100,
  • "maxCount": 1000,
  • "data": [
    ]
}

グループ登録

グループデータを登録します。

Request Body schema: application/json
name
string

グループ名

memo
string

メモ

rank
integer

表示順

Responses

Request samples

Content type
application/json
{
  • "name": "グループ名",
  • "memo": "メモ",
  • "rank": 1
}

Response samples

Content type
application/json
{
  • "status": "success"
}

グループ取得

グループデータを取得します。

path Parameters
record_id
required
string

レコード番号

Responses

Response samples

Content type
application/json
{
  • "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"
}

グループ更新

グループデータを更新します。

path Parameters
record_id
required
string

レコード番号

Request Body schema: application/json
name
string

グループ名

memo
string

メモ

rank
integer

表示順

Responses

Request samples

Content type
application/json
{
  • "name": "グループ名",
  • "memo": "メモ",
  • "rank": 1
}

Response samples

Content type
application/json
{
  • "status": "success"
}

グループ削除

グループデータを削除します。

path Parameters
record_id
required
string

レコード番号

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

部署一覧取得

部署データを取得します。

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "limit": 100,
  • "offset": 0,
  • "count": 100,
  • "maxcount": 1000,
  • "data": [
    ]
}

部署登録

部署データを登録します。

Request Body schema: application/json
name
string

部署表示名

code
string

コード

rank
integer

表示順

parent
integer

親部署ID

Responses

Request samples

Content type
application/json
{
  • "name": "部署表示名",
  • "code": "12345678",
  • "rank": 1,
  • "parent": 10
}

Response samples

Content type
application/json
{
  • "status": "success"
}

部署取得

部署データを取得します。

path Parameters
record_id
required
string

レコード番号

Responses

Response samples

Content type
application/json
{
  • "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"
}

部署更新

部署データを更新します。

path Parameters
record_id
required
string

レコード番号

Request Body schema: application/json
id
integer

レコード番号

name
string

部署表示名

code
string

コード

rank
integer

表示順

parent
integer

親部署ID

Responses

Request samples

Content type
application/json
{
  • "id": 1234,
  • "name": "部署名",
  • "code": "12345678",
  • "rank": 1,
  • "parent": 10
}

Response samples

Content type
application/json
{
  • "status": "success"
}

部署削除

部署データを削除します。

path Parameters
record_id
required
string

レコード番号

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

職責一覧取得

職責一覧データを取得します。

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "limit": 100,
  • "offset": 0,
  • "count": 100,
  • "maxCount": 1000,
  • "data": [
    ]
}

職責登録

職責データを更新します。

Request Body schema: application/json
name
string

職責名

rank
integer

表示順

Responses

Request samples

Content type
application/json
{
  • "name": "職責名",
  • "rank": 1
}

Response samples

Content type
application/json
{
  • "status": "success"
}

職責取得

職責データを取得します。

path Parameters
record_id
required
string

レコード番号

Responses

Response samples

Content type
application/json
{
  • "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"
}

職責更新

職責データを更新します。

path Parameters
record_id
required
string

レコード番号

Request Body schema: application/json
name
string

職責名

rank
integer

表示順

Responses

Request samples

Content type
application/json
{
  • "name": "職責名",
  • "rank": 1
}

Response samples

Content type
application/json
{
  • "status": "success"
}

職責削除

職責データを削除します。

path Parameters
record_id
required
string

レコード番号

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

ファイル共有

ファイル共有メニューへのファイルアップロード

ファイル共有メニューへファイルをアップロードします。

path Parameters
path
required
string

ファイル共有メニュー内の指定フォルダ

Request Body schema: application/x-www-form-urlencoded
file
required
string <binary>

添付ファイル

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

スケジュール

スケジュール一覧取得

スケジュール一覧を取得します。

query Parameters
start_date
string

開始日時

end_date
string

終了日時

participant
string

参加者

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "scheduleList": [
    ]
}

スケジュール登録

スケジュールを登録します。

Request Body schema: application/json
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:詳細を伏せて公開]

Responses

Request samples

Content type
application/json
{
  • "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": [
    ],
  • "private": "0"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "id": "success"
}

スケジュール取得

スケジュールを取得します。

path Parameters
record_id
required
string

レコード番号

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "scheduleInfo": {
    }
}

スケジュール更新

スケジュールを更新します。

path Parameters
record_id
required
string

レコード番号

Request Body schema: application/json
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:詳細を伏せて公開]

Responses

Request samples

Content type
application/json
{
  • "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": [
    ],
  • "private": "0"
}

Response samples

Content type
application/json
{
  • "status": "success"
}

スケジュール削除

スケジュールを削除します。

path Parameters
record_id
required
string

レコード番号

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}