Row
API for Row object
Method & Permission
API
GET
POST
PUT
PATCH
DELETE
Row List
Admin, Project Admin, Project Edit, Project View
Project Admin, Project Edit
-
-
-
Row Detail
Admin, Project Admin, Project Edit, Project View
-
-
Project Admin*, Project Edit*
-
*row with is_locked=True can not be updated
*row with is_archived=True can not be updated, except the field of is_archived
Row List
GET {{ base_url }} /tables/row/list/{level}/{sid}/{serializer}/
Path Parameters
Name
Type
Description
level
string
organization
sid
string
organization sid
serializer
string
Query Parameters
Name
Type
Description
presigned_post
string
Past presigned_post to get URL to upload a file
Headers
Name
Type
Description
token
string
# serializer = name
{
"page_size": 10,
"page_number": 1,
"page_count": xxx,
"count": xxx,
"next": "xxx",
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"name": "EP625: Test Name 20200525133408",
"table__name_plural": "experiments",
"description": "Test add from sidebar 20200525133408"
},
...
]
}
# serializer = list
{
"page_size": 10,
"page_number": 1,
"page_count": xxx,
"count": xxx,
"next": "xxx",
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"uid": "EP622",
"name": "EP622: Test Name 20200524151652",
"column_set": [
{
"column": {
"sid": "xxx",
"name": "date_start",
"name_system": null,
"description": "The start date of the expriment.",
"widget": {
"sid": "xxx",
"name": "Date",
"documentation_url": "https://docs.labii.com/widgets/column-widgets#date"
},
"default_value": null,
"order": 1,
"is_required": true,
"is_hidden": false,
"metadata": {
},
"table": {
"sid": "xxx",
"name": "experiments"
},
"is_archived": false,
"date_created": "2020-02-10T03:02:26.988985Z",
"change_permission": false
},
"data": "2020-05-24",
"sid": "xxx"
},
{
"column": {
"sid": "xxx",
"name": "date_due",
"name_system": null,
"description": "The expected end date of the experiment.",
"widget": {
"sid": "xxx",
"name": "Date",
"documentation_url": "https://docs.labii.com/widgets/column-widgets#date"
},
"default_value": null,
"order": 2,
"is_required": false,
"is_hidden": false,
"metadata": {
},
"table": {
"sid": "xxx",
"name": "experiments"
},
"is_archived": false,
"date_created": "2020-02-10T03:02:27.004055Z",
"change_permission": false
},
"data": ""
}
],
"projects": [
{
"sid": "xxx",
"name": "Sample Project"
}
],
"owner": "Test Labii",
"is_template": false,
"change_permission": true
},
...
]
}
# serializer = detail
{
"page_size": 10,
"page_number": 1,
"page_count": xxx,
"count": xxx,
"next": "xxx",
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"uid": "EP622",
"version": 3,
"table": {
"sid": "xxx",
"name": "experiments"
},
"projects": [
{
"sid": "xxx",
"name": "Sample Project"
}
],
"name": "EP622: Test Name 20200524151652",
"description": "Test add from sidebar 20200524151652",
"is_template": false,
"is_archived": false,
"metadata": [
],
"updated_by": "Test Labii",
"date_updated": "2020-05-24T22:19:35.179111Z",
"owner": "Test Labii",
"date_created": "2020-05-24T22:19:35.174584Z",
"column_set": [
{
"column": {
"sid": "xxx",
"name": "date_start",
"name_system": null,
"description": "The start date of the expriment.",
"widget": {
"sid": "xxx",
"name": "Date",
"documentation_url": "https://docs.labii.com/widgets/column-widgets#date"
},
"default_value": null,
"order": 1,
"is_required": true,
"is_hidden": false,
"metadata": {
},
"table": {
"sid": "xxx",
"name": "experiments"
},
"is_archived": false,
"date_created": "2020-02-10T03:02:26.988985Z",
"change_permission": false
},
"data": "2020-05-24",
"sid": "xxx"
},
{
"column": {
"sid": "xxx",
"name": "date_due",
"name_system": null,
"description": "The expected end date of the experiment.",
"widget": {
"sid": "xxx",
"name": "Date",
"documentation_url": "https://docs.labii.com/widgets/column-widgets#date"
},
"default_value": null,
"order": 2,
"is_required": false,
"is_hidden": false,
"metadata": {
},
"table": {
"sid": "xxx",
"name": "experiments"
},
"is_archived": false,
"date_created": "2020-02-10T03:02:27.004055Z",
"change_permission": false
},
"data": ""
}
],
"section_set": [
{
"sid": "xxx",
"table": {
"sid": "xxx",
"name": "experiments"
},
"row": {
"sid": "xxx",
"name": "Overview"
},
"name": "Overview",
"description": "",
"widget": {
"sid": "xxx",
"icon": "format_color_text",
"name": "Rich Text (CKEditor Classic)",
"category": "Office",
"sub_category": "Text, Word, Docs",
"company": "Labii Inc.",
"notes": "Smart WYSIWYG HTML editor",
"description": "xxx",
"documentation_url": "https://docs.labii.com/widgets/office/text#rich-text-ckeditor-classic",
"usecase": "Protocol Steps; Experiment Overview; Descriptional Result;",
"type": "Section",
"constructor": "object",
"related_to": "xxx",
"version": "1.00",
"release_date": "2020-04-19",
"order": "2.00",
"subscription_price": "Free",
"ppu_price": "0.15",
"allow_multiple": true,
"is_readonly": false,
"metadata_labels": "",
"data": "xxx",
"default_data": ""
},
"data": {
},
"order": 1,
"metadata": {
},
"is_archived": false,
"date_updated": "2020-05-24T22:19:36.439669Z",
"date_created": "2020-05-24T22:19:36.436904Z",
"updated_by": "Test Labii",
"change_permission": true
}
],
"change_permission": true
},
...
]
}Error: missing table__sid in the get parametersRow List
POST {{ base_url }} /tables/row/list/{level}/{sid}/{serializer}/
Path Parameters
Name
Type
Description
level
string
organization
sid
string
organization sid
serializer
string
Headers
Name
Type
Description
token
string
Request Body
Name
Type
Description
projects
array
name
string
description
string
is_template
boolean
open_to_organization
boolean
is_archived
boolean
metadata
string
{
"sid": "xxx",
"uid": "EP622",
"version": 3,
"table": {
"sid": "xxx",
"name": "experiments"
},
"projects": [
{
"sid": "xxx",
"name": "Sample Project"
}
],
"name": "EP622: Test Name 20200524151652",
"description": "Test add from sidebar 20200524151652",
"is_template": false,
"is_archived": false,
"metadata": [
],
"updated_by": "Test Labii",
"date_updated": "2020-05-24T22:19:35.179111Z",
"owner": "Test Labii",
"date_created": "2020-05-24T22:19:35.174584Z",
"column_set": [
{
"column": {
"sid": "xxx",
"name": "date_start",
"name_system": null,
"description": "The start date of the expriment.",
"widget": {
"sid": "xxx",
"name": "Date",
"documentation_url": "https://docs.labii.com/widgets/column-widgets#date"
},
"default_value": null,
"order": 1,
"is_required": true,
"is_hidden": false,
"metadata": {
},
"table": {
"sid": "xxx",
"name": "experiments"
},
"is_archived": false,
"date_created": "2020-02-10T03:02:26.988985Z",
"change_permission": false
},
"data": "2020-05-24",
"sid": "xxx"
},
{
"column": {
"sid": "xxx",
"name": "date_due",
"name_system": null,
"description": "The expected end date of the experiment.",
"widget": {
"sid": "xxx",
"name": "Date",
"documentation_url": "https://docs.labii.com/widgets/column-widgets#date"
},
"default_value": null,
"order": 2,
"is_required": false,
"is_hidden": false,
"metadata": {
},
"table": {
"sid": "xxx",
"name": "experiments"
},
"is_archived": false,
"date_created": "2020-02-10T03:02:27.004055Z",
"change_permission": false
},
"data": ""
}
],
"section_set": [
{
"sid": "xxx",
"table": {
"sid": "xxx",
"name": "experiments"
},
"row": {
"sid": "xxx",
"name": "Overview"
},
"name": "Overview",
"description": "",
"widget": {
"sid": "xxx",
"icon": "format_color_text",
"name": "Rich Text (CKEditor Classic)",
"category": "Office",
"sub_category": "Text, Word, Docs",
"company": "Labii Inc.",
"notes": "Smart WYSIWYG HTML editor",
"description": "xxx",
"documentation_url": "https://docs.labii.com/widgets/office/text#rich-text-ckeditor-classic",
"usecase": "Protocol Steps; Experiment Overview; Descriptional Result;",
"type": "Section",
"constructor": "object",
"related_to": "xxx",
"version": "1.00",
"release_date": "2020-04-19",
"order": "2.00",
"subscription_price": "Free",
"ppu_price": "0.15",
"allow_multiple": true,
"is_readonly": false,
"metadata_labels": "",
"data": "xxx",
"default_data": ""
},
"data": {
},
"order": 1,
"metadata": {
},
"is_archived": false,
"date_updated": "2020-05-24T22:19:36.439669Z",
"date_created": "2020-05-24T22:19:36.436904Z",
"updated_by": "Test Labii",
"change_permission": true
}
],
"change_permission": true
},
}Your organization does not have enough credits, contact sales@labii.com!
Character (%s) not allowed. Not allowed character are "#", "&", "*", "?", "^", "`", "<", ">"Row Detail
GET {{ base_url }} /tables/row/detail/{sid}/
Path Parameters
Name
Type
Description
sid
string
Query Parameters
Name
Type
Description
presigned_post
string
Pass presigned_post to get URL to upload a file
presigned_url
string
Pass presigned_url to get URL to download the file
Headers
Name
Type
Description
token
string
{
"sid": "xxx",
"uid": "EP622",
"version": 3,
"table": {
"sid": "xxx",
"name": "experiments"
},
"projects": [
{
"sid": "xxx",
"name": "Sample Project"
}
],
"name": "EP622: Test Name 20200524151652",
"description": "Test add from sidebar 20200524151652",
"is_template": false,
"is_archived": false,
"metadata": [
],
"updated_by": "Test Labii",
"date_updated": "2020-05-24T22:19:35.179111Z",
"owner": "Test Labii",
"date_created": "2020-05-24T22:19:35.174584Z",
"column_set": [
{
"column": {
"sid": "xxx",
"name": "date_start",
"name_system": null,
"description": "The start date of the expriment.",
"widget": {
"sid": "xxx",
"name": "Date",
"documentation_url": "https://docs.labii.com/widgets/column-widgets#date"
},
"default_value": null,
"order": 1,
"is_required": true,
"is_hidden": false,
"metadata": {
},
"table": {
"sid": "xxx",
"name": "experiments"
},
"is_archived": false,
"date_created": "2020-02-10T03:02:26.988985Z",
"change_permission": false
},
"data": "2020-05-24",
"sid": "xxx"
},
{
"column": {
"sid": "xxx",
"name": "date_due",
"name_system": null,
"description": "The expected end date of the experiment.",
"widget": {
"sid": "xxx",
"name": "Date",
"documentation_url": "https://docs.labii.com/widgets/column-widgets#date"
},
"default_value": null,
"order": 2,
"is_required": false,
"is_hidden": false,
"metadata": {
},
"table": {
"sid": "xxx",
"name": "experiments"
},
"is_archived": false,
"date_created": "2020-02-10T03:02:27.004055Z",
"change_permission": false
},
"data": ""
}
],
"section_set": [
{
"sid": "xxx",
"table": {
"sid": "xxx",
"name": "experiments"
},
"row": {
"sid": "xxx",
"name": "Overview"
},
"name": "Overview",
"description": "",
"widget": {
"sid": "xxx",
"icon": "format_color_text",
"name": "Rich Text (CKEditor Classic)",
"category": "Office",
"sub_category": "Text, Word, Docs",
"company": "Labii Inc.",
"notes": "Smart WYSIWYG HTML editor",
"description": "xxx",
"documentation_url": "https://docs.labii.com/widgets/office/text#rich-text-ckeditor-classic",
"usecase": "Protocol Steps; Experiment Overview; Descriptional Result;",
"type": "Section",
"constructor": "object",
"related_to": "xxx",
"version": "1.00",
"release_date": "2020-04-19",
"order": "2.00",
"subscription_price": "Free",
"ppu_price": "0.15",
"allow_multiple": true,
"is_readonly": false,
"metadata_labels": "",
"data": "xxx",
"default_data": ""
},
"data": {
},
"order": 1,
"metadata": {
},
"is_archived": false,
"date_updated": "2020-05-24T22:19:36.439669Z",
"date_created": "2020-05-24T22:19:36.436904Z",
"updated_by": "Test Labii",
"change_permission": true
}
],
"change_permission": true
},
}Row Detail
PATCH {{ base_url }} /tables/table/detail/{sid}/
Path Parameters
Name
Type
Description
sid
string
Headers
Name
Type
Description
token
string
Request Body
Name
Type
Description
project__sid
string
name
string
description
string
is_template
string
open_to_organization
string
is_archived
string
metadata
string
{
"sid": "xxx",
"uid": "EP622",
"version": 3,
"table": {
"sid": "xxx",
"name": "experiments"
},
"projects": [
{
"sid": "xxx",
"name": "Sample Project"
}
],
"name": "EP622: Test Name 20200524151652",
"description": "Test add from sidebar 20200524151652",
"is_template": false,
"is_archived": false,
"metadata": [
],
"updated_by": "Test Labii",
"date_updated": "2020-05-24T22:19:35.179111Z",
"owner": "Test Labii",
"date_created": "2020-05-24T22:19:35.174584Z",
"column_set": [
{
"column": {
"sid": "xxx",
"name": "date_start",
"name_system": null,
"description": "The start date of the expriment.",
"widget": {
"sid": "xxx",
"name": "Date",
"documentation_url": "https://docs.labii.com/widgets/column-widgets#date"
},
"default_value": null,
"order": 1,
"is_required": true,
"is_hidden": false,
"metadata": {
},
"table": {
"sid": "xxx",
"name": "experiments"
},
"is_archived": false,
"date_created": "2020-02-10T03:02:26.988985Z",
"change_permission": false
},
"data": "2020-05-24",
"sid": "xxx"
},
{
"column": {
"sid": "xxx",
"name": "date_due",
"name_system": null,
"description": "The expected end date of the experiment.",
"widget": {
"sid": "xxx",
"name": "Date",
"documentation_url": "https://docs.labii.com/widgets/column-widgets#date"
},
"default_value": null,
"order": 2,
"is_required": false,
"is_hidden": false,
"metadata": {
},
"table": {
"sid": "xxx",
"name": "experiments"
},
"is_archived": false,
"date_created": "2020-02-10T03:02:27.004055Z",
"change_permission": false
},
"data": ""
}
],
"section_set": [
{
"sid": "xxx",
"table": {
"sid": "xxx",
"name": "experiments"
},
"row": {
"sid": "xxx",
"name": "Overview"
},
"name": "Overview",
"description": "",
"widget": {
"sid": "xxx",
"icon": "format_color_text",
"name": "Rich Text (CKEditor Classic)",
"category": "Office",
"sub_category": "Text, Word, Docs",
"company": "Labii Inc.",
"notes": "Smart WYSIWYG HTML editor",
"description": "xxx",
"documentation_url": "https://docs.labii.com/widgets/office/text#rich-text-ckeditor-classic",
"usecase": "Protocol Steps; Experiment Overview; Descriptional Result;",
"type": "Section",
"constructor": "object",
"related_to": "xxx",
"version": "1.00",
"release_date": "2020-04-19",
"order": "2.00",
"subscription_price": "Free",
"ppu_price": "0.15",
"allow_multiple": true,
"is_readonly": false,
"metadata_labels": "",
"data": "xxx",
"default_data": ""
},
"data": {
},
"order": 1,
"metadata": {
},
"is_archived": false,
"date_updated": "2020-05-24T22:19:36.439669Z",
"date_created": "2020-05-24T22:19:36.436904Z",
"updated_by": "Test Labii",
"change_permission": true
}
],
"change_permission": true
},
}Last updated
