获取工作表结构信息

请求参数

Body 参数application/json

appKey

string

AppKey

必需

sign

string

签名

必需

worksheetId

string

工作表 id

必需

示例

{
  "appKey": "4fa7cd2c37b8444e",
  "sign": "YjE5YTg4YTg2MmY2ZjQ4ZjUxMDcxNjk4YTI1MDRmYjQ0N2NkOGExYTJhODdkMDEzYWE3ZTFmMTIwODBlODk4Yg==",
  "worksheetId": "65dda1a5a608a40050774c72"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request POST '/v2/open/worksheet/getWorksheetInfo' \
--header 'Content-Type: application/json' \
--data-raw '{
  "appKey": "4fa7cd2c37b8444e",
  "sign": "YjE5YTg4YTg2MmY2ZjQ4ZjUxMDcxNjk4YTI1MDRmYjQ0N2NkOGExYTJhODdkMDEzYWE3ZTFmMTIwODBlODk4Yg==",
  "worksheetId": "65dda1a5a608a40050774c72"
}'

返回响应

🟢200成功

application/json

Body

success

boolean

必需

code

integer

必需

msg

string

必需

data

object

必需

projectId

string

组织ID

必需

appid

string

应用ID

必需

worksheetId

string

工作表ID

必需

name

string

工作表名称

必需

alias

string

工作表别名

必需

createTime

string

创建时间

必需

caid

string

创建人账号Id

必需

desc

string

说明

必需

entityName

string

记录实体名称

必需

groupId

string

分组ID

必需

shareRange

string

必需

分享范围 1：关闭分享 2：完全公开 3：成员可见

controls

array [object {5}]

控件列表

必需

示例

成功示例异常示例

{
  "success": true,
  "code": 1,
  "msg": "ok",
  "data": {
    "projectId": "faa2f6b1-f706-4084-9a8d-XXXXXXXXX",
    "appId": "f553c2a3-aa0b-47a3-94d2-XXXXXXXXX",
    "worksheetId": "62a7058cfe536211a3aac4fb",
    "name": "工作表demo",
    "alias": "gzbdemo",
    "createTime": "2014-07-19 18:18:06",
    "caid": "e2453de8-1a6a-4d4f-ba36-87fdff880a20",
    "desc": "工作表描述说明",
    "entityName": "记录",
    "groupId": "62a70572030e06b46c007ca5",
    "shareRange": 2,
    "controls": [
      {
        "controlId": "262a7058cfe536211a3aac4fc",
        "controlName": "名称",
        "type": "2",
        "value": "默认值",
        "alias": "别名"
      },
      {
        "controlId": "21222344fe536211a3abc4fb",
        "controlName": "名称",
        "type": "3",
        "value": "默认值",
        "alias": "别名"
      }
    ]
  }
}

🟠401没有权限

🟠404记录不存在