Exment API (1.0)

Download OpenAPI specification:Download

E-mail: info@exment.net Terms of Service

ExmentのWeb APIリファレンスです。
アプリの登録方法や、アクセストークンの取得方法、スコープ一覧はこちらをご参照ください。
その他マニュアルは、こちらをご参照ください。

こちらはExmentのRestAPIの仕様書になります。OpenAPI形式で作成されています。

Authentication

OAuth2認証

Security Scheme Type	OAuth2
password OAuth Flow	Token URL: /oauth/token Refresh URL: /oauth/token Scopes:
authorizationCode OAuth Flow	Authorization URL: /oauth/authorize Token URL: /oauth/token Refresh URL: /oauth/token Scopes:

システム

システムバージョン情報取得

処理概要

インストールしているExmentのシステムバージョンを取得

Exment権限(Permission)

なし

APIスコープ(scope)

なし

対応バージョン

v1.1.0

Authorizations:

OAuth2認証

Responses

Response samples

Content type

application/json

{"version": "v3.0.1"
}

ログインユーザー情報取得

処理概要

ログインユーザー自身のユーザー情報を取得する

Exment権限(Permission)

なし

APIスコープ(scope)

対応バージョン

v1.1.0

Authorizations:

OAuth2認証

Responses

Response samples

Content type

application/json

{"id": 1,
"suuid": "b6ba6222ebb2aa455521",
"parent_type": null,
"parent_id": null,
"value": {"email": "admin@foobar.test",
"user_code": "admin",
"user_name": "admin"
},
"created_at": "2019-11-13 17:00:38",
"updated_at": "2019-11-13 17:06:11",
"deleted_at": null,
"deleted_user_id": null,
"created_user_id": null,
"updated_user_id": "1",
"label": "admin"
}

ログインユーザーのアバター取得

処理概要

ログインユーザー自身のアバター画像を取得する
アバターがない場合、クエリ文字列"default"が1であれば、デフォルト画像を返却する。それ以外は、nullを返却する
戻り値は、クエリ文字列"base64"が1であれば、base64形式のjson。それ以外は、画像のバイナリファイル

Exment権限(Permission)

なし

APIスコープ(scope)

対応バージョン

v4.2.7

Authorizations:

OAuth2認証

query Parameters

default	integer 1の場合で、ユーザーのアバターがない場合、デフォルト画像を返却する
base64	string 1の場合、レスポンスをbase64形式に変換したjsonで返却。それ以外はバイナリファイルで返却

Responses

Response samples

Content type

No sample

テーブル

カスタムテーブル一覧

処理概要

カスタムテーブル一覧を取得する
ログインユーザーがアクセスできるテーブルのみ、一覧として取得できる

Exment権限(Permission)

システム_システム情報
システム_カスタムテーブル
システム_すべてのデータ
テーブル_テーブル
テーブル_すべてのデータの編集
テーブル_すべてのデータの閲覧
テーブル_すべてのデータの参照
テーブル_担当者データの編集
テーブル_担当者データの閲覧
テーブル_担当者データの閲覧

APIスコープ(scope)

table_read
table_write

対応バージョン

v1.1.0 新規追加
v3.0.8 パラメータ「id」「expands」追加

Authorizations:

OAuth2認証

query Parameters

page	integer Default: "1" 取得するページ番号
count	integer [ 1 .. 100 ] Default: "20" 1回のリクエストで取得する件数。1～100
id	string 取得したいテーブルの、ID絞り込みを行う場合設定。カンマ区切り
expands	string テーブルに紐づく、カスタム列一覧を取得可能。"columns"を指定可能

Responses

Response samples

Content type

application/json

{"current_page": 1,
"data": [{"id": 3,
"suuid": "4131b102c1c3f3879114",
"table_name": "base_info",
"table_view_name": "基本情報",
"description": null,
"system_flg": "1",
"showlist_flg": "1",
"order": "0",
"options": {"icon": "fa-building",
"comment_flg": "0",
"attachment_flg": "0",
"one_record_flg": "1",
"search_enabled": "0",
"all_user_accessable_flg": "1"
},
"created_at": "2019-11-13 17:00:11",
"updated_at": "2019-11-13 17:00:11",
"created_user_id": null,
"updated_user_id": null
},
{"id": 4,
"suuid": "54e448bbd64731a061aa",
"table_name": "user",
"table_view_name": "ユーザー",
"description": null,
"system_flg": "1",
"showlist_flg": "1",
"order": "0",
"options": {"icon": "fa-user",
"comment_flg": "0",
"attachment_flg": "0",
"one_record_flg": "0",
"search_enabled": "1",
"all_user_accessable_flg": "1"
},
"created_at": "2019-11-13 17:00:11",
"updated_at": "2019-11-13 17:00:11",
"created_user_id": null,
"updated_user_id": null
},
{"id": 5,
"suuid": "e338ce723f7da614d377",
"table_name": "organization",
"table_view_name": "組織",
"description": null,
"system_flg": "1",
"showlist_flg": "1",
"order": "0",
"options": {"icon": "fa-sitemap",
"comment_flg": "0",
"attachment_flg": "0",
"one_record_flg": "0",
"search_enabled": "1",
"all_user_accessable_flg": "1"
},
"created_at": "2019-11-13 17:00:11",
"updated_at": "2019-11-13 17:00:11",
"created_user_id": null,
"updated_user_id": null
}
],
"first_page_url": "http://localhost/admin/api/table?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost/admin/api/table?page=1",
"next_page_url": null,
"path": "http://localhost/admin/api/table",
"per_page": 20,
"prev_page_url": null,
"to": 11,
"total": 11
}

カスタムテーブル情報取得

処理概要

カスタムテーブルのIDもしくはテーブル名を指定し、そのカスタムテーブル内のカスタム列情報一覧を取得する
ログインユーザーがアクセスできないテーブルの場合、403エラーが発生する

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧
テーブル：担当者データの閲覧

APIスコープ(scope)

table_read
table_write

対応バージョン

v1.1.0

Authorizations:

OAuth2認証

path Parameters

tableKey

required

string

カスタムテーブルのID(Ex. 3)、もしくはテーブル名(Ex. user)

Responses

Response samples

Content type

application/json

{"id": 8,
"suuid": "5c86fb70562dd56f34c0",
"table_name": "information",
"table_view_name": "お知らせ",
"description": "ユーザーに通知するお知らせです。ダッシュボードなどに表示することができます。",
"system_flg": "0",
"showlist_flg": "1",
"order": "0",
"options": {"icon": "fa-exclamation",
"comment_flg": "0",
"revision_flg": "0",
"attachment_flg": "1",
"one_record_flg": "0",
"search_enabled": "1",
"use_label_id_flg": "0",
"all_user_editable_flg": "0",
"all_user_viewable_flg": "1",
"all_user_accessable_flg": "1"
},
"created_at": "2019-11-13 17:00:11",
"updated_at": "2019-11-13 17:08:31",
"created_user_id": null,
"updated_user_id": "1"
}

カスタムテーブル内のカスタム列一覧取得

処理概要

カスタムテーブルのIDもしくはテーブル名を指定し、そのカスタムテーブル内のカスタム列情報一覧を取得する
ログインユーザーがアクセスできないテーブルの場合、403エラーが発生する

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧
テーブル：担当者データの閲覧

APIスコープ(scope)

table_read
table_write

対応バージョン

v1.1.0

Authorizations:

OAuth2認証

path Parameters

tableKey

required

any

カスタムテーブルのID(Ex. 3)、もしくはテーブル名(Ex. user)

Responses

Response samples

Content type

application/json

[{"id": 45,
"suuid": "9ce2740b044ea7143a55",
"custom_table_id": "8",
"column_name": "title",
"column_view_name": "タイトル",
"column_type": "text",
"description": null,
"system_flg": "0",
"order": "0",
"options": {"required": "1",
"index_enabled": "1"
},
"created_at": "2019-11-13 17:00:11",
"updated_at": "2019-11-13 17:00:15",
"created_user_id": null,
"updated_user_id": null,
"required": "1",
"index_enabled": "1",
"unique": false,
"custom_table": {"id": 8,
"suuid": "5c86fb70562dd56f34c0",
"table_name": "information",
"table_view_name": "お知らせ",
"description": "ユーザーに通知するお知らせです。ダッシュボードなどに表示することができます。",
"system_flg": "0",
"showlist_flg": "1",
"order": "0",
"options": {"icon": "fa-exclamation",
"comment_flg": "0",
"revision_flg": "0",
"attachment_flg": "1",
"one_record_flg": "0",
"search_enabled": "1",
"use_label_id_flg": "0",
"all_user_editable_flg": "0",
"all_user_viewable_flg": "1",
"all_user_accessable_flg": "1"
},
"created_at": "2019-11-13 17:00:11",
"updated_at": "2019-11-13 17:08:31",
"created_user_id": null,
"updated_user_id": "1"
}
},
{"id": 46,
"suuid": "c5ade37d68066e8eb7c4",
"custom_table_id": "8",
"column_name": "body",
"column_view_name": "本文",
"column_type": "editor",
"description": null,
"system_flg": "0",
"order": "0",
"options": {"string_length": "2000"
},
"created_at": "2019-11-13 17:00:11",
"updated_at": "2019-11-13 17:00:11",
"created_user_id": null,
"updated_user_id": null,
"required": false,
"index_enabled": false,
"unique": false,
"custom_table": {"id": 8,
"suuid": "5c86fb70562dd56f34c0",
"table_name": "information",
"table_view_name": "お知らせ",
"description": "ユーザーに通知するお知らせです。ダッシュボードなどに表示することができます。",
"system_flg": "0",
"showlist_flg": "1",
"order": "0",
"options": {"icon": "fa-exclamation",
"comment_flg": "0",
"revision_flg": "0",
"attachment_flg": "1",
"one_record_flg": "0",
"search_enabled": "1",
"use_label_id_flg": "0",
"all_user_editable_flg": "0",
"all_user_viewable_flg": "1",
"all_user_accessable_flg": "1"
},
"created_at": "2019-11-13 17:00:11",
"updated_at": "2019-11-13 17:08:31",
"created_user_id": null,
"updated_user_id": "1"
}
}
]

カスタム列情報取得

処理概要

カスタム列のIDから、カスタム列情報を取得する。
ログインユーザーがアクセスできないカスタムテーブルの列だった場合、403エラーが発生する。

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

table_read
table_write

対応バージョン

v1.1.0

Authorizations:

OAuth2認証

path Parameters

required

integer

カスタム列ID

Responses

Response samples

Content type

application/json

{"id": 45,
"suuid": "9ce2740b044ea7143a55",
"custom_table_id": "8",
"column_name": "title",
"column_view_name": "タイトル",
"column_type": "text",
"description": null,
"system_flg": "0",
"order": "0",
"options": {"required": "1",
"index_enabled": "1"
},
"created_at": "2019-11-13 17:00:11",
"updated_at": "2019-11-13 17:00:15",
"created_user_id": null,
"updated_user_id": null,
"required": "1",
"index_enabled": "1",
"unique": false
}

カスタム列情報取得(テーブル名・列名指定)

処理概要

テーブル名・カスタム列名から、カスタム列情報を取得する。
ログインユーザーがアクセスできないカスタムテーブルの列だった場合、403エラーが発生する。

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

table_read
table_write

対応バージョン

v3.1.12

Authorizations:

OAuth2認証

path Parameters

tableKey required	string カスタムテーブルのID(Ex. 3)、もしくはテーブル名(Ex. user)
columnKey required	string カスタム列名(Ex. user_code)

Responses

Response samples

Content type

application/json

{"id": 45,
"suuid": "9ce2740b044ea7143a55",
"custom_table_id": "8",
"column_name": "title",
"column_view_name": "タイトル",
"column_type": "text",
"description": null,
"system_flg": "0",
"order": "0",
"options": {"required": "1",
"index_enabled": "1"
},
"created_at": "2019-11-13 17:00:11",
"updated_at": "2019-11-13 17:00:15",
"created_user_id": null,
"updated_user_id": null,
"required": "1",
"index_enabled": "1",
"unique": false
}

ビュー

カスタムビュー情報取得

処理概要

ビューidもしくはsuuidから、ビュー情報を取得する
ログインユーザーがアクセスできないカスタムテーブルのビューだった場合、403エラーが発生する。
現在、ビュー列やビューフィルタなどの取得はできません。「カスタムデータ一覧取得(ビュー使用)」や「カスタムデータ情報取得(ビュー使用)」で、ビューを指定するために実行してください。

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

view_read

対応バージョン

v3.3.X

path Parameters

required

string

カスタムテーブルのID(Ex. 3)、もしくはsuuid(20桁の文字列)

Responses

Response samples

Content type

application/json

{"id": 10,
"suuid": "3d62f5b9ea3241e6a417",
"custom_table_id": "8",
"view_type": "0",
"view_kind_type": "9",
"view_view_name": "View Sample",
"created_at": "2020-06-16 00:24:20",
"updated_at": "2020-06-16 00:24:20",
"created_user_id": "10",
"updated_user_id": "10"
}

カスタムテーブル内のカスタムビュー一覧取得

処理概要

カスタムテーブルのIDもしくはテーブル名を指定し、そのカスタムテーブル内のカスタムビュー一覧を取得する
ログインユーザーがアクセスできないテーブルの場合、403エラーが発生する
現在、ビュー列やビューフィルタなどの取得はできません。「カスタムデータ一覧取得(ビュー使用)」や「カスタムデータ情報取得(ビュー使用)」で、ビューを指定するために実行してください。

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧
テーブル：担当者データの閲覧

APIスコープ(scope)

view_read

対応バージョン

v3.3.X

Authorizations:

OAuth2認証

path Parameters

tableKey

required

any

カスタムテーブルのID(Ex. 3)、もしくはテーブル名(Ex. user)

query Parameters

view_type	string 指定した場合、ビュー権限で絞り込みを行う。 0=システムビュー、1=ユーザービュー
view_kind_type	string 指定した場合、ビュー種類で絞り込みを行う。 0=通常ビュー、1=集計ビュー、2=カレンダービュー、3=条件ビュー、9=全件ビュー
view_view_name	string 指定した場合、ビュー表示名で絞り込みを行う

Responses

Response samples

Content type

application/json

[{"id": 45,
"suuid": "9ce2740b044ea7143a55",
"custom_table_id": "8",
"column_name": "title",
"column_view_name": "タイトル",
"column_type": "text",
"description": null,
"system_flg": "0",
"order": "0",
"options": {"required": "1",
"index_enabled": "1"
},
"created_at": "2019-11-13 17:00:11",
"updated_at": "2019-11-13 17:00:15",
"created_user_id": null,
"updated_user_id": null,
"required": "1",
"index_enabled": "1",
"unique": false,
"custom_table": {"id": 8,
"suuid": "5c86fb70562dd56f34c0",
"table_name": "information",
"table_view_name": "お知らせ",
"description": "ユーザーに通知するお知らせです。ダッシュボードなどに表示することができます。",
"system_flg": "0",
"showlist_flg": "1",
"order": "0",
"options": {"icon": "fa-exclamation",
"comment_flg": "0",
"revision_flg": "0",
"attachment_flg": "1",
"one_record_flg": "0",
"search_enabled": "1",
"use_label_id_flg": "0",
"all_user_editable_flg": "0",
"all_user_viewable_flg": "1",
"all_user_accessable_flg": "1"
},
"created_at": "2019-11-13 17:00:11",
"updated_at": "2019-11-13 17:08:31",
"created_user_id": null,
"updated_user_id": "1"
}
},
{"id": 46,
"suuid": "c5ade37d68066e8eb7c4",
"custom_table_id": "8",
"column_name": "body",
"column_view_name": "本文",
"column_type": "editor",
"description": null,
"system_flg": "0",
"order": "0",
"options": {"string_length": "2000"
},
"created_at": "2019-11-13 17:00:11",
"updated_at": "2019-11-13 17:00:11",
"created_user_id": null,
"updated_user_id": null,
"required": false,
"index_enabled": false,
"unique": false,
"custom_table": {"id": 8,
"suuid": "5c86fb70562dd56f34c0",
"table_name": "information",
"table_view_name": "お知らせ",
"description": "ユーザーに通知するお知らせです。ダッシュボードなどに表示することができます。",
"system_flg": "0",
"showlist_flg": "1",
"order": "0",
"options": {"icon": "fa-exclamation",
"comment_flg": "0",
"revision_flg": "0",
"attachment_flg": "1",
"one_record_flg": "0",
"search_enabled": "1",
"use_label_id_flg": "0",
"all_user_editable_flg": "0",
"all_user_viewable_flg": "1",
"all_user_accessable_flg": "1"
},
"created_at": "2019-11-13 17:00:11",
"updated_at": "2019-11-13 17:08:31",
"created_user_id": null,
"updated_user_id": "1"
}
}
]

データ

カスタムデータ一覧取得

処理概要

特定のカスタムテーブルに登録している、カスタムデータの一覧を取得する
ログインユーザーに権限のあるデータのみ、一覧の対象となる
取得されるvalue配列の形式や型については、こちらをご参照ください

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

value_read
value_write

対応バージョン

v1.1.0 新規作成
v3.1.2 labelパラメータ追加。1のとき、結果にlabelを追加します。
v3.1.7 valuetypeパラメータ追加
v5.0.1 childrenパラメータ追加

リレーションの子データを取得する場合

childrenパラメータが1のとき、そのデータの子データも同時に取得する。
※カスタムリレーション設定が行われている場合のみ利用可。カスタム列の「選択肢 (他のテーブルの値一覧から選択)」は取得不可
"data"配列に"children"が追加され、その中に、該当の子テーブルのデータ一覧が追加される。
その時の戻り値の例は、以下のようになる。(一部割愛)　ここでは、子テーブルは"child_table"としている。

{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "suuid": "a1b2f1fc0e564e3e2ece",
      "parent_type": null,
      "parent_id": null,
      "value": {
        "date": "2022-07-30",
        "text": "test_1",
        "user": "1",
        "email": "foovartest1@test.com.test"
      },
      "created_at": "2022-07-29 09:35:42",
      "updated_at": "2022-07-29 09:35:42",
      "deleted_at": null,
      "deleted_user_id": null,
      "created_user_id": "1",
      "updated_user_id": "1",
      "children": {
        "child_table": [
          {
            "id": 1,
            "suuid": "c7751f097aa5e0a6091c",
            "parent_type": "parent_table",
            "parent_id": "1",
            "value": {
              "date": "2022-07-30",
              "text": "test_1",
              "user": "1",
              "email": "foovartest1@test.com.test"
            },
            "created_at": "2022-07-29 09:35:44",
            "updated_at": "2022-07-29 09:35:44",
            "deleted_at": null,
            "deleted_user_id": null,
            "created_user_id": "1",
            "updated_user_id": "1"
          },
          {
            "id": 11,
            "suuid": "17e2f47ebf89e6b09c0a",
            "parent_type": "parent_table",
            "parent_id": "1",
            "value": {
              "date": "2022-07-31",
              "text": "test_2",
              "user": "2",
              "email": "foovartest1@test.com.test"
            },
            "created_at": "2022-07-29 09:35:44",
            "updated_at": "2022-07-29 09:35:44",
            "deleted_at": null,
            "deleted_user_id": null,
            "created_user_id": "2",
            "updated_user_id": "2"
          }
        ]
      }
    }
  ]
}

Authorizations:

OAuth2認証

path Parameters

tableKey

required

string

テーブル名(Ex. information)

query Parameters

page	integer Default: "1" 取得するページ番号
count	integer [ 1 .. 100 ] Default: "20" 1回のリクエストで取得する件数。1～100
orderby	string データの並べ替えを行う場合、並べ替えの列名。複数ある場合はカンマ区切り。逆順は、「id desc」のように半角スペースを追加する
id	string 取得したいデータの、ID絞り込みを行う場合設定。カンマ区切り
label	integer Default: "0" 結果にlabelを含めるかどうか。1の場合含める(※速度が若干遅くなります)
valuetype	string 返却する値の種類。"text"の場合、画面に表示する文言を返却する
children	integer 1のとき、そのデータの子データも同時に取得する。※カスタムリレーション設定が行われている場合のみ利用可。カスタム列の「選択肢 (他のテーブルの値一覧から選択)」は取得不可

Responses

Response samples

Content type

application/json

{"current_page": 1,
"data": [{"id": 8,
"suuid": "946a85f121a7d9b2ab72",
"parent_type": null,
"parent_id": null,
"value": {"body": "テストです。",
"order": "1",
"title": "テスト",
"priority": 3,
"view_flg": 1
},
"created_at": "2019-11-15 16:44:41",
"updated_at": "2019-11-15 16:44:41",
"deleted_at": null,
"deleted_user_id": null,
"created_user_id": null,
"updated_user_id": null,
"label": "テスト"
},
{"id": 9,
"suuid": "4c7944646420b5b5c0d3",
"parent_type": null,
"parent_id": null,
"value": {"body": "テストです。",
"order": "1",
"title": "テスト",
"priority": 3,
"view_flg": 1
},
"created_at": "2019-11-15 16:48:46",
"updated_at": "2019-11-15 16:48:46",
"deleted_at": null,
"deleted_user_id": null,
"created_user_id": "1",
"updated_user_id": "1",
"label": "テスト"
},
{"id": 10,
"suuid": "1001025f0f3715dbc80b",
"parent_type": null,
"parent_id": null,
"value": {"body": "テストです。",
"order": "1",
"title": "テスト",
"priority": 3,
"view_flg": 1
},
"created_at": "2019-11-15 17:41:54",
"updated_at": "2019-11-15 17:41:54",
"deleted_at": null,
"deleted_user_id": null,
"created_user_id": "1",
"updated_user_id": "1",
"label": "テスト"
}
],
"first_page_url": "http://localhost/admin/api/data/information?count=20&page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost/admin/api/data/information?count=20&page=1",
"next_page_url": null,
"path": "http://localhost/admin/api/data/information",
"per_page": 20,
"prev_page_url": null,
"to": 3,
"total": 3
}

カスタムデータ新規作成

処理概要

カスタムテーブルに、データを新規作成する
ログインユーザーがカスタムテーブルに新規追加する権限のない場合、403エラーが発生する
登録を行いたいデータは、value配列内に値を代入してPOSTする。送信値の形式や型については、こちらをご参照ください

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：担当者データの編集

APIスコープ(scope)

value_write

対応バージョン

v1.1.0 対応
v3.1.0 複数件登録、ならびに親データを指定しての新規追加に対応。ならびに、画像・ファイル列へのファイル保存に対応
v3.1.2 labelパラメータ追加。1のとき、結果にlabelを追加します。
v3.1.7 valuetypeパラメータ追加

ファイル・画像列にファイルを保存する場合

以下のように、value->(ファイル・画像列)に、ファイル名・ファイルのbase64文字列を指定してください。

{
   "value": {
        "title": "test",
        "file": {
            "name" : "hello.txt",
            "base64" : "aGVsbG8gV29ybGQhIExldCdzIGVuam95IEV4bWVudCE=""
        }
    }
}

親データを指定する場合

parent_idとparent_typeを設定することで、親データを登録することができる
前提条件として「1:nのリレーションが設定されている」「親データがすでに登録済である」こと

{
   "parent_type": "contract",
   "parent_id": 2
   "value": {
        "num": 10,
        "price": 10000
    }
}

複数件登録する場合

POSTデータを、配列で複数件送信することで、複数データを登録することができる
1件でもエラーが発生した場合は、すべてのデータを登録しない
1度に登録できる件数は100件まで
配列の指定方法は2パターン存在するが、機能に差異はない

■パターン１：

{
   "value": [
      {
        "parent_type": "contract",
        "parent_id": 2
        "num": 10,
        "price": 10000
      },
      {
        "parent_type": "contract",
        "parent_id": 5
        "num": 3,
        "price": 8000
      }
    ]
}

■パターン２：

{
   "data": [
     {
        "parent_type": "contract",
        "parent_id": 2
        "value":{
          "num": 10,
          "price": 10000
        }
     },
     {
        "parent_type": "contract",
        "parent_id": 5
        "value":{
          "num": 3,
          "price": 8000
        }
      }
    ]
}

カスタム列の種類が「選択肢 (他のテーブルの値一覧から選択)」で、id以外をキーとして新規作成を行いたい場合

パラメータ「findKeys」を追加することにより、id以外の値をキーとできます。
例：「契約」テーブルのカスタムデータを登録時、列「顧客(customer)」のデータを、「顧客」テーブル内の「顧客名(customer_code)」を使用したい場合

■通常時：

{
    value: {
        'contract_code': 'C00001',
        'customer': '1'
    }
}

■findKeys使用時：

{
    value: {
        'contract_code': 'C00001',
        'customer': 'CompABC'
    },
    findKeys: {
        'customer': 'customer_name'
    }
}

Authorizations:

OAuth2認証

path Parameters

tableKey

required

string

テーブル名(Ex. information)

Request Body schema: application/json

	object or Array of objects ※1件登録するか、複数件登録するかで、送信するパラメータが変更になる
	object カスタム列の種類が「選択肢 (他のテーブルの値一覧から選択)」で、id以外をキーとして新規作成を行いたい場合。項目は、登録するテーブルのカスタム列に合わせる
	Array of objects 複数件登録時、かつvalueを設定しない場合のみ指定可能
parent_type	string 親テーブル名。登録データが1件で親データを指定する場合のみ指定する
parent_id	integer 親テーブルのデータID。登録データが1件で親データを指定する場合のみ指定する
label	integer Default: 0 結果にlabelを含めるかどうか。1の場合含める(※速度が若干遅くなります)

Responses

Request samples

Payload

Content type

application/json

{"value": {"body": "テストです。",
"order": "1",
"title": "テスト",
"priority": 3,
"view_flg": 1
}
}

Response samples

Content type

application/json

Example

{"id": 8,
"suuid": "946a85f121a7d9b2ab72",
"parent_type": null,
"parent_id": null,
"value": {"body": "テストです。",
"order": "1",
"title": "テスト",
"priority": 3,
"view_flg": 1
},
"created_at": "2019-11-15 16:44:41",
"updated_at": "2019-11-15 16:44:41",
"deleted_at": null,
"deleted_user_id": null,
"created_user_id": "1",
"updated_user_id": "1",
"label": "テスト"
}

カスタムデータ検索

処理概要

特定のカスタムテーブルに登録している、カスタムデータを検索する
ログインユーザーに権限のあるデータのみ、一覧の対象となる
「検索インデックス」に登録している列が、検索対象列となる
検索は前方一致。全文一致で検索を行いたい場合は、こちらに従い、設定が必要
取得されるvalue配列の形式や型については、こちらをご参照ください

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

value_read
value_write

対応バージョン

v2.1.6 追加
v3.1.2 labelパラメータ追加。1のとき、結果にlabelを追加します。
v3.1.7 valuetypeパラメータ追加
v5.0.1 childrenパラメータ追加

リレーションの子データを取得する場合

{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "suuid": "a1b2f1fc0e564e3e2ece",
      "parent_type": null,
      "parent_id": null,
      "value": {
        "date": "2022-07-30",
        "text": "test_1",
        "user": "1",
        "email": "foovartest1@test.com.test"
      },
      "created_at": "2022-07-29 09:35:42",
      "updated_at": "2022-07-29 09:35:42",
      "deleted_at": null,
      "deleted_user_id": null,
      "created_user_id": "1",
      "updated_user_id": "1",
      "children": {
        "child_table": [
          {
            "id": 1,
            "suuid": "c7751f097aa5e0a6091c",
            "parent_type": "parent_table",
            "parent_id": "1",
            "value": {
              "date": "2022-07-30",
              "text": "test_1",
              "user": "1",
              "email": "foovartest1@test.com.test"
            },
            "created_at": "2022-07-29 09:35:44",
            "updated_at": "2022-07-29 09:35:44",
            "deleted_at": null,
            "deleted_user_id": null,
            "created_user_id": "1",
            "updated_user_id": "1"
          },
          {
            "id": 11,
            "suuid": "17e2f47ebf89e6b09c0a",
            "parent_type": "parent_table",
            "parent_id": "1",
            "value": {
              "date": "2022-07-31",
              "text": "test_2",
              "user": "2",
              "email": "foovartest1@test.com.test"
            },
            "created_at": "2022-07-29 09:35:44",
            "updated_at": "2022-07-29 09:35:44",
            "deleted_at": null,
            "deleted_user_id": null,
            "created_user_id": "2",
            "updated_user_id": "2"
          }
        ]
      }
    }
  ]
}

Authorizations:

OAuth2認証

path Parameters

tableKey

required

string

テーブル名(Ex. information)

query Parameters

q required	string 検索文字列
page	integer Default: "1" 取得するページ番号
count	integer [ 1 .. 100 ] Default: "20" 1回のリクエストで取得する件数。1～100
label	integer Default: "0" 結果にlabelを含めるかどうか。1の場合含める(※速度が若干遅くなります)
valuetype	string 返却する値の種類。"text"の場合、画面に表示する文言を返却する
children	integer 1のとき、そのデータの子データも同時に取得する。※カスタムリレーション設定が行われている場合のみ利用可。カスタム列の「選択肢 (他のテーブルの値一覧から選択)」は取得不可

Responses

Response samples

Content type

application/json

{"current_page": 1,
"data": [{"id": 1,
"suuid": "39c97ba08c6e392a125a",
"parent_type": null,
"parent_id": null,
"value": {"body": "<p>Exmentは、かんたん、お手頃なデータ管理Webシステムです。&nbsp;</p>",
"order": "5",
"title": "Exmentへようこそ！",
"priority": "3",
"view_flg": "1"
},
"created_at": "2019-01-04 18:48:15",
"updated_at": "2019-01-04 19:50:55",
"deleted_at": null,
"deleted_user_id": null,
"created_user_id": null,
"updated_user_id": null,
"label": "Exmentへようこそ！",
"workflow_value": null
}
],
"first_page_url": "http://localhost/admin/api/data/information/query?q=Exment&count=20&page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost/admin/api/data/information/query?q=Exment&count=20&page=1",
"next_page_url": null,
"path": "http://localhost/admin/api/data/information/query",
"per_page": 20,
"prev_page_url": null,
"to": 1,
"total": 1
}

カスタムデータ検索(列指定)

処理概要

特定のカスタムテーブルに登録している、カスタムデータを検索する
ログインユーザーに権限のあるデータのみ、一覧の対象となる
カスタム列ごとに検索条件と値を指定する。それぞれの検索条件がすべて合致した場合に、検索を実行する
取得されるvalue配列の形式や型については、こちらをご参照ください

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

value_read
value_write

対応バージョン

v3.0.8 追加
v3.1.2 labelパラメータ追加。1のとき、結果にlabelを追加します。
v3.1.7 valuetypeパラメータ追加
v3.3.2 検索条件に"like"追加。OR検索に対応、orderbyパラメータの追加
v5.0.1 childrenパラメータ追加

検索条件の指定方法

パラメータ「q」に、それぞれの列名を指定して検索する。複数の列を指定する場合は、カンマ区切りを行う。
検索条件は、以下のものに対応している。
- eq : 完全一致
- ne : 一致しない
- gt : より上
- gte : 以上
- lt : より下
- lte : 以下
- like : LIKE検索。値に"%"使用可能
クエリの設定方法は、"(列名) eq (検索値)"となる。
※URLエンコードは行うこと
複数の検索値で検索を行う場合、通常はAND検索を行う。パラメータ「or=1」を指定した場合、OR検索となる。

■例1：お知らせ(information)テーブルで、"表示フラグ(view_flg)"が"1"のデータ一覧を取得する場合

// URLエンコードは行うこと
/api/data/information/query-column?q=view_flg eq 1

■例2：お知らせ(information)テーブルで、"表示フラグ(view_flg)"が"1"、"タイトル(title)"が"テスト"のデータ一覧を取得する場合

// URLエンコードは行うこと
/api/data/information/query-column?q=view_flg eq 1,title eq テスト

■例3：お知らせ(information)テーブルで、"表示フラグ(view_flg)"が"1"、または"タイトル(title)"が"テスト"のデータ一覧を取得する場合

// URLエンコードは行うこと
/api/data/information/query-column?q=view_flg eq 1,title eq テスト&or=1

リレーションの子データを取得する場合

{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "suuid": "a1b2f1fc0e564e3e2ece",
      "parent_type": null,
      "parent_id": null,
      "value": {
        "date": "2022-07-30",
        "text": "test_1",
        "user": "1",
        "email": "foovartest1@test.com.test"
      },
      "created_at": "2022-07-29 09:35:42",
      "updated_at": "2022-07-29 09:35:42",
      "deleted_at": null,
      "deleted_user_id": null,
      "created_user_id": "1",
      "updated_user_id": "1",
      "children": {
        "child_table": [
          {
            "id": 1,
            "suuid": "c7751f097aa5e0a6091c",
            "parent_type": "parent_table",
            "parent_id": "1",
            "value": {
              "date": "2022-07-30",
              "text": "test_1",
              "user": "1",
              "email": "foovartest1@test.com.test"
            },
            "created_at": "2022-07-29 09:35:44",
            "updated_at": "2022-07-29 09:35:44",
            "deleted_at": null,
            "deleted_user_id": null,
            "created_user_id": "1",
            "updated_user_id": "1"
          },
          {
            "id": 11,
            "suuid": "17e2f47ebf89e6b09c0a",
            "parent_type": "parent_table",
            "parent_id": "1",
            "value": {
              "date": "2022-07-31",
              "text": "test_2",
              "user": "2",
              "email": "foovartest1@test.com.test"
            },
            "created_at": "2022-07-29 09:35:44",
            "updated_at": "2022-07-29 09:35:44",
            "deleted_at": null,
            "deleted_user_id": null,
            "created_user_id": "2",
            "updated_user_id": "2"
          }
        ]
      }
    }
  ]
}

Authorizations:

OAuth2認証

path Parameters

tableKey

required

string

テーブル名(Ex. information)

query Parameters

q required	string 検索文字列。クエリ検索の指定方法は、上記の例を参考にすること
page	integer Default: "1" 取得するページ番号
count	integer [ 1 .. 100 ] Default: "20" 1回のリクエストで取得する件数。1～100
label	integer Default: "0" 結果にlabelを含めるかどうか。1の場合含める(※速度が若干遅くなります)
valuetype	string 返却する値の種類。"text"の場合、画面に表示する文言を返却する
or	integer 複数列で検索を行う場合で、1とした場合、OR検索を行う
orderby	string データの並べ替えを行う場合、並べ替えの列名。複数ある場合はカンマ区切り。逆順は、「id desc」のように半角スペースを追加する
children	integer 1のとき、そのデータの子データも同時に取得する。※カスタムリレーション設定が行われている場合のみ利用可。カスタム列の「選択肢 (他のテーブルの値一覧から選択)」は取得不可

Responses

Response samples

Content type

application/json

{"current_page": 1,
"data": [{"id": 1,
"suuid": "39c97ba08c6e392a125a",
"parent_type": null,
"parent_id": null,
"value": {"body": "<p>Exmentは、かんたん、お手頃なデータ管理Webシステムです。&nbsp;</p>",
"order": "5",
"title": "Exmentへようこそ！",
"priority": "3",
"view_flg": "1"
},
"created_at": "2019-01-04 18:48:15",
"updated_at": "2019-01-04 19:50:55",
"deleted_at": null,
"deleted_user_id": null,
"created_user_id": null,
"updated_user_id": null,
"label": "Exmentへようこそ！",
"workflow_value": null
}
],
"first_page_url": "http://localhost/admin/api/data/information/query?q=Exment&count=20&page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost/admin/api/data/information/query?q=Exment&count=20&page=1",
"next_page_url": null,
"path": "http://localhost/admin/api/data/information/query",
"per_page": 20,
"prev_page_url": null,
"to": 1,
"total": 1
}

カスタムデータ情報取得

処理概要

特定のカスタムテーブルに登録している、カスタムデータ情報を取得する
ログインユーザーに権限のないデータだった場合、403エラーが発生する
取得されるvalue配列の形式や型については、こちらをご参照ください

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

value_read
value_write

対応バージョン

v1.1.0 追加
v3.1.2 labelパラメータ追加。1のとき、結果にlabelを追加します。
v3.1.7 valuetypeパラメータ追加
v5.0.1 childrenパラメータ追加

リレーションの子データを取得する場合

childrenパラメータが1のとき、そのデータの子データも同時に取得する。
※カスタムリレーション設定が行われている場合のみ利用可。カスタム列の「選択肢 (他のテーブルの値一覧から選択)」は取得不可
配列の直下に"children"が追加され、その中に、該当の子テーブルのデータ一覧が追加される。
その時の戻り値の例は、以下のようになる。(一部割愛)　ここでは、子テーブルは"child_table"としている。

{
  "id": 1,
  "suuid": "a1b2f1fc0e564e3e2ece",
  "parent_type": null,
  "parent_id": null,
  "value": {
    "date": "2022-07-30",
    "text": "test_1",
    "user": "1",
    "email": "foovartest1@test.com.test"
  },
  "created_at": "2022-07-29 09:35:42",
  "updated_at": "2022-07-29 09:35:42",
  "deleted_at": null,
  "deleted_user_id": null,
  "created_user_id": "1",
  "updated_user_id": "1",
  "children": {
    "child_table": [
      {
        "id": 1,
        "suuid": "c7751f097aa5e0a6091c",
        "parent_type": "parent_table",
        "parent_id": "1",
        "value": {
          "date": "2022-07-30",
          "text": "test_1",
          "user": "1",
          "email": "foovartest1@test.com.test"
        },
        "created_at": "2022-07-29 09:35:44",
        "updated_at": "2022-07-29 09:35:44",
        "deleted_at": null,
        "deleted_user_id": null,
        "created_user_id": "1",
        "updated_user_id": "1"
      },
      {
        "id": 11,
        "suuid": "17e2f47ebf89e6b09c0a",
        "parent_type": "parent_table",
        "parent_id": "1",
        "value": {
          "date": "2022-07-31",
          "text": "test_2",
          "user": "2",
          "email": "foovartest1@test.com.test"
        },
        "created_at": "2022-07-29 09:35:44",
        "updated_at": "2022-07-29 09:35:44",
        "deleted_at": null,
        "deleted_user_id": null,
        "created_user_id": "2",
        "updated_user_id": "2"
      }
    ]
  }
}

Authorizations:

OAuth2認証

path Parameters

tableKey required	string テーブル名(Ex. information)
id required	string カスタムデータのID

query Parameters

label	integer Default: "0" 結果にlabelを含めるかどうか。1の場合含める(※速度が若干遅くなります)
valuetype	string 返却する値の種類。"text"の場合、画面に表示する文言を返却する
children	integer 1のとき、そのデータの子データも同時に取得する。※カスタムリレーション設定が行われている場合のみ利用可。カスタム列の「選択肢 (他のテーブルの値一覧から選択)」は取得不可

Responses

Response samples

Content type

application/json

{"id": 8,
"suuid": "946a85f121a7d9b2ab72",
"parent_type": null,
"parent_id": null,
"value": {"body": "テストです。",
"order": "1",
"title": "テスト",
"priority": 3,
"view_flg": 1
},
"created_at": "2019-11-15 16:44:41",
"updated_at": "2019-11-15 16:44:41",
"deleted_at": null,
"deleted_user_id": null,
"created_user_id": null,
"updated_user_id": null,
"label": "テスト"
}

カスタムデータ情報更新

処理概要

カスタムデータ情報を更新する
ログインユーザーに権限のないデータだった場合、403エラーが発生する
更新が発生する列の情報のみ、value配列内に値を代入してPUTする。送信値の形式や型については、こちらをご参照ください
列"updated_at"を行うことで、排他制御を行うことが可能

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：担当者データの編集

APIスコープ(scope)

value_write

対応バージョン

v1.1.0 対応
v3.1.0 画像・ファイル列へのファイル保存に対応
v3.1.2 labelパラメータ追加。1のとき、結果にlabelを追加します。
v3.1.10 排他制御に対応

ファイル・画像列にファイルを保存する場合

以下のように、value->(ファイル・画像列)に、ファイル名・ファイルのbase64文字列を指定してください。
例：ファイル列"file"に、ファイルを保存する場合

{
   "value": {
        "title": "test",
        "file": {
            "name" : "hello.txt",
            "base64" : 'aGVsbG8gV29ybGQhIExldCdzIGVuam95IEV4bWVudCE='
        }
    }
}

カスタム列の種類が「選択肢 (他のテーブルの値一覧から選択)」で、id以外をキーとして更新を行いたい場合

パラメータ「findKeys」を追加することにより、id以外の値をキーとできます。
例：「契約」テーブルのカスタムデータを更新時、列「顧客(customer)」のデータを、「顧客」テーブル内の「顧客名(customer_code)」を使用したい場合

■通常時：

{
    value: {
        "contract_code": "C00001",
        "customer": '1'
    }
}

■findKeys使用時：

{
    value: {
        "contract_code": "C00001",
        "customer": "株式会社ABC"
    },
    findKeys: {
        "customer": "customer_name"
    }
}

親データを指定する場合

parent_idとparent_typeを設定することで、親データを登録することができる
前提条件として「1:nのリレーションが設定されている」「親データがすでに登録済である」こと

{
   "parent_type": "contract",
   "parent_id": 2
   "value": {
        "price": 10000
    }
}

排他制御

updated_at列に日付を追加することで、排他制御を行うことができます。指定した日時と、対象データの最新の更新日時が異なっていた場合、エラーを返却します。

{
   "value": {
        "price": 10000
    },
    "updated_at": "2020/04/03 12:00:00"
}

Authorizations:

OAuth2認証

path Parameters

tableKey required	string テーブル名(Ex. information)
id required	string カスタムデータのID

Request Body schema: application/json

	object
	object カスタム列の種類が「選択肢 (他のテーブルの値一覧から選択)」で、id以外をキーとして新規作成を行いたい場合。項目は、登録するテーブルのカスタム列に合わせる
parent_type	string 親データを指定する場合のみ
parent_id	integer 親データを指定する場合のみ
label	integer Default: 0 結果にlabelを含めるかどうか。1の場合含める(※速度が若干遅くなります)

Responses

Request samples

Payload

Content type

application/json

{"value": {"body": "テストです。",
"order": "1",
"title": "テスト",
"priority": 3,
"view_flg": 1
}
}

Response samples

Content type

application/json

{"id": 8,
"suuid": "946a85f121a7d9b2ab72",
"parent_type": null,
"parent_id": null,
"value": {"body": "テストです。",
"order": "1",
"title": "テスト更新",
"priority": 3,
"view_flg": 1
},
"created_at": "2019-11-15 16:44:41",
"updated_at": "2019-11-15 18:01:34",
"deleted_at": null,
"deleted_user_id": null,
"created_user_id": null,
"updated_user_id": "1",
"label": "テスト更新"
}

カスタムデータ情報削除

処理概要

カスタムデータ情報を論理削除する
ログインユーザーに権限のないデータだった場合、403エラーが発生する
URLパラメータ{id}は複数件指定可能。その場合、カンマ区切りで指定。複数件を同時に削除する場合、同時に削除できる件数は100件まで
パラメータ"force=1"を追加することで、物理削除を実行する。すでに論理削除しているデータに対しても実施可能

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：担当者データの編集

APIスコープ(scope)

value_write

対応バージョン

v1.1.0 追加
v3.0.13 複数件削除に対応
v4.0.7 データの物理削除に対応

Authorizations:

OAuth2認証

path Parameters

tableKey required	string テーブル名(Ex. information)
id required	string カスタムデータのID

query Parameters

force

integer

1のとき、データの物理削除を実施する

Responses

カスタムデータ一覧取得(ビュー使用)

処理概要

ビューを指定し、そのビューを使用して、データ一覧を取得する
ログインユーザーに権限のあるデータのみ、一覧の対象となる
対応ビュー種類：全件ビュー、通常ビュー、集計ビュー

結果の列名について

ビューを使用して結果を取得する場合、取得対象の列は、さまざまなケースがあります。（例：親テーブルのデータ、グループ化の集計結果）
ビューの設定によっては、列名が重複するケースがあり、列名のキーでは、列の種類が判別できない場合があります。
そのため、json形式で取得される、データ値の列名は、suuid(ランダムの20桁英数字)となっています。
結果のjson"column_definitions"に、対象のsuuidのテーブル名、カスタム列名などの情報がセットされていますので、それらの値から、該当の列情報を分析・取得してください。

例（一部省略）

{
    "current_page": 1,
    "data": [
        {
            "82c58b9bc8a68842c292": null,
            "12fc3d6f970afc5a7f28": "child value 1",
            "6968926f2de4fa658b97": "parent value 1"
        },
        {
            "82c58b9bc8a68842c292": null,
            "12fc3d6f970afc5a7f28": "child value 2",
            "6968926f2de4fa658b97": null
        },
        {
            "82c58b9bc8a68842c292": null,
            "12fc3d6f970afc5a7f28": "child value 1",
            "6968926f2de4fa658b97": null
        }
    ],
    "first_page_url": "http://localhost/admin/api/viewdata/child_table/be8cc0e9cd22f8bf6401?count=20&page=1",
    "total": 7,
    "column_definitions": {
        "82c58b9bc8a68842c292": {
            "table_name": "child_table",
            "column_name": "id",
            "label": "ID"
        },
        "12fc3d6f970afc5a7f28": {
            "table_name": "child_table",
            "column_name": "text",
            "label": "text"
        },
        "6968926f2de4fa658b97": {
            "table_name": "parent_table",
            "column_name": "text",
            "label": "parent_table : text"
        }
    }
}

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

value_read
value_write

対応バージョン

v3.3.X 新規作成

Authorizations:

OAuth2認証

path Parameters

viewId required	string ビューのID(Ex. 2, 5)、もしくはsuuid(Ex. 22e715cf7f4ce5f319f0)
tableKey required	string カスタムテーブルのID(Ex. 3)、もしくはテーブル名(Ex. user)

query Parameters

page	integer Default: "1" 取得するページ番号
count	integer [ 1 .. 100 ] Default: "20" 1回のリクエストで取得する件数。1～100
valuetype	string 返却する値の種類。"text"の場合、画面に表示する文言を返却する

Responses

Response samples

Content type

application/json

{"current_page": 1,
"data": [{"82c58b9bc8a68842c292": null,
"12fc3d6f970afc5a7f28": "test20200616002525",
"6968926f2de4fa658b97": "test_5"
},
{"82c58b9bc8a68842c292": null,
"12fc3d6f970afc5a7f28": "test202006160025261",
"6968926f2de4fa658b97": "test_4"
},
{"82c58b9bc8a68842c292": null,
"12fc3d6f970afc5a7f28": "test202006160025262",
"6968926f2de4fa658b97": "test_4"
},
{"82c58b9bc8a68842c292": null,
"12fc3d6f970afc5a7f28": "test202006160025263",
"6968926f2de4fa658b97": "test_4"
},
{"82c58b9bc8a68842c292": null,
"12fc3d6f970afc5a7f28": "test20200616002531_update",
"6968926f2de4fa658b97": "test_6"
},
{"82c58b9bc8a68842c292": null,
"12fc3d6f970afc5a7f28": "test20200616002531_update",
"6968926f2de4fa658b97": "test_7"
},
{"82c58b9bc8a68842c292": null,
"12fc3d6f970afc5a7f28": "test202006160025273",
"6968926f2de4fa658b97": "test_8"
}
],
"first_page_url": "http://localhost/admin/api/viewdata/child_table/be8cc0e9cd22f8bf6401?count=20&page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost/admin/api/viewdata/child_table/be8cc0e9cd22f8bf6401?count=20&page=1",
"next_page_url": null,
"path": "http://localhost/admin/api/viewdata/child_table/be8cc0e9cd22f8bf6401",
"per_page": 20,
"prev_page_url": null,
"to": 7,
"total": 7,
"column_definitions": {"82c58b9bc8a68842c292": {"table_name": "child_table",
"column_name": "id",
"label": "ID"
},
"12fc3d6f970afc5a7f28": {"table_name": "child_table",
"column_name": "text",
"label": "text"
},
"6968926f2de4fa658b97": {"table_name": "parent_table",
"column_name": "text",
"label": "parent_table : text"
}
}
}

カスタムデータ情報取得(ビュー使用)

処理概要

ビューとデータのIDを指定し、そのビューを使用して、データ情報を取得する
ログインユーザーに権限のあるデータのみ、取得の対象となる
対応ビュー種類：全件ビュー、通常ビュー

結果の列名について

ビューを使用して結果を取得する場合、取得対象の列は、さまざまなケースがあります。（例：親テーブルのデータ、グループ化の集計結果）
ビューの設定によっては、列名が重複するケースがあり、列名のキーでは、列の種類が判別できない場合があります。
そのため、json形式で取得される、データ値の列名は、suuid(ランダムの20桁英数字)となっています。
結果のjson"column_definitions"に、対象のsuuidのテーブル名、カスタム列名などの情報がセットされていますので、それらの値から、該当の列情報を分析・取得してください。

例（一部省略）

{
    "value": {
        "82c58b9bc8a68842c292": null,
        "12fc3d6f970afc5a7f28": "child value 3",
        "6968926f2de4fa658b97": "parent value 1"
    },
    "column_definitions": {
        "82c58b9bc8a68842c292": {
            "table_name": "child_table",
            "column_name": "id",
            "label": "ID"
        },
        "12fc3d6f970afc5a7f28": {
            "table_name": "child_table",
            "column_name": "text",
            "label": "text"
        },
        "6968926f2de4fa658b97": {
            "table_name": "parent_table",
            "column_name": "text",
            "label": "parent_table : text"
        }
    }
}

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

value_read
value_write

対応バージョン

v3.3.X 新規作成

Authorizations:

OAuth2認証

path Parameters

viewId required	string ビューのID(Ex. 2, 5)、もしくはsuuid(Ex. 22e715cf7f4ce5f319f0)
tableKey required	string カスタムテーブルのID(Ex. 3)、もしくはテーブル名(Ex. user)
id required	string データのID

Responses

Response samples

Content type

application/json

{"value": {"82c58b9bc8a68842c292": null,
"12fc3d6f970afc5a7f28": "test20200616002525",
"cd7672e19232308b00bf": 2,
"5e4736ea860fe41d2574": "test20200616002525",
"1787a6afa95fc9059340": null,
"91bbad4146f78dc9faa6": 0,
"846e75fa6b1092e93a35": null,
"cde08af21db3fe8275ca": null,
"5e6b9c251a1ec37543bb": null,
"6968926f2de4fa658b97": "test_5"
},
"column_definitions": {"82c58b9bc8a68842c292": {"table_name": "child_table",
"column_name": "id",
"label": "ID"
},
"12fc3d6f970afc5a7f28": {"table_name": "child_table",
"column_name": "text",
"label": "text"
},
"cd7672e19232308b00bf": {"table_name": "child_table",
"column_name": "user",
"label": "user"
},
"5e4736ea860fe41d2574": {"table_name": "child_table",
"column_name": "index_text",
"label": "index_text"
},
"1787a6afa95fc9059340": {"table_name": "child_table",
"column_name": "odd_even",
"label": "odd_even"
},
"91bbad4146f78dc9faa6": {"table_name": "child_table",
"column_name": "multiples_of_3",
"label": "multiples_of_3"
},
"846e75fa6b1092e93a35": {"table_name": "child_table",
"column_name": "file",
"label": "file"
},
"cde08af21db3fe8275ca": {"table_name": "child_table",
"column_name": "date",
"label": "date"
},
"5e6b9c251a1ec37543bb": {"table_name": "child_table",
"column_name": "init_text",
"label": "init_text"
},
"6968926f2de4fa658b97": {"table_name": "parent_table",
"column_name": "text",
"label": "parent_table : text"
}
}
}

ワークフロー

ワークフロー一覧取得

処理概要

ワークフロー一覧を取得する
「設定完了」が実行されているワークフローのみ、一覧で取得する

Exment権限(Permission)

なし

APIスコープ(scope)

workflow_read
workflow_execute

対応バージョン

v3.0.8

Authorizations:

OAuth2認証

query Parameters

count	integer [ 1 .. 100 ] Default: "20" 1回のリクエストで取得する件数。1～100
all required	integer Default: "0" 1の場合、設定完了されていないワークフローも含める
expands	string ワークフローに紐づく、ステータス設定一覧、アクション設定一覧を取得可能。"statuses"、"actions"を指定可能。複数の場合はカンマ区切り。
id	string 取得したいワークフローの、ID絞り込みを行う場合設定。カンマ区切り

Responses

Response samples

Content type

application/json

{"current_page": 1,
"data": [{"id": 1,
"suuid": "4a6e46c8f716dda2f2a5",
"workflow_type": "0",
"workflow_view_name": "申請フロー",
"start_status_name": "未実施",
"setting_completed_flg": "1",
"created_at": "2019-11-14 13:27:45",
"updated_at": "2019-11-14 16:59:37",
"created_user_id": "1",
"updated_user_id": "1"
},
{"id": 2,
"suuid": "e78c0fdefac9bb91623a",
"workflow_type": "0",
"workflow_view_name": "フロー2",
"start_status_name": "未実施",
"setting_completed_flg": "1",
"created_at": "2019-11-14 17:07:04",
"updated_at": "2019-11-18 13:38:47",
"created_user_id": "1",
"updated_user_id": "1"
}
],
"first_page_url": "http://localhost/admin/webapi/wf/workflow?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost/admin/webapi/wf/workflow?page=1",
"next_page_url": null,
"path": "http://localhost/admin/webapi/wf/workflow",
"per_page": 20,
"prev_page_url": null,
"to": 2,
"total": 2
}

ワークフロー情報取得

処理概要

ワークフローのIDから、ワークフロー情報を取得する

Exment権限(Permission)

なし

APIスコープ(scope)

workflow_read
workflow_execute

対応バージョン

v3.0.8

Authorizations:

OAuth2認証

path Parameters

required

integer

ワークフローID

query Parameters

expands

string

ワークフローに紐づく、ステータス設定一覧、アクション設定一覧を取得可能。"statuses"、"actions"を指定可能。複数の場合はカンマ区切り。

Responses

Response samples

Content type

application/json

{"id": 0,
"workflow_type": 0,
"workflow_view_name": "string",
"start_status_name": "string",
"setting_completed_flg": 0,
"workflow_statuses": [{"id": 0,
"workflow_id": 0,
"status_type": 0,
"status_name": "string",
"datalock_flg": 1,
"completed_flg": 1,
"created_at": "string",
"updated_at": "string",
"updated_user_id": 0,
"created_user_id": 0
}
],
"workflow_actions": [{"id": 0,
"workflow_id": 0,
"status_from": "string",
"action_name": "string",
"ignore_work": 0,
"comment_type": "string",
"flow_next_type": "string",
"flow_next_count": 0,
"work_targets": {"work_target_type": "string",
"system": [0
],
"user": [0
],
"organization": [0
],
"column": [0
]
},
"work_conditions": [{"status_to": null,
"enabled_flg": null
}
]
}
],
"created_at": "string",
"updated_at": "string",
"updated_user_id": 0,
"created_user_id": 0
}

指定のワークフローのステータス一覧取得

処理概要

workflow_idで指定したワークフローの、ワークフローステータス一覧を取得する

Exment権限(Permission)

なし

APIスコープ(scope)

workflow_read
workflow_execute

対応バージョン

v3.0.8

Authorizations:

OAuth2認証

path Parameters

workflow_id

required

integer

ワークフローID

Responses

Response samples

Content type

application/json

[{"id": 0,
"workflow_id": 0,
"status_type": 0,
"status_name": "string",
"datalock_flg": 1,
"completed_flg": 1,
"created_at": "string",
"updated_at": "string",
"updated_user_id": 0,
"created_user_id": 0
}
]

指定のワークフローのアクション一覧取得

処理概要

workflow_idで指定したワークフローの、ワークフローアクション一覧を取得する

Exment権限(Permission)

なし

APIスコープ(scope)

workflow_read
workflow_execute

対応バージョン

v3.0.8

Authorizations:

OAuth2認証

path Parameters

workflow_id

required

integer

ワークフローID

Responses

Response samples

Content type

application/json

[{"id": 0,
"workflow_id": 0,
"status_from": "string",
"action_name": "string",
"ignore_work": 0,
"comment_type": "string",
"flow_next_type": "string",
"flow_next_count": 0,
"work_targets": {"work_target_type": "string",
"system": [0
],
"user": [0
],
"organization": [0
],
"column": [0
]
},
"work_conditions": [{"status_to": null,
"enabled_flg": null
}
]
}
]

ワークフローのステータス取得

処理概要

ワークフローのステータス情報を取得する

Exment権限(Permission)

なし

APIスコープ(scope)

workflow_read
workflow_execute

対応バージョン

v3.0.8

Authorizations:

OAuth2認証

path Parameters

required

integer

ステータスID

Responses

Response samples

Content type

application/json

{"id": 0,
"workflow_id": 0,
"status_type": 0,
"status_name": "string",
"datalock_flg": 1,
"completed_flg": 1,
"created_at": "string",
"updated_at": "string",
"updated_user_id": 0,
"created_user_id": 0
}

ワークフローのアクション取得

処理概要

ワークフローアクション情報を取得する

Exment権限(Permission)

なし

APIスコープ(scope)

workflow_read
workflow_execute

対応バージョン

v3.0.8

Authorizations:

OAuth2認証

path Parameters

required

integer

ワークフローアクションID

Responses

Response samples

Content type

application/json

{"id": 0,
"workflow_id": 0,
"status_from": "string",
"action_name": "string",
"ignore_work": 0,
"comment_type": "string",
"flow_next_type": "string",
"flow_next_count": 0,
"work_targets": {"work_target_type": "string",
"system": [0
],
"user": [0
],
"organization": [0
],
"column": [0
]
},
"work_conditions": [{"status_to": null,
"enabled_flg": null
}
]
}

特定のデータに対し、現在のワークフローの実行値を取得

処理概要

特定のカスタムデータを選択し、そのカスタムデータの、現在のワークフローの実行値を取得する

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

workflow_read
workflow_execute

対応バージョン

v3.0.8

Authorizations:

OAuth2認証

path Parameters

tableKey required	string テーブル名(Ex. information)
id required	integer カスタムデータのID

query Parameters

expands

string

ワークフロー実行値に紐づく、実行前ステータス情報、実行後ステータス情報、アクション情報を取得可能。"status_from"、"status_to"、"action"を指定可能。複数の場合はカンマ区切り。

Responses

Response samples

Content type

application/json

{"id": 0,
"workflow_id": 0,
"morph_type": "string",
"morph_id": 0,
"workflow_action_id": 0,
"workflow_status_from_id": 0,
"workflow_status_to_id": 0,
"comment": "string",
"action_executed_flg": 0,
"latest_flg": 0,
"workflow_status_from": {"id": 0,
"workflow_id": 0,
"status_type": 0,
"status_name": "string",
"datalock_flg": 1,
"completed_flg": 1,
"created_at": "string",
"updated_at": "string",
"updated_user_id": 0,
"created_user_id": 0
},
"workflow_status": {"id": 0,
"workflow_id": 0,
"status_type": 0,
"status_name": "string",
"datalock_flg": 1,
"completed_flg": 1,
"created_at": "string",
"updated_at": "string",
"updated_user_id": 0,
"created_user_id": 0
},
"workflow_action": {"id": 0,
"workflow_id": 0,
"status_from": "string",
"action_name": "string",
"ignore_work": 0,
"comment_type": "string",
"flow_next_type": "string",
"flow_next_count": 0,
"work_targets": {"work_target_type": "string",
"system": [0
],
"user": [0
],
"organization": [0
],
"column": [0
]
},
"work_conditions": [{"status_to": null,
"enabled_flg": null
}
]
}
}

特定のデータに対し、ワークフローを実行

処理概要

特定のカスタムデータを選択し、ワークフローを実行する
ワークフローアクションIDをPOSTすることによって、ワークフローを実行する
アクション設定の「実行可能ユーザー」の値が「前アクションの実行可能ユーザーが選択」の場合、次パラメータの"users(アクションを実行するユーザーID一覧)"、もしくは"organizations(組織ID一覧)"どちらかが必須となる
現在のステータスと合わないアクションを実行した場合、エラーコード204を返却する
実行ユーザーが、そのアクションを行う権限が無かった場合、エラーコード204を返却する

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

workflow_execute

対応バージョン

v3.0.8

path Parameters

tableKey required	string テーブル名(Ex. information)
id required	integer カスタムデータのID

Request Body schema: application/json

workflow_action_id required	integer 実行するワークフローアクションID
comment	string ワークフローのコメント。そのアクションが、comment_typeが"required"の場合は必須。"not_use"の場合は無視される
next_users	string アクション設定の「実行可能ユーザー」が、「前アクションの実行可能ユーザーが選択」の場合、次のアクションを実行するユーザーIDをカンマ区切りで入力
next_organizations	string アクション設定の「実行可能ユーザー」が、「前アクションの実行可能ユーザーが選択」の場合、次のアクションを実行する組織IDをカンマ区切りで入力

Responses

Request samples

Payload

Content type

application/json

{"workflow_action_id": 0,
"comment": "string",
"next_users": "string",
"next_organizations": "string"
}

特定のデータに対し、作業ユーザーの一覧を取得

処理概要

特定のカスタムデータを選択し、そのカスタムデータの、現在の作業ユーザー一覧を取得する
アクション設定で、「特殊アクション」にチェックが入っていないアクションのみ、取得の対象とする
すべてのアクションの作業ユーザーを取得する場合、クエリ文字列「all=1」を追加する

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

workflow_read
workflow_execute

対応バージョン

v3.0.8

Authorizations:

OAuth2認証

path Parameters

tableKey required	string テーブル名(Ex. information)
id required	integer カスタムデータのID

query Parameters

as_user	integer Default: "0" 1のとき、「組織」としてアクション設定している作業者を、その組織に所属しているユーザー一覧に変換する
all	integer 1のとき、すべてのアクションの対象ユーザーを取得する

Responses

Response samples

Content type

application/json

{"users": [{"id": 0,
"value": { },
"parent_id": 0,
"parent_type": "string",
"label": "string",
"deleted_at": "string",
"deteled_user_id": 0,
"created_at": "string",
"updated_at": "string",
"updated_user_id": 0,
"created_user_id": 0
}
],
"organizations": [{"id": 0,
"value": { },
"parent_id": 0,
"parent_type": "string",
"label": "string",
"deleted_at": "string",
"deteled_user_id": 0,
"created_at": "string",
"updated_at": "string",
"updated_user_id": 0,
"created_user_id": 0
}
]
}

特定のデータに対し、実行できる次のアクションの一覧を取得

処理概要

特定のカスタムデータを選択し、そのカスタムデータの、実行できる次のアクションの一覧を取得する
ログインユーザーが実行できるアクションのみに絞り込む
ログインユーザーが実行できるかどうかを問わず、すべてのアクションを取得する場合、クエリ文字列「all=1」を追加する

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

workflow_read
workflow_execute

対応バージョン

v3.0.8

Authorizations:

OAuth2認証

path Parameters

tableKey required	string テーブル名(Ex. information)
id required	integer カスタムデータのID

query Parameters

all	integer Default: "0" 1のとき、ログインユーザーが実行できるかどうかを問わず、すべてのアクションを取得する

Responses

Response samples

Content type

application/json

[{"id": 0,
"workflow_id": 0,
"status_from": "string",
"action_name": "string",
"ignore_work": 0,
"comment_type": "string",
"flow_next_type": "string",
"flow_next_count": 0,
"work_targets": {"work_target_type": "string",
"system": [0
],
"user": [0
],
"organization": [0
],
"column": [0
]
},
"work_conditions": [{"status_to": null,
"enabled_flg": null
}
]
}
]

特定のデータに対し、ワークフローの履歴一覧を取得

処理概要

特定のカスタムデータを選択し、そのカスタムデータの、ワークフローの履歴一覧を取得する

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

workflow_read
workflow_execute

対応バージョン

v3.0.8

Authorizations:

OAuth2認証

path Parameters

tableKey required	string テーブル名(Ex. information)
id required	integer カスタムデータのID

通知

通知一覧を取得

処理概要

通知バーの通知一覧を取得する
未読の通知のみ取得する。すべての通知を取得する場合、パラメータ"all=1"を追加する

Exment権限(Permission)

なし

APIスコープ(scope)

notify_read
notify_write

対応バージョン

v3.0.8

query Parameters

all	integer Default: "0" 1の場合、すべての通知を取得する
count	integer [ 1 .. 100 ] Default: "20" 1回のリクエストで取得する件数。1～100

Responses

Response samples

Content type

application/json

{"current_page": 1,
"data": [{"id": 7,
"notify_id": "0",
"parent_type": null,
"parent_id": null,
"target_user_id": "2",
"trigger_user_id": "2",
"notify_subject": "テストテストテスト",
"notify_body": "本文です本文です本文です本文です本文です本文です本文です本文です",
"read_flg": "0",
"created_at": "2019-11-18 19:21:36",
"updated_at": "2019-11-18 19:21:36",
"created_user_id": null,
"updated_user_id": null
},
{"id": 4,
"notify_id": "1",
"parent_type": "information",
"parent_id": "8",
"target_user_id": "2",
"trigger_user_id": "1",
"notify_subject": "[テスト]データが作成されました",
"notify_body": "ユーザーにより、お知らせのデータが作成されました。\n以下の内容をご確認ください。\n\n作成ユーザー:\n作成日時:2019-11-15 16:44:41\n作成データ:<a href='http://localhost/admin/data/information/8'>テスト</a>\n",
"read_flg": "0",
"created_at": "2019-11-15 16:44:43",
"updated_at": "2019-11-15 16:44:43",
"created_user_id": null,
"updated_user_id": null
}
],
"first_page_url": "http://localhost/admin/api/notify?count=5&page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost/admin/api/notify?count=5&page=1",
"next_page_url": null,
"path": "http://localhost/admin/api/notify",
"per_page": 20,
"prev_page_url": null,
"to": 5,
"total": 5
}

通知追加

処理概要

指定ユーザーに通知を送信する
通知は通知バーにのみ追加される

Exment権限(Permission)

なし

APIスコープ(scope)

notify_write

対応バージョン

v3.0.8

Request Body schema: application/json

target_users required	string 通知送信先のユーザーID。複数ある場合にはカンマ区切り
notify_subject required	string 通知件名
notify_body required	string 通知本文

Responses

Request samples

Payload

Content type

application/json

{"target_users": "2",
"notify_subject": "テストテストテスト",
"notify_body": "本文です本文です本文です本文です本文です本文です本文です本文です"
}

Response samples

Content type

application/json

{"notify_id": 0,
"target_user_id": "2",
"notify_subject": "テストテストテスト",
"notify_body": "本文です本文です本文です本文です本文です本文です本文です本文です",
"trigger_user_id": "2",
"updated_at": "2019-11-18 19:21:36",
"created_at": "2019-11-18 19:21:36",
"id": 7
}

ファイル・ドキュメント

ファイルのダウンロード

処理概要

ファイルのダウンロードを実施する
クエリ文字列がない場合、ファイルはストリーム形式でダウンロードされる。"base64=1"の場合、base64形式で返却する

ファイルURL取得方法

ダウンロード用のファイルURLを取得する方法です。

カスタムデータ取得APIで、クエリ文字列「valuetype=text」を追加する

カスタム列の種類がファイル・画像の場合、値がURLになります。

例：GET
/api/data/testtable/1?valuetype=text

戻り値(一部)
{
    "id": 1,
    "value": {
        "text": "test_1",
        "file": "http://locallost/admin/api/files/c09ff3a0-7677-11ea-9edf-178831242ff9"
    }
}

ドキュメント(添付ファイル)一覧の取得APIで取得する

「api_url」が、APIから実行するためのURLです。

例：GET
/api/document/testtable/1

戻り値(一部)
{
    "data": [
        {
            "name": "information.htm",
            "url": "http://locallost/admin/files/91ed9b30-767b-11ea-a225-07e73286c089",
            "api_url": "http://locallost/admin/api/files/91ed9b30-767b-11ea-a225-07e73286c089",
            "created_at": "2020-04-04 22:52:48",
            "created_user_id": "1"
        }
    ]
}

リクエスト時のクエリ文字列と、レスポンスの内容

リクエスト時にbase64=1を入れない場合

レスポンス値は、ファイルのストリーム形式となります。

リクエスト時にbase64=1を入れる場合

レスポンス値は、以下の形式のjsonとなります。

{
  "type": "image/jpeg",
  "name": "test.jpg",
  "base64": "aaaaaXXXXXXX....."
}

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

value_read
value_write

対応バージョン

v3.1.7

path Parameters

uuid

required

string

ファイルに割り振られたランダム文字列

query Parameters

base64

integer

1の場合、base64文字列を含んだjson型で返却する

Responses

Response samples

Content type

No sample

ファイルの削除

処理概要

ファイルの削除を実施する
特定のデータに紐付く添付ファイルの場合、添付ファイル情報も同時に削除する

ファイルURL取得方法

「ファイルのダウンロード」をご確認ください。

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：担当者データの編集

APIスコープ(scope)

value_write

対応バージョン

v3.1.10

path Parameters

uuid

required

string

ファイルに割り振られたランダム文字列

Responses

ファイルのダウンロード

処理概要

ファイルのダウンロードを実施する
クエリ文字列がない場合、ファイルはストリーム形式でダウンロードされる。"base64=1"の場合、base64形式で返却する

ファイルURL取得方法

ダウンロード用のファイルURLを取得する方法です。

カスタムデータ取得APIで取得する

カスタム列の種類がファイル・画像の場合、取得した値を加工します。

例：GET
/api/data/testtable/1

戻り値(一部)
{
    "id": 1,
    "value": {
        "text": "test_1",
        "file": "testtable/c09ff510-7677-11ea-9096-a14cacaee56f.txt"
    }
}

この値を使用し、以下のようなURLで、APIを実行します。
http://localhost/api/files/testtable/c09ff510-7677-11ea-9096-a14cacaee56f.txt

リクエスト時のクエリ文字列と、レスポンスの内容

リクエスト時にbase64=1を入れない場合

レスポンス値は、ファイルのストリーム形式となります。

リクエスト時にbase64=1を入れる場合

レスポンス値は、以下の形式のjsonとなります。

{
  "type": "image/jpeg",
  "name": "test.jpg",
  "base64": "aaaaaXXXXXXX....."
}

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

value_read
value_write

対応バージョン

v3.1.10

path Parameters

tableKey required	string テーブル名(Ex. information)
filename required	string ファイル名

query Parameters

base64

integer

1の場合、base64文字列を含んだjson型で返却する

Responses

Response samples

Content type

No sample

ファイルの削除

処理概要

ファイルの削除を実施する
特定のデータに紐付く添付ファイルの場合、添付ファイル情報も同時に削除する

ファイルURL取得方法

「ファイルのダウンロード」をご確認ください。

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：担当者データの編集

APIスコープ(scope)

value_write

対応バージョン

v3.1.10

path Parameters

tableKey required	string テーブル名(Ex. information)
filename required	string ファイル名

Responses

ドキュメント(添付ファイル)一覧の取得

処理概要

特定のカスタムデータを選択し、そのカスタムデータの、ドキュメント（添付ファイル）一覧を取得する

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：すべてのデータの閲覧
テーブル：すべてのデータの参照
テーブル：担当者データの編集
テーブル：担当者データの閲覧

APIスコープ(scope)

value_read
value_write

対応バージョン

v3.1.10

path Parameters

tableKey required	string テーブル名(Ex. information)
id required	string カスタムデータのID

query Parameters

page	integer Default: "1" 取得するページ番号
count	integer [ 1 .. 100 ] Default: "20" 1回のリクエストで取得する件数。1～100

Responses

Response samples

Content type

application/json

{"current_page": 1,
"data": [{"name": "test.txt",
"url": "http://localhost/admin/files/fcc7fea0-74e0-11ea-a1b4-8fd756c2e4b5",
"api_url": "http://localhost/admin/api/files/fcc7fea0-74e0-11ea-a1b4-8fd756c2e4b5",
"created_at": "2020-04-02 21:53:45",
"created_user_id": "1"
},
{"name": "test2.txt",
"url": "http://localhost/admin/files/abaf364d-71d0-4958-88ed-8a5378d2722e",
"api_url": "http://localhost/admin/api/files/abaf364d-71d0-4958-88ed-8a5378d2722e",
"created_at": "2020-04-02 21:53:45",
"created_user_id": "1"
}
],
"first_page_url": "http://localhost/admin/api/document/footable/1?count=20&page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost/admin/api/document/footable/1?count=20&page=1",
"next_page_url": null,
"path": "http://localhost/admin/api/document/footable/1",
"per_page": 20,
"prev_page_url": null,
"to": 1,
"total": 2
}

ドキュメント(添付ファイル)の作成

処理概要

特定のカスタムデータを選択し、そのデータに紐付くドキュメント（添付ファイル）をアップロードする

Exment権限(Permission)

システム：システム情報
システム：カスタムテーブル
システム：すべてのデータ
テーブル：テーブル
テーブル：すべてのデータの編集
テーブル：担当者データの編集

APIスコープ(scope)

value_write

対応バージョン

v3.1.10

path Parameters

tableKey required	string テーブル名(Ex. information)
id required	string カスタムデータのID

Request Body schema: application/json

name required	string ファイル名
base64 required	string base64文字列

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"base64": "string"
}

Response samples

Content type

application/json

{"name": "test.txt",
"url": "http://localhost/admin/files/fcc7fea0-74e0-11ea-a1b4-8fd756c2e4b5",
"api_url": "http://localhost/admin/api/files/fcc7fea0-74e0-11ea-a1b4-8fd756c2e4b5",
"created_at": "2020-04-02 21:53:45",
"created_user_id": "1"
}

ログ

操作ログ一覧取得

処理概要

画面・APIの操作ログを取得する。※実行日時の逆順に取得します。

login_user_idとbase_user_idについて

クエリ文字列の「login_user_id」と「base_user_id」の説明については、以下のURLをご確認ください。
https://exment.net/docs/#/ja/func_reference?id=%e8%a3%9c%e8%b6%b3%ef%bc%9aid%e3%81%a8base_user_id%e3%81%ab%e3%81%a4%e3%81%84%e3%81%a6

Exment権限(Permission)

システム：システム情報

APIスコープ(scope)

対応バージョン

v4.0.3

query Parameters

page	integer Default: "1" 取得するページ番号
count	integer [ 1 .. 100 ] Default: "20" 1回のリクエストで取得する件数。1～100
login_user_id	integer ログインユーザーテーブルのID
base_user_id	integer 「カスタムデータの『ユーザー(user)』」テーブルのID
path	string HTTPリクエストの対象URI
method	string メソッド(GET, POSTなど)
ip	string 実行ユーザーの中身IPアドレス
target_datetime_start	string 取得する実行日時の開始日時。「2021-02-17 11:45:31」とした場合、この日時以降のログを取得
target_datetime_end	string 取得する実行日時の終了日時。「2021-02-17 11:45:31」とした場合、この日時以前のログを取得

Responses

Response samples

Content type

application/json

{"current_page": 1,
"data": [{"id": 384,
"user_id": "1",
"path": "admin/api/log",
"method": "GET",
"ip": "127.0.0.1",
"input": "{\"base_user_id\":\"1\",\"count\":\"2\"}",
"created_at": "2021-02-17 12:00:41",
"updated_at": "2021-02-17 12:00:41",
"base_user_id": "1"
},
{"id": 383,
"user_id": "1",
"path": "admin/api/log",
"method": "GET",
"ip": "127.0.0.1",
"input": "{\"base_user_id\":\"1\",\"count\":\"100\"}",
"created_at": "2021-02-17 11:54:55",
"updated_at": "2021-02-17 11:54:55",
"base_user_id": "1"
}
],
"first_page_url": "http://localhost/admin/api/log?page=1",
"from": 1,
"last_page": 70,
"last_page_url": "http://localhost/admin/api/log?page=70",
"next_page_url": "http://localhost/admin/api/log?page=2",
"path": "http://localhost/admin/api/log",
"per_page": "2",
"prev_page_url": null,
"to": 2,
"total": 139
}

操作ログ取得

処理概要

指定のIDの、画面・APIの操作ログを取得する

Exment権限(Permission)

システム：システム情報

APIスコープ(scope)

対応バージョン

v4.0.3

path Parameters

required

string

操作ログID

Responses

Response samples

Content type

application/json

{"id": 390,
"user_id": "1",
"path": "admin/api/log/400",
"method": "GET",
"ip": "127.0.0.1",
"input": "[]",
"created_at": "2021-02-17 12:06:51",
"updated_at": "2021-02-17 12:06:51",
"base_user_id": "1"
}