Exment API (1.0)

Download OpenAPI specification:Download

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:

      Responses

      200

      OK

      get /api/version
      http://localhost/admin/api/version

      Response samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      {
      • "version": "v3.0.1"
      }

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

      処理概要

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

      Exment権限(Permission)

      なし

      APIスコープ(scope)

      • me

      対応バージョン

      v1.1.0

      Authorizations:

      Responses

      200

      OK

      get /api/me
      http://localhost/admin/api/me

      Response samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      {
      • "id": 1,
      • "suuid": "b6ba6222ebb2aa455521",
      • "parent_type": null,
      • "parent_id": null,
      • "value":
        {
        },
      • "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"
      }

      テーブル

      カスタムテーブル一覧

      処理概要

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

      Exment権限(Permission)

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

      APIスコープ(scope)

      • table_read
      • table_write

      対応バージョン

      • v1.1.0 新規追加
      • v3.0.8 パラメータ「id」「expands」追加
      Authorizations:
      query Parameters
      count
      integer [ 1 .. 100 ]
      Default: "20"

      1回のリクエストで取得する件数。1~100

      id
      string

      取得したいテーブルの、ID絞り込みを行う場合設定。カンマ区切り

      expands
      string

      テーブルに紐づく、カスタム列一覧を取得可能。"columns"を指定可能

      Responses

      200

      OK

      get /api/table
      http://localhost/admin/api/table

      Response samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      {
      • "current_page": 1,
      • "data":
        [
        ],
      • "from": 1,
      • "last_page": 1,
      • "next_page_url": null,
      • "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:
      path Parameters
      tableKey
      required
      string

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

      Responses

      200

      OK

      get /api/table/{tableKey}
      http://localhost/admin/api/table/{tableKey}

      Response samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      {
      • "id": 8,
      • "suuid": "5c86fb70562dd56f34c0",
      • "table_name": "information",
      • "table_view_name": "お知らせ",
      • "description": "ユーザーに通知するお知らせです。ダッシュボードなどに表示することができます。",
      • "system_flg": "0",
      • "showlist_flg": "1",
      • "order": "0",
      • "options":
        {
        },
      • "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:
      path Parameters
      tableKey
      required
      any

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

      Responses

      200
      get /api/table/{tableKey}/columns
      http://localhost/admin/api/table/{tableKey}/columns

      Response samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      [
      • {
        },
      • {
        }
      ]

      カスタム列情報取得

      処理概要

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

      Exment権限(Permission)

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

      APIスコープ(scope)

      • table_read
      • table_write

      対応バージョン

      v1.1.0

      Authorizations:
      path Parameters
      id
      required
      integer

      カスタム列ID

      Responses

      200

      OK

      get /api/column/{id}
      http://localhost/admin/api/column/{id}

      Response samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      {
      • "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":
        {
        },
      • "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
      }

      データ

      カスタムデータ一覧取得

      処理概要

      • 特定のカスタムテーブルに登録している、カスタムデータの一覧を取得する
      • ログインユーザーに権限のあるデータのみ、一覧の対象となる

      Exment権限(Permission)

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

      APIスコープ(scope)

      • value_read
      • value_write

      対応バージョン

      • v1.1.0 新規作成
      • v3.1.2 labelパラメータ追加。1のとき、結果にlabelを追加します。
      • v3.1.7 valuetypeパラメータ追加
      Authorizations:
      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"の場合、画面に表示する文言を返却する

      Responses

      200

      OK

      get /api/data/{tableKey}
      http://localhost/admin/api/data/{tableKey}

      Response samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      {
      • "current_page": 1,
      • "data":
        [