获取字段

本文提供调用「获取字段」接口的操作示例。

示例：获取指定维格表的所有字段

假设你有一张渠道销售库存汇总表，你想获取这张维格表的所有字段信息：

你的操作步骤如下：

1. 获取你的 API Token。（获取方法）

2. 获取该维格表的 ID。（获取方法）

3. 打开你电脑上的终端，执行下列代码，向服务器发送查询请求（假设 datasheetId 为 dst0vPx2577RdMN9MC）：

   cURL

   curl -X GET \
   "https://vika.cn/fusion/v1/datasheets/dst0vPx2577RdMN9MC/fields" \
   -H "Authorization: Bearer {你的 API Token}"

   Javascript SDK

   注意：需要先下载和初始化 Javascript SDK，再执行如下命令。

   const datasheet = vika.datasheet("dst0vPx2577RdMN9MC");
   const fieldsResp = await datasheet.fields.list()
   
   if (fieldsResp.success) {
     console.log(fieldsResp.data.fields);
   } else {
     console.error(fieldsResp);
   }

   Python SDK

   注意：需要先下载和初始化 Python SDK，再执行如下命令。

   dst = vika.datasheet("dst0vPx2577RdMN9MC")
   
   # 获取所有字段
   fields = dst.fields.all()
   for field in fields:
     print(field.json())

4. 服务器会返回下列 JSON 数据包，"fields" 下即为返回的所有字段信息：

   有关返回结果中各参数的含义，可查看 API 手册。

   {
       "code": 200,
       "success": true,
       "data": {
           "fields": [
               {
                   "id": "fldrC8BmB7B9K",
                   "name": "商品UPC",
                   "type": "SingleText",
                   "property": {
                       "defaultValue": ""
                   },
                   "editable": true,
                   "isPrimary": true,
                   "desc": "这是商品的编号"
               },
               {
                   "id": "fldbbp2cXjnx0",
                   "name": "sku名称",
                   "type": "SingleText",
                   "property": {
                       "defaultValue": ""
                   },
                   "editable": true
               },
               {
                   "id": "fld9lpDSWuNcZ",
                   "name": "品牌",
                   "type": "SingleSelect",
                   "property": {
                       "options": [
                           {
                               "id": "optpTVSGk0R2M",
                               "name": "Elevit",
                               "color": {
                                   "name": "indigo_4",
                                   "value": "#5586FF"
                               }
                           },
                           {
                               "id": "optqX2Bw479FG",
                               "name": "OAD",
                               "color": {
                                   "name": "blue_4",
                                   "value": "#55CDFF"
                               }
                           }
                       ]
                   },
                   "editable": true
               }
           ]
       },
       "message": "SUCCESS"
   }