Labii ELN & LIMS
Labii ELN & LIMS
Home
Free Trial
Schedule a demo
Blog
Introduction
Quick Start
ELN & LIMS
Add Record
List View
Detail View
Search
Statistics
Settings
Accounts
Support
Widgets
Summary
Variables
Column Widgets
Office
Productivity
Regulation
Biology
Chemistry
Reference Manager
Report
Combination
API
Overview
Methods
Authentication
Organization
Personnel
Team
Organization Widget
Statement
Backup
Project
Member
Table
Column
Filter
Row
Cell
Section
Trail
Version
Workflow
Step
Widget
SDK
Applications
Electronic Lab Notebook
Document Management
Track sample consumption
Goal management
Reference Manager
Support
FAQ
API
Powered by GitBook

Column

API for Column object

Method & Permission

API

GET

POST

PUT

PATCH

DELETE

Column List

Admin, Member

Admin

-

-

-

Column Detail

Admin, Member

-

-

Admin

-

get
Column List

{{ base_url }} /tables/column/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
​
Query Parameters
table__sid
required
string
​
Response
200: OK
# serializer = name
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 7,
    "count": 1,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "name": "date_start"
        },
        ...
    ]
}
# serializer = list
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 7,
    "count": 1,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "name": "date_start",
            "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,
            "is_required": true,
            "is_hidden": false,
            "is_archived": false,
            "order": 1,
            "table": {
                "sid": "xxx",
                "name": "experiments"
            },
            "change_permission": true
        },
        ...
    ]
}
# serializer = detail
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 7,
    "count": 1,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "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-05-25T00:35:21.253211Z",
            "change_permission": true
        },
        ...
    ]
}

post
Column List

{{ base_url }} /tables/column/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
​
Query Parameters
table__sid
required
string
table sid
Form Data Parameters
name
required
string
​
description
optional
string
​
data_type
optional
string
​
default_value
optional
string
​
is_required
optional
boolean
​
is_hidded
optional
boolean
​
is_archived
optional
boolean
​
Response
201: Created
{
    "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-05-25T00:35:21.253211Z",
    "change_permission": true
}
406: Not Acceptable
Error: Widget is not valid!

get
Column Detail

{{ base_url }} /tables/column/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
​
Headers
token
required
string
​
Response
200: OK
{
    "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-05-25T00:35:21.253211Z",
    "change_permission": true
}

patch
Column Detail

{{ base_url }} /tables/column/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
​
Headers
token
required
string
​
Form Data Parameters
name
optional
string
​
description
optional
string
​
date_type
optional
string
​
default_value
optional
string
​
is_required
optional
boolean
​
is_hidden
optional
boolean
​
is_archived
optional
boolean
​
Response
200: OK
{
    "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-05-25T00:35:21.253211Z",
    "change_permission": true
}

​

Previous
Table
Next
Filter
Last updated 5 months ago
Contents
Method & Permission
get
Column List
post
Column List
get
Column Detail
patch
Column Detail