Column

Method & Permission

API	GET	POST	PUT	PATCH	DELETE
Column List	Admin, Member	Admin	-	-	-
Column Detail	Admin, Member	-	-	Admin	-

GET Column List

Endpoint: /tables/column/list/{level}/{sid}/{serializer}/

Parameter: level (path, string)

organization

Parameter: sid (path, string)

organization sid

Parameter: serializer (path, string)

Parameter: token (header, string)

Parameter: table__sid (query, string)

Response: 200

# 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

Endpoint: /tables/column/list/{level}/{sid}/{serializer}/

Parameter: level (path, string)

organization

Parameter: sid (path, string)

organization sid

Parameter: serializer (path, string)

Parameter: token (header, string)

Parameter: table__sid (query, string)

table sid

Parameter: name (body, string)

Parameter: description (body, string)

Parameter: data_type (body, string)

Parameter: default_value (body, string)

Parameter: is_required (body, boolean)

Parameter: is_hidded (body, boolean)

Parameter: is_archived (body, boolean)

Response: 201

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

Response: 406

Error: Widget is not valid!

GET Column Detail

Endpoint: /tables/column/detail/{sid}/

Parameter: sid (path, string)

Parameter: token (header, string)

Response: 200

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

Endpoint: /tables/column/detail/{sid}/

Parameter: sid (path, string)

Parameter: token (header, string)

Parameter: name (body, string)

Parameter: description (body, string)

Parameter: date_type (body, string)

Parameter: default_value (body, string)

Parameter: is_required (body, boolean)

Parameter: is_hidden (body, boolean)

Parameter: is_archived (body, boolean)

Response: 200

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