通过Smartsheet API获取列说明

时间:2019-02-13 14:31:08

标签: smartsheet-api-2.0

在Smartsheet界面中,您可以为每列添加一个说明(然后通过一个小弹出窗口即可看到该说明),是否可以通过API检索它?

我在doc中找不到它。

谢谢

1 个答案:

答案 0 :(得分:2)

糟糕!是的,可以使用API​​检索列说明。您也很正确地认为我们的文档中没有提到它。对于那个很抱歉!感谢您提请我们注意。我们将在下一版API文档中使用它。
列对象包含一个与表单中的列描述相匹配的'description'属性。以下是来自GET column请求的示例响应:

{
    "pageNumber": 1,
    "pageSize": 100,
    "totalPages": 1,
    "totalCount": 2,
    "data": [
        {
            "id": 1620508178442116,
            "version": 0,
            "index": 0,
            "title": "Primary Column",
            "type": "TEXT_NUMBER",
            "primary": true,
            "validation": false,
            "width": 150
        },
        {
            "id": 6124107805812612,
            "version": 0,
            "index": 1,
            "title": "Column2",
            "description": "I'm a description in a column.",
            "type": "TEXT_NUMBER",
            "validation": false,
            "width": 150
        }
    ]
}