Table

API for Table object

Method & Permission

API

GET

POST

PUT

PATCH

DELETE

Table List

Admin, Member

Admin

-

-

-

Table Detail

Admin, Member

-

-

Admin

-

get
Table List

{{ base_url }} /tables/table/list/{level}/{sid}/{serializer}/
Request
Response
Request
Path Parameters
level
required
string
organization
sid
required
string
organization sid
serializer
required
string
Headers
token
required
string
Response
200: OK
serializer = list
# 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
},
...
]
}

post
Table List

{{ base_url }} /tables/table/list/{level}/{sid}/{serializer}/
Request
Response
Request
Path Parameters
level
required
string
organization
sid
required
string
organization sid
serializer
required
string
Headers
token
required
string
Form Data Parameters
name_singular
optional
string
name_plural
optional
string
description
optional
string
unique_code
optional
string
icon
optional
string
table_type
optional
string
is_archived
optional
boolean
Response
201: Created
{
"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
}
400: Bad Request
{"non_field_errors":
[
"The fields organization, name_plural must make a unique set.",
"The fields organization, name_singular must make a unique set.",
"The fields organization, unique_code must make a unique set."
]
}

get
Table Detail

{{ base_url }} /tables/table/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
Headers
token
required
string
Response
200: OK
{
"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
}

patch
Table Detail

{{ base_url }} /tables/table/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
Headers
token
required
string
Form Data Parameters
name_singular
optional
string
name_plural
optional
string
description
optional
string
unique_code
optional
string
icon
optional
string
order
optional
number
table_type
optional
string
is_archived
optional
boolean
Response
200: OK
{
"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
}