列

方法与权限

API	GET	POST	PUT	PATCH	DELETE
列列表	管理员, 成员	管理员	-	-	-
列详情	管理员, 成员	-	-	管理员	-

获取列列表

端点: /tables/column/list/{level}/{sid}/{serializer}/

参数: level (路径, 字符串)

organization

参数: sid (路径, 字符串)

organization sid

参数: serializer (路径, 字符串)

参数: token (头部, 字符串)

参数: table__sid (查询, 字符串)

响应: 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
        },
        ...
    ]
}

创建列

端点: /tables/column/list/{level}/{sid}/{serializer}/

参数: level (路径, 字符串)

organization

参数: sid (路径, 字符串)

organization sid

参数: serializer (路径, 字符串)

参数: token (头部, 字符串)

参数: table__sid (查询, 字符串)

table sid

参数: name (正文, 字符串)

参数: description (正文, 字符串)

参数: data_type (正文, 字符串)

参数: default_value (正文, 字符串)

参数: is_required (正文, 布尔值)

参数: is_hidded (正文, 布尔值)

参数: is_archived (正文, 布尔值)

响应: 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
}

响应: 406

Error: Widget is not valid!

获取列详情

端点: /tables/column/detail/{sid}/

参数: sid (路径, 字符串)

参数: token (头部, 字符串)

响应: 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
}

修改列详情

端点: /tables/column/detail/{sid}/

参数: sid (路径, 字符串)

参数: token (头部, 字符串)

参数: name (正文, 字符串)

参数: description (正文, 字符串)

参数: date_type (正文, 字符串)

参数: default_value (正文, 字符串)

参数: is_required (正文, 布尔值)

参数: is_hidden (正文, 布尔值)

参数: is_archived (正文, 布尔值)

响应: 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
}