Table
API for Table object
Method & Permission
API
GET
POST
PUT
PATCH
DELETE
Table List
Admin, Member
Admin
-
-
-
Table Detail
Admin, Member
-
-
Admin
-
Table List
GET
{{ base_url }} /tables/table/list/{level}/{sid}/{serializer}/
Path Parameters
level
string
organization
sid
string
organization sid
serializer
string
Headers
token
string
# serializer = name
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 9,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"name": "experiment",
"name_plural": "experiments",
"name_singular": "experiment"
},
...
]
}
# serializer = list
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 9,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"icon": "xxx",
"name_singular": "experiment",
"name_plural": "experiments",
"unique_code": "EP",
"table_type": "Document",
"order": 1,
"is_archived": false,
"change_permission": true
},
...
]
}
# serializer = detail
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 9,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"icon": "assignment",
"name": "experiments",
"name_singular": "experiment",
"name_plural": "experiments",
"name_system": null,
"description": "An experiment is the lab note that document the purpose, the procedures the results of the experiment.",
"unique_code": "EP",
"default_view": "detail",
"order": 3,
"number_of_records": 4,
"number_of_columns": 2,
"number_of_sections": 6,
"number_of_filters": 2,
"number_of_workflows": 3,
"metadata": [
],
"default_filter": null,
"is_archived": false,
"updated_by": "xxx",
"date_updated": "2020-05-25T00:35:21.236133Z",
"date_created": "2020-05-25T00:35:21.234651Z",
"change_permission": true
},
...
]
}
Table List
POST
{{ base_url }} /tables/table/list/{level}/{sid}/{serializer}/
Path Parameters
level
string
organization
sid
string
organization sid
serializer
string
Headers
token
string
Request Body
name_singular
string
name_plural
string
description
string
unique_code
string
icon
string
table_type
string
is_archived
boolean
{
"sid": "xxx",
"icon": "assignment",
"name": "experiments",
"name_singular": "experiment",
"name_plural": "experiments",
"name_system": null,
"description": "An experiment is the lab note that document the purpose, the procedures the results of the experiment.",
"unique_code": "EP",
"default_view": "detail",
"order": 3,
"number_of_records": 4,
"number_of_columns": 2,
"number_of_sections": 6,
"number_of_filters": 2,
"number_of_workflows": 3,
"metadata": [
],
"default_filter": null,
"is_archived": false,
"updated_by": "xxx",
"date_updated": "2020-05-25T00:35:21.236133Z",
"date_created": "2020-05-25T00:35:21.234651Z",
"change_permission": true
}
Table Detail
GET
{{ base_url }} /tables/table/detail/{sid}/
Path Parameters
sid
string
Headers
token
string
{
"sid": "xxx",
"icon": "assignment",
"name": "experiments",
"name_singular": "experiment",
"name_plural": "experiments",
"name_system": null,
"description": "An experiment is the lab note that document the purpose, the procedures the results of the experiment.",
"unique_code": "EP",
"default_view": "detail",
"order": 3,
"number_of_records": 4,
"number_of_columns": 2,
"number_of_sections": 6,
"number_of_filters": 2,
"number_of_workflows": 3,
"metadata": [
],
"default_filter": null,
"is_archived": false,
"updated_by": "xxx",
"date_updated": "2020-05-25T00:35:21.236133Z",
"date_created": "2020-05-25T00:35:21.234651Z",
"change_permission": true
}
Table Detail
PATCH
{{ base_url }} /tables/table/detail/{sid}/
Path Parameters
sid
string
Headers
token
string
Request Body
name_singular
string
name_plural
string
description
string
unique_code
string
icon
string
order
number
table_type
string
is_archived
boolean
{
"sid": "xxx",
"icon": "assignment",
"name": "experiments",
"name_singular": "experiment",
"name_plural": "experiments",
"name_system": null,
"description": "An experiment is the lab note that document the purpose, the procedures the results of the experiment.",
"unique_code": "EP",
"default_view": "detail",
"order": 3,
"number_of_records": 4,
"number_of_columns": 2,
"number_of_sections": 6,
"number_of_filters": 2,
"number_of_workflows": 3,
"metadata": [
],
"default_filter": null,
"is_archived": false,
"updated_by": "xxx",
"date_updated": "2020-05-25T00:35:21.236133Z",
"date_created": "2020-05-25T00:35:21.234651Z",
"change_permission": true
}
Last updated