Documentation Powered by ReDoc

Exment API (1.0)

Download OpenAPI specification:Download

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

Exment's Web API reference.
Click here for application registration method, access token acquisition method, and scope list.
Click here for other manuals.

This is the specification of Rest API of Exment. It is created in OpenAPI format.

Sorry, Now this document creates by translating from Japanese.

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:

      System

      Get system version information

      Outline of processing

      • Get the system version of the installed Exment

      Exment Permission

      Nothing

      API scope

      Nothing

      Append version

      v1.1.0

      Authorizations:
      OAuth2

      Responses

      Response samples

      Content type
      application/json
      {
      • "version": "v3.0.1"
      }

      Get login user information

      Outline of processing

      • Get user information of the logged-in user

      Exment Permission

      Nothing

      API scope

      • me

      Append version

      v1.1.0

      Authorizations:
      OAuth2

      Responses

      Response samples

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

      Get login user's avatar

      Outline of processing

      • Get the logged-in user's own avatar image
      • If there is no avatar and the query string "default" is 1, the default image is returned. Otherwise, return null
      • The return value is base64 format json if the query string "base64" is 1. Other than that, a binary file of the image

      Exment Permission

      Nothing

      API scope

      • me

      Append version

      v4.2.7

      Authorizations:
      OAuth2
      query Parameters
      default
      integer

      In case of 1, if the user's avatar does not exist, the default image will be returned.

      base64
      string

      If 1, the response is returned as json converted to base64 format. Other than that, it is returned as a binary file.

      Responses

      Response samples

      Content type
      image/jpeg
      image/jpeg
      application/json
      No sample

      Table

      Custom table list

      Outline of processing

      • Get a custom table list
      • Only tables that the logged-in user can access can be retrieved as a list

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : Biew data
      • Table : Access data

      API scope

      • table_read
      • table_write

      Append version

      • v1.1.0 Append
      • v3.0.8 Added parameters "id" and "expands"
      Authorizations:
      OAuth2
      query Parameters
      page
      integer
      Default: "1"

      Page number to get

      count
      integer [ 1 .. 100 ]
      Default: "20"

      The number of cases to be acquired in one request. 1-100

      id
      string

      Set when narrowing down the ID of the table you want to acquire. Comma separated

      expands
      string

      You can get a custom column list linked to the table. "columns" can be specified

      Responses

      Response samples

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

      Get custom table information

      Outline of processing

      • Specify the ID or table name of the custom table and get the custom column information list in the custom table.
      • For tables that the logged-in user cannot access, a 403 error occurs

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • table_read
      • table_write

      Append version

      v1.1.0

      Authorizations:
      OAuth2
      path Parameters
      tableKey
      required
      string

      Custom table ID (Ex. 3) or table name (Ex. user)

      Responses

      Response samples

      Content type
      application/json
      {
      • "id": 8,
      • "suuid": "5c86fb70562dd56f34c0",
      • "table_name": "information",
      • "table_view_name": "Information",
      • "description": "Information to notify the user. It can be displayed on a dashboard etc.",
      • "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"
      }

      Get a list of custom columns in a custom table

      Outline of processing

      • Specify the ID or table name of the custom table and get the custom column information list in the custom table
      • For tables that the logged-in user cannot access, a 403 error occurs

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • table_read
      • table_write

      Append version

      v1.1.0

      Authorizations:
      OAuth2
      path Parameters
      tableKey
      required
      any

      Custom table ID (Ex. 3) or table name (Ex. user)

      Responses

      Response samples

      Content type
      application/json
      [
      • {
        },
      • {
        }
      ]

      Get custom column information

      Outline of processing

      • Get custom column information from custom column ID
      • If the column is a custom table that the logged-in user cannot access, a 403 error will occur

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • table_read
      • table_write

      Append version

      v1.1.0

      Authorizations:
      OAuth2
      path Parameters
      id
      required
      integer

      Custom column ID

      Responses

      Response samples

      Content type
      application/json
      {
      • "id": 45,
      • "suuid": "9ce2740b044ea7143a55",
      • "custom_table_id": "8",
      • "column_name": "title",
      • "column_view_name": "Title",
      • "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
      }

      Get custom column information (table name / column name specification)

      Outline of processing

      • Get custom column information from table name / custom column name.
      • If the column is a custom table that the logged-in user cannot access, a 403 error will occur.

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • table_read
      • table_write

      Append version

      v3.1.12

      Authorizations:
      OAuth2
      path Parameters
      tableKey
      required
      string

      Custom table ID (Ex. 3) or table name (Ex. user)

      columnKey
      required
      string

      Custom column name(Ex. user_code)

      Responses

      Response samples

      Content type
      application/json
      {
      • "id": 45,
      • "suuid": "9ce2740b044ea7143a55",
      • "custom_table_id": "8",
      • "column_name": "title",
      • "column_view_name": "Title",
      • "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
      }

      View

      Get custom view information

      Outline of processing

      • Get view information from view id or suuid
      • If the view is a custom table that the logged-in user cannot access, a 403 error will occur
      • Currently, you cannot get view columns, view filters, etc. Use "Get Custom Value List (Use View)" or "Get Custom Value Information (Use View)" to specify the view.

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • view_read

      Append version

      v3.3.X

      path Parameters
      id
      required
      string

      Custom table ID (Ex. 3) or suuid (20 digit string)

      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"
      }

      Get a list of custom views in a custom table

      Outline of processing

      • Specify the ID or table name of the custom table and get the custom view list in the custom table
      • If the view is a custom table that the logged-in user cannot access, a 403 error will occur
      • Currently, you cannot get view columns, view filters, etc. Use "Get Custom Value List (Use View)" or "Get Custom Value Information (Use View)" to specify the view.

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data
      • Table : View data

      API scope

      • view_read

      Append version

      v3.3.X

      Authorizations:
      OAuth2
      path Parameters
      tableKey
      required
      any

      Custom table ID (Ex. 3) or table name (Ex. user)

      query Parameters
      view_type
      string

      If specified, narrow down by view authority. 0=System view, 1=User view

      view_kind_type
      string

      If specified, narrow down by view type. 0=Default View, 1=Summary View, 2=Calendar View, 3=Filter View, 9=AllData View

      view_view_name
      string

      If specified, narrow down by view display name

      Responses

      Response samples

      Content type
      application/json
      [
      • {
        },
      • {
        }
      ]

      Data

      Get custom data list

      Outline of processing

      • Get a list of custom data registered in a specific custom table
      • Only data for which the logged-in user is authorized will be listed

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • value_read
      • value_write

      Append version

      • v1.1.0 Append
      • v3.1.2 Added label parameter. When 1, label is added to the result.
      • v3.1.7 valuetype parameter added
      • v5.0.1 children parameter added

      To get the child data of a relation

      When the children parameter is 1, the child data of that data is also acquired at the same time.
      Available only when custom relations are set. Custom column "Choice (select from list of values ​​in other tables)" cannot be obtained
      "children" is added "data" object, and the data list of the corresponding child table is added in it.
      An example of the return value at that time is as follows. (Partially omitted) Here, the child table is "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

      Table Name(Ex. information)

      query Parameters
      page
      integer
      Default: "1"

      Page number to get

      count
      integer [ 1 .. 100 ]
      Default: "20"

      The number of cases to be acquired in one request. 1-100

      orderby
      string

      When sorting data, the column name of the sort. If there are multiple, separate them with commas. In reverse order, add a half-width space like "id desc"

      id
      string

      Set when narrowing down the ID of the data you want to acquire. Comma separated

      label
      integer
      Default: "0"

      Whether to include label in the result. Include in case of 1 (*The speed will be slightly slower)

      valuetype
      string

      The type of value to return. In case of "text", the wording to be displayed on the screen is returned.

      children
      integer

      When it is 1, the child data of that data is also acquired at the same time. * Available only when custom relations are set. Custom column "Choice (select from list of values ​​in other tables)" cannot be obtained

      Responses

      Response samples

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

      Create new custom data

      Outline of processing

      • Create new data in a custom table
      • If the logged-in user does not have permission to add new to the custom table, a 403 error will occur
      • For the data you want to register, assign the value in the value array and POST

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : Edit data

      API scope

      • value_write

      Append version

      • v1.1.0 Appended
      • v3.1.0 Supports multiple registrations and new additions by specifying the parent data. Also supports saving files to image / file columns
      • v3.1.2 Added label parameter. When 1, label is added to the result.
      • v3.1.7 valuetype parameter added

      When saving a file in a file/image column

      • Specify the file name and base64 character string of the file in value->(file/image string) as shown below.
      {
   "value": {
        "title": "test",
        "file": {
            "name" : "hello.txt",
            "base64" : "aGVsbG8gV29ybGQhIExldCdzIGVuam95IEV4bWVudCE=""
        }
    }
}

      When specifying the parent data

      • Parent data can be registered by setting parent_id and parent_type
      • As prerequisites, '1: n relation is set' and 'parent data is already registered'
      {
   "parent_type": "contract",
   "parent_id": 2
   "value": {
        "num": 10,
        "price": 10000
    }
}

      When registering multiple items

      • Multiple data can be registered by sending multiple POST data in an array.

      • If even one error occurs, do not register all data

      • Up to 100 items can be registered at one time

      • There are two patterns for specifying an array, but there is no difference in function.

      • Patturn 1:

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

      • Patturn 2:

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

      When the custom column type is 'Choice (select from the list of values ​​in other tables)' and you want to create a new one using a key other than id

      By adding the parameter 'findKeys', values ​​other than id can be used as keys.
      Ex:When registering custom data in the 'Contract' table, if you want to use the data in the column 'Customer' and the 'Customer name (customer_code)' in the 'Customer' table

      • Default: 

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

      • Use findKeys: 

        {
  value: {
      'contract_code': 'C00001',
      'customer': 'CompABC'
  },
  findKeys: {
      'customer': 'customer_name'
  }
}
      Authorizations:
      OAuth2
      path Parameters
      tableKey
      required
      string

      Table Name(Ex. information)

      Request Body schema: application/json
      object or Array of objects

      The parameters to be sent will change depending on whether one item is registered or multiple items are registered.

      object

      When the custom column type is "Choice (select from the list of values ​​in other tables)" and you want to create a new one using a key other than id. Match the items to the custom columns of the table to be registered

      Array of objects

      Can be specified only when multiple records are registered and value is not set

      parent_type
      string

      Parent table name. Specify only when there is one registered data and the parent data is specified

      parent_id
      integer

      The data ID of the parent table. Specify only when there is one registered data and the parent data is specified

      label
      integer
      Default: 0

      Whether to include label in the result. Include in case of 1 (*The speed will be slightly slower)

      Responses

      Request samples

      Content type
      application/json
      {
      • "value": {
        }
      }

      Response samples

      Content type
      application/json
      Example
      Example(Register only 1)
      Example(Register only 1)
      Example(Register multiple records)
      {
      • "id": 8,
      • "suuid": "946a85f121a7d9b2ab72",
      • "parent_type": null,
      • "parent_id": null,
      • "value": {
        },
      • "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": "Test"
      }

      Search custom data

      Outline of processing

      • Search for custom data registered in a specific custom table
      • Only data for which the logged-in user is authorized will be listed
      • The columns registered in the search index are the search target columns.
      • The search is a prefix match. If you want to search by full text match, you need to set according to here

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • value_read
      • value_write

      Append version

      • v2.1.6 Appended
      • v3.1.2 Added label parameter. When 1, label is added to the result.
      • v3.1.7 valuetype parameter added
      • v5.0.1 children parameter added

      To get the child data of a relation

      When the children parameter is 1, the child data of that data is also acquired at the same time.
      Available only when custom relations are set. Custom column "Choice (select from list of values ​​in other tables)" cannot be obtained
      "children" is added "data" object, and the data list of the corresponding child table is added in it.
      An example of the return value at that time is as follows. (Partially omitted) Here, the child table is "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

      Table Name(Ex. information)

      query Parameters
      q
      required
      string

      Search string

      page
      integer
      Default: "1"

      Page number to get

      count
      integer [ 1 .. 100 ]
      Default: "20"

      The number of cases to be acquired in one request. 1-100

      label
      integer
      Default: "0"

      Whether to include label in the result. Include in case of 1 (* The speed will be slightly slower)

      valuetype
      string

      The type of value to return. In case of "text", the wording to be displayed on the screen is returned.

      children
      integer

      When it is 1, the child data of that data is also acquired at the same time. * Available only when custom relations are set. Custom column "Choice (select from list of values ​​in other tables)" cannot be obtained

      Responses

      Response samples

      Content type
      application/json
      {}

      Custom value search (column specification)

      Outline of processing

      • Search for custom data registered in a specific custom table
      • Only data for which the logged-in user is authorized will be listed
      • Specify search criteria and values ​​for each custom column. Execute the search when all the search conditions are matched.

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • value_read
      • value_write

      Append version

      • v3.0.8 Appended
      • v3.1.2 Added label parameter. When 1, label is added to the result.
      • v3.1.7 valuetype parameter added
      • v3.3.2 Added 'like' to the search conditions. Supports OR search, adds order by parameter
      • v5.0.1 children parameter added

      How to specify search conditions

      • Search by specifying each column name in the parameter 'q'. When specifying multiple columns, separate them with commas.

      • The search conditions correspond to the following.

        • eq : Equal
        • ne : Not equal
        • gt : Greater than
        • gte : Greater than or equal
        • lt : Less than
        • lte : Less than or equal
        • like : LIKE search. '%' available for value

      • The query setting method is'(column name) eq (search value)'.

      • URL encoding should be performed

      • When searching with multiple search values, usually perform an AND search. If the parameter 'or=1' is specified, an OR search will be performed.

      • Example 1: In the information table, when you want to get the data list with'1'in the'display flag (view_flg)'

      // Please encode URL
/api/data/information/query-column?q=view_flg eq 1
      • Example 2: In the information table, when you want to get the data list where'view flag (view_flg)'is '1' and'Title (title)' is'Test'
      // Please encode URL
/api/data/information/query-column?q=view_flg eq 1,title eq Test
      • Example 3: In the information table, when you want to get the data list where'view flag (view_flg)'is '1' or'Title (title)'is'Test'.
      // Please encode URL
/api/data/information/query-column?q=view_flg eq 1,title eq Test&or=1

      To get the child data of a relation

      When the children parameter is 1, the child data of that data is also acquired at the same time.
      Available only when custom relations are set. Custom column "Choice (select from list of values ​​in other tables)" cannot be obtained
      "children" is added "data" object, and the data list of the corresponding child table is added in it.
      An example of the return value at that time is as follows. (Partially omitted) Here, the child table is "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

      Table Name(Ex. information)

      query Parameters
      q
      required
      string

      Search string. Refer to the above example for how to specify the query search.

      page
      integer
      Default: "1"

      Page number to get

      count
      integer [ 1 .. 100 ]
      Default: "20"

      The number of cases to be acquired in one request. 1-100

      label
      integer
      Default: "0"

      Whether to include label in the result. Include in case of 1 (* The speed will be slightly slower)

      valuetype
      string

      The type of value to return. In case of "text", the wording to be displayed on the screen is returned.

      or
      integer

      When searching in multiple columns, if 1 is set, OR search is performed.

      orderby
      string

      When sorting data, the column name of the sort. If there are multiple, separate them with commas. In reverse order, add a half-width space like "id desc"

      children
      integer

      When it is 1, the child data of that data is also acquired at the same time. * Available only when custom relations are set. Custom column "Choice (select from list of values ​​in other tables)" cannot be obtained

      Responses

      Response samples

      Content type
      application/json
      {}

      Get custom data information

      Outline of processing

      • Get custom data information registered in a specific custom table
      • If the logged-in user has unauthorized data, a 403 error will occur
      • Perform physical deletion by adding the parameter "force=1". Can be implemented for data that has already been logically deleted

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • value_read
      • value_write

      Append version

      • v1.1.0 Appended
      • v3.1.2 Added label parameter. When 1, label is added to the result.
      • v3.1.7 valuetype parameter added
      • v4.0.7 Supports hard deletion of data
      • v5.0.1 children parameter added

      To get the child data of a relation

      When the children parameter is 1, the child data of that data is also acquired at the same time.
      Available only when custom relations are set. Custom column "Choice (select from list of values ​​in other tables)" cannot be obtained
      "children" is added directly under the array, and the data list of the corresponding child table is added in it.
      An example of the return value at that time is as follows. (Partially omitted) Here, the child table is "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

      Table Name(Ex. information)

      id
      required
      string

      The ID of the custom data

      query Parameters
      label
      integer
      Default: "0"

      Whether to include label in the result. Include in case of 1 (* The speed will be slightly slower)

      valuetype
      string

      The type of value to return. In case of "text", the wording to be displayed on the screen is returned.

      children
      integer

      When it is 1, the child data of that data is also acquired at the same time. * Available only when custom relations are set. Custom column "Choice (select from list of values ​​in other tables)" cannot be obtained

      Responses

      Response samples

      Content type
      application/json
      {
      • "id": 8,
      • "suuid": "946a85f121a7d9b2ab72",
      • "parent_type": null,
      • "parent_id": null,
      • "value": {
        },
      • "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": "Test"
      }

      Update custom data

      Outline of processing

      • Update custom data information
      • If the logged-in user has unauthorized data, a 403 error will occur
      • PUT by assigning a value in the value array only for the information of the column where the update occurs
      • Exclusive control can be performed by performing column 'updated_at'

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : Edit data

      API scope

      • value_write

      Append version

      • v1.1.0 Appended
      • v3.1.0 Supports saving files to image / file columns
      • v3.1.2 Added label parameter. When 1, label is added to the result.
      • v3.1.10 Supports exclusive control

      When saving a file in a file/image column

      • Specify the file name and base64 character string of the file in value->(file/image string) as shown below.
      • Ex: When saving a file in the file column 'file'
      {
   "value": {
        "title": "test",
        "file": {
            "name" : "hello.txt",
            "base64" : 'aGVsbG8gV29ybGQhIExldCdzIGVuam95IEV4bWVudCE='
        }
    }
}

      When the custom column type is 'Choice (select from the list of values ​​in other tables)' and you want to update using a key other than id

      By adding the parameter 'findKeys', values ​​other than id can be used as keys. Ex:When updating the custom data in the 'Contract' table, if you want to use the data in the column 'Customer' and the 'Customer name (customer_code)' in the 'Customer' table

      *Default:

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

      *Use findKeys:

      {
    value: {
        "contract_code": "C00001",
        "customer": "Company ABC"
    },
    findKeys: {
        "customer": "customer_name"
    }
}

      When specifying the parent data

      • Parent data can be registered by setting parent_id and parent_type
      • As prerequisites, '1: n relation is set' and 'parent data is already registered'
      {
   "parent_type": "contract",
   "parent_id": 2
   "value": {
        "price": 10000
    }
}

      exclusion control

      • Exclusive control can be performed by adding a date to the updated_at column. If the specified date and time and the latest update date and time of the target data are different, an error will be returned.
      {
   "value": {
        "price": 10000
    },
    "updated_at": "2020/04/03 12:00:00"
}
      Authorizations:
      OAuth2
      path Parameters
      tableKey
      required
      string

      Table Name(Ex. information)

      id
      required
      string

      The ID of the custom data

      Request Body schema: application/json
      object
      object

      When the custom column type is "Choice (select from the list of values ​​in other tables)" and you want to create a new one using a key other than id. Match the items to the custom columns of the table to be registered

      parent_type
      string

      Only if you specify the parent data

      parent_id
      integer

      Only if you specify the parent data

      label
      integer
      Default: 0

      Whether to include label in the result. Include in case of 1 (* The speed will be slightly slower)

      Responses

      Request samples

      Content type
      application/json
      {
      • "value": {
        }
      }

      Response samples

      Content type
      application/json
      {
      • "id": 8,
      • "suuid": "946a85f121a7d9b2ab72",
      • "parent_type": null,
      • "parent_id": null,
      • "value": {
        },
      • "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": "Test update"
      }

      Delete custom data

      Outline of processing

      • Logically delete custom data information
      • If the logged-in user has unauthorized data, a 403 error will occur
      • We can select URL param {id}. When deleting multiple items, specify them separated by commas. When deleting multiple items at the same time, up to 100 items can be deleted at the same time.
      • Perform physical deletion by adding the parameter "force=1". Can be implemented for data that has already been logically deleted

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : Edit data

      API scope

      • value_write

      Append version

      • v1.1.0 Appended
      • v3.0.13 Supports deletion of multiple items
      • v4.0.7 Supports hard deletion of data
      Authorizations:
      OAuth2
      path Parameters
      tableKey
      required
      string

      Table Name(Ex. information)

      id
      required
      string

      The ID of the custom data

      query Parameters
      force
      integer

      When 1, perform physical deletion of data

      Responses

      Get custom data list (using view)

      Outline of processing

      • Specify a view and use that view to get a list of data
      • Only data for which the logged-in user is authorized will be listed
      • Supported view types: All views, normal view, aggregate view

      About the result column name

      • When using a view to get the results, there are various cases for the columns to get. (Ex: Data in parent table, aggregation result of grouping)
      • Depending on the view settings, column names may be duplicated, and the column name key may not be able to determine the column type.
      • Therefore, the column name of the data value obtained in json format is suuid (random 20-digit alphanumeric characters).
      • Information such as the target suuid table name and custom column name is set in the resulting json "column_definitions", so analyze and obtain the relevant column information from those values.
      Example (partially omitted)
      {
    "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

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • value_read
      • value_write

      Append version

      • v3.3.X Added
      Authorizations:
      OAuth2
      path Parameters
      viewId
      required
      string

      View ID (Ex. 2, 5) or suuid (Ex. 22e715cf7f4ce5f319f0)

      tableKey
      required
      string

      Custom table ID (Ex. 3) or table name (Ex. user)

      query Parameters
      page
      integer
      Default: "1"

      Page number to get

      count
      integer [ 1 .. 100 ]
      Default: "20"

      The number of cases to be acquired in one request. 1-100

      valuetype
      string

      The type of value to return. In case of "text", the wording to be displayed on the screen is returned.

      Responses

      Response samples

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

      Get custom data information (using view)

      Outline of processing

      • Specify the ID of the view and the data and use that view to get the data information
      • Only data for which the logged-in user has authority will be acquired.
      • Supported view types: All views, Normal view

      About the result column name

      • When using a view to get the results, there are various cases for the columns to get. (Ex: Data in parent table, aggregation result of grouping)
      • Depending on the view settings, column names may be duplicated, and the column name key may not be able to determine the column type.
      • Therefore, the column name of the data value obtained in json format is suuid (random 20-digit alphanumeric characters).
      • Information such as the target suuid table name and custom column name is set in the resulting json "column_definitions", so analyze and obtain the relevant column information from those values.
      Example (partially omitted)
      {
    "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

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • value_read
      • value_write

      Append version

      • v3.3.X Added
      Authorizations:
      OAuth2
      path Parameters
      viewId
      required
      string

      View ID (Ex. 2, 5) or suuid (Ex. 22e715cf7f4ce5f319f0)

      tableKey
      required
      string

      Custom table ID (Ex. 3) or table name (Ex. user)

      id
      required
      string

      Data ID

      Responses

      Response samples

      Content type
      application/json
      {
      • "value": {
        },
      • "column_definitions": {
        }
      }

      Workflow

      Get workflow list

      Outline of processing

      • Get workflow list
      • Get a list of only workflows for which Setting Complete is executed

      Exment Permission

      Nothing

      API scope

      • workflow_read
      • workflow_execute

      Append version

      v3.0.8

      Authorizations:
      OAuth2
      query Parameters
      count
      integer [ 1 .. 100 ]
      Default: "20"

      The number of cases to be acquired in one request. 1-100

      all
      required
      integer
      Default: "0"

      If 1, include workflows that have not been set up

      expands
      string

      You can get the status setting list and action setting list associated with the workflow. "statuses" and "actions" can be specified. Separate multiple items with commas.

      id
      string

      Set when narrowing down the ID of the workflow you want to acquire. Comma separated

      Responses

      Response samples

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

      Get a workflow info

      Outline of processing

      • Get workflow information from workflow ID

      Exment Permission

      Nothing

      API scope

      • workflow_read
      • workflow_execute

      Append version

      v3.0.8

      Authorizations:
      OAuth2
      path Parameters
      id
      required
      integer

      Workflow ID

      query Parameters
      expands
      string

      You can get the status setting list and action setting list associated with the workflow. "statuses" and "actions" can be specified. Separate multiple items with commas.

      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": [
        ],
      • "workflow_actions": [
        ],
      • "created_at": "string",
      • "updated_at": "string",
      • "updated_user_id": 0,
      • "created_user_id": 0
      }

      Get status list of specified workflow

      Outline of processing

      • Get the workflow status list of the workflow specified by workflow_id

      Exment Permission

      • Nothing

      API scope

      • workflow_read
      • workflow_execute

      Append version

      v3.0.8

      Authorizations:
      OAuth2
      path Parameters
      workflow_id
      required
      integer

      Workflow ID

      Responses

      Response samples

      Content type
      application/json
      [
      • {
        }
      ]

      Get a list of actions for a specified workflow

      Outline of processing

      • Get the workflow action list of the workflow specified by workflow_id

      Exment Permission

      • Nothing

      API scope

      • workflow_read
      • workflow_execute

      Append version

      v3.0.8

      Authorizations:
      OAuth2
      path Parameters
      workflow_id
      required
      integer

      Workflow ID

      Responses

      Response samples

      Content type
      application/json
      [
      • {
        }
      ]

      Get workflow status

      Outline of processing

      • Get workflow status information

      Exment Permission

      Nothing

      API scope

      • workflow_read
      • workflow_execute

      Append version

      v3.0.8

      Authorizations:
      OAuth2
      path Parameters
      id
      required
      integer

      Status 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 action information

      Outline of processing

      • Get workflow action information

      Exment Permission

      Nothing

      API scope

      • workflow_read
      • workflow_execute

      Append version

      v3.0.8

      Authorizations:
      OAuth2
      path Parameters
      id
      required
      integer

      Workflow action 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_conditions": [
        ]
      }

      Get the current workflow execution value for specific data

      Outline of processing

      • Select specific custom data and get the current workflow execution value of that custom data

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • workflow_read
      • workflow_execute

      Append version

      v3.0.8

      Authorizations:
      OAuth2
      path Parameters
      tableKey
      required
      string

      Table Name(Ex. information)

      id
      required
      integer

      Custom value ID

      query Parameters
      expands
      string

      Pre-execution status information, post-execution status information, and action information associated with the workflow execution value can be acquired. "status_from", "status_to", "action" can be specified. Separate multiple items with commas.

      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": {
        },
      • "workflow_status": {
        },
      • "workflow_action": {
        }
      }

      Run workflow for specific data

      Outline of processing

      • Select specific custom data and run the workflow
      • Execute the workflow by POSTing the workflow action ID
      • If the value of "Executable user" in the action setting is "Selected by the executable user of the previous action", either "users (list of user IDs that execute the action)" or "organizations (list of organization IDs)" of the next parameter Is essential
      • If an action that does not match the current status is executed, error code 204 is returned.
      • If the executing user does not have permission to perform the action, error code 204 is returned.

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • workflow_execute

      Append version

      v3.0.8

      path Parameters
      tableKey
      required
      string

      Table Name(Ex. information)

      id
      required
      integer

      Custom value ID

      Request Body schema: application/json
      workflow_action_id
      required
      integer

      Workflow action ID to execute

      comment
      string

      Workflow comments. Required if the action is comment_type "required". Ignored for "not_use"

      next_users
      string

      If "Executable user" of the action setting is "Selected by the executable user of the previous action", enter the user ID to execute the next action separated by commas.

      next_organizations
      string

      If "Executable user" of the action setting is "Selected by the executable user of the previous action", enter the organization ID to execute the next action separated by commas.

      Responses

      Request samples

      Content type
      application/json
      {
      • "workflow_action_id": 0,
      • "comment": "string",
      • "next_users": "string",
      • "next_organizations": "string"
      }

      Get a list of working users for specific data

      Outline of processing

      • Select specific custom data and get a list of current working users for that custom data
      • Only actions for which "Special Action" is not checked in the action settings will be acquired.
      • Add the query string "all=1" to get the working users of all actions

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • workflow_read
      • workflow_execute

      Append version

      v3.0.8

      Authorizations:
      OAuth2
      path Parameters
      tableKey
      required
      string

      Table Name(Ex. information)

      id
      required
      integer

      Custom value ID

      query Parameters
      as_user
      integer
      Default: "0"

      When it is 1, the worker whose action is set as "organization" is converted to the list of users belonging to that organization.

      all
      integer

      When 1, get the target users of all actions

      Responses

      Response samples

      Content type
      application/json
      {
      • "users": [
        ],
      • "organizations": [
        ]
      }

      Get a list of the next actions you can take on specific data

      Outline of processing

      • Select specific custom data and get a list of the next actions you can take for that custom data
      • Narrow down to actions that the logged-in user can perform
      • Add the query string "all=1" to get all actions, whether or not the logged-in user can perform them

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • workflow_read
      • workflow_execute

      Append version

      v3.0.8

      Authorizations:
      OAuth2
      path Parameters
      tableKey
      required
      string

      Table Name(Ex. information)

      id
      required
      integer

      Custom value ID

      query Parameters
      all
      integer
      Default: "0"

      When 1, get all actions, whether or not the logged-in user can perform them

      Responses

      Response samples

      Content type
      application/json
      [
      • {
        }
      ]

      Get a list of workflow history for specific data

      Outline of processing

      • Select specific custom data and get a workflow history list of that custom data

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • workflow_read
      • workflow_execute

      Append version

      v3.0.8

      Authorizations:
      OAuth2
      path Parameters
      tableKey
      required
      string

      Table Name(Ex. information)

      id
      required
      integer

      Custom value ID

      Notify

      Get notify list

      Outline of processing

      • Get the notification list in the notification bar
      • Get only unread notifications. Add parameter "all=1" to get all notifications

      Exment Permission

      • Nothing

      API scope

      • notify_read
      • notify_write

      Append version

      v3.0.8

      query Parameters
      all
      integer
      Default: "0"

      If 1, get all notifications

      count
      integer [ 1 .. 100 ]
      Default: "20"

      The number of cases to be acquired in one request. 1-100

      Responses

      Response samples

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

      Add notify

      Outline of processing

      • Send a notification to the specified user
      • Notifications are only added to the notification bar

      Exment Permission

      • Nothing

      API scope

      • notify_write

      Append version

      v3.0.8

      Request Body schema: application/json
      target_users
      required
      string

      The user ID to which the notification is sent. Separated by commas if there are multiple

      notify_subject
      required
      string

      Notification subject

      notify_body
      required
      string

      Notification body

      Responses

      Request samples

      Content type
      application/json
      {
      • "target_users": "2",
      • "notify_subject": "TestTest",
      • "notify_body": "This is body."
      }

      Response samples

      Content type
      application/json
      {
      • "notify_id": 0,
      • "target_user_id": "2",
      • "notify_subject": "TestTest",
      • "notify_body": "This is body.",
      • "trigger_user_id": "2",
      • "updated_at": "2019-11-18 19:21:36",
      • "created_at": "2019-11-18 19:21:36",
      • "id": 7
      }

      FileDocument

      File download

      Outline of processing

      • Download the file
      • If there is no query string, the file will be downloaded in stream format. If "base64=1", return in base64 format

      How to get the file URL

      How to get the file URL for download.

      Add query string "value type = text" in custom data acquisition API

      If the custom column type is file/image, the value will be the URL.

      Ex:GET
/api/data/testtable/1?valuetype=text

Return value(partial)
{
    "id": 1,
    "value": {
        "text": "test_1",
        "file": "http://locallost/admin/api/files/c09ff3a0-7677-11ea-9edf-178831242ff9"
    }
}
      Get document (attached file) list Get with API

      "api_url" is the URL to execute from the API.

      Ex:GET
/api/document/testtable/1

Return value(partial)
{
    "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"
        }
    ]
}

      Query string at the time of request and response content

      If base64=1 is not included in the request

      The response value will be in the file stream format.

      When base64=1 is entered at the time of request

      The response value will be json in the following format.

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

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • value_read
      • value_write

      Append version

      v3.1.7

      path Parameters
      uuid
      required
      string

      Random string assigned to the file

      query Parameters
      base64
      integer

      If 1, return as json type including base64 character string

      Responses

      Response samples

      Content type
      application/octet-stream
      application/octet-stream
      application/json
      No sample

      Delete file

      Outline of processing

      • Delete files
      • For attachments associated with specific data, delete the attachment information at the same time.

      How to get the file URL

      Please check "File Download".

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : Edit data

      API scope

      • value_write

      Append version

      v3.1.10

      path Parameters
      uuid
      required
      string

      Random string assigned to the file

      Responses

      File download

      Outline of processing

      • Download the file
      • If there is no query string, the file will be downloaded in stream format.If "base64=1", return in base64 format

      How to get the file URL

      How to get the file URL for download.

      Get with custom data get API

      If the custom column type is file/image, the acquired value will be processed.

      Ex:GET
/api/data/testtable/1

Return value(partial)
{
    "id": 1,
    "value": {
        "text": "test_1",
        "file": "testtable/c09ff510-7677-11ea-9096-a14cacaee56f.txt"
    }
}

      Use this value to run the API at a URL like this: http://localhost/api/files/testtable/c09ff510-7677-11ea-9096-a14cacaee56f.txt

      Query string at the time of request and response content

      If base64=1 is not included in the request

      The response value will be in the file stream format.

      When base64=1 is entered at the time of request

      The response value will be json in the following format.

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

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • value_read
      • value_write

      Append version

      v3.1.10

      path Parameters
      tableKey
      required
      string

      Table Name(Ex. information)

      filename
      required
      string

      File Name

      query Parameters
      base64
      integer

      If 1, return as json type including base64 character string

      Responses

      Response samples

      Content type
      application/octet-stream
      application/octet-stream
      application/json
      No sample

      Delete file

      Outline of processing

      • Delete files
      • For attachments associated with specific data, delete the attachment information at the same time.

      How to get the file URL

      Please check "File Download".

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : Edit data

      API scope

      • value_write

      Append version

      v3.1.10

      path Parameters
      tableKey
      required
      string

      Table Name(Ex. information)

      filename
      required
      string

      File Name

      Responses

      Get a list of documents (attached files)

      Outline of processing

      • Select specific custom data and get a list of documents (attachments) for that custom data

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : View all data
      • Table : Access all data
      • Table : Edit data
      • Table : View data

      API scope

      • value_read
      • value_write

      Append version

      v3.1.10

      path Parameters
      tableKey
      required
      string

      Table Name(Ex. information)

      id
      required
      string

      Custom value ID

      query Parameters
      page
      integer
      Default: "1"

      Page number to get

      count
      integer [ 1 .. 100 ]
      Default: "20"

      The number of cases to be acquired in one request. 1-100

      Responses

      Response samples

      Content type
      application/json
      {}

      Creating a document (attachment)

      Outline of processing

      • Select specific custom data and upload the document (attachment) associated with that data

      Exment Permission

      • System : System information
      • System : Custom table
      • System : All data
      • Table : Table
      • Table : Edit all data
      • Table : Edit data

      API scope

      • value_write

      Append version

      v3.1.10

      path Parameters
      tableKey
      required
      string

      Table Name(Ex. information)

      id
      required
      string

      Custom value ID

      Request Body schema: application/json
      name
      required
      string

      File name

      base64
      required
      string

      base64 string

      Responses

      Request samples

      Content type
      application/json
      {
      • "name": "string",
      • "base64": "string"
      }

      Response samples

      Content type
      application/json
      {}

      Log

      Get operation log list

      Outline of processing

      • Get screen/API operation log. Order by created_at desc.

      Exment Permission

      • System : System information

      API scope

      • log

      Append version

      • v4.0.3 Added
      query Parameters
      page
      integer
      Default: "1"

      Page number to get

      count
      integer [ 1 .. 100 ]
      Default: "20"

      The number of cases to be acquired in one request. 1-100

      login_user_id
      integer

      Login user table ID

      base_user_id
      integer

      ID of the "user" table of custom data

      path
      string

      Target URI of HTTP request

      method
      string

      Methods (GET, POST, etc.)

      ip
      string

      IP address of the executing user

      target_datetime_start
      string

      The start date and time of the execution date and time to be acquired. If "2021-02-17 11:45:31" is set, the log after this date and time will be acquired.

      target_datetime_end
      string

      The end date and time of the execution date and time to be acquired. If "2021-02-17 11:45:31" is set, the log before this date and time will be acquired.

      Responses

      Response samples

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

      Get operation log

      Outline of processing

      • Get trget ID's screen/API operation log

      Exment Permission

      • System : System information

      API scope

      • log

      Append version

      • v4.0.3 Added
      path Parameters
      id
      required
      string

      Operation log 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"
      }