Get worksheet structure information

Request

Body Params application/json

appKey

string

AppKey

required

sign

string

Signature

required

worksheetId

string

Worksheet id

required

Example

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

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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

Responses

🟢200成功

application/json

Body

success

boolean

required

code

integer

required

msg

string

required

data

object

required

projectId

string

required

Organization ID

appid

string

required

Application ID

worksheetId

string

required

Worksheet ID

name

string

required

Worksheet name

alias

string

required

Worksheet alias

createTime

string

required

Creation time

caid

string

required

Creator account Id

desc

string

required

Description

entityName

string

required

Record entity name

groupId

string

required

Group ID

shareRange

string

required

Sharing scope 1 : Close sharing 2 : Fully public 3 : Visible to members

controls

array [object {5}]

required

Control list

Examples

Successful Example Exception example

{
    "success": true,
    "code": 1,
    "msg": "ok",
    "data": {
        "projectId": "faa2f6b1-f706-4084-9a8d-XXXXXXXXX",
        "appId": "f553c2a3-aa0b-47a3-94d2-XXXXXXXXX",
        "worksheetId": "62a7058cfe536211a3aac4fb",
        "name": " Worksheet demo",
        "alias": "gzbdemo",
        "createTime": "2014-07-19 18:18:06",
        "caid": "e2453de8-1a6a-4d4f-ba36-87fdff880a20",
        "desc": " Worksheet description ",
        "entityName": " Record ",
        "groupId": "62a70572030e06b46c007ca5",
        "shareRange": 2,
        "controls": [
            {
                "controlId": "262a7058cfe536211a3aac4fc",
                "controlName": " Name ",
                "type": "2",
                "value": " Default value ",
                "alias": " Alias "
            },
            {
                "controlId": "21222344fe536211a3abc4fb",
                "controlName": " Name ",
                "type": "3",
                "value": " Default value ",
                "alias": " Alias "
            }
        ]
    }
}

🟠401没有权限

🟠404记录不存在