明道云开放平台

正在加载页面

鉴权方式

AppKey + Sign 是应用密钥鉴权，由管理员创建，用于以应用管理员身份访问应用数据。

版本

请求地址

GET

Path 参数

名称	类型	必填	描述
`worksheet_id`	`string`	是	工作表ID 示例值：`"worksheet_id"`
`row_id`	`string`	是	行记录ID 示例值：`"row_id"`
`field`	`string`	是	关联字段ID 示例值：`"field"`

Header 参数

名称	类型	必填	描述
`HAP-Appkey`	`string`	是	HAP应用密钥
`HAP-Sign`	`string`	是	HAP签名

Query 参数

名称	类型	必填	描述
`pageSize`	`integer`	否	每页数量示例值：`20`
`pageIndex`	`integer`	否	页码示例值：`1`
`isReturnSystemFields`	`boolean`	否	是否获取系统字段示例值：`false`

响应参数

200成功获取关联记录

名称	类型	描述
`success`	`boolean`	是否调用成功
`error_code`	`integer`	错误代码
`error_msg`	`string`	错误消息
`data`	`object`	—
`data.rows`	`object[]`	关联记录列表
`data.rows.id`	`string`	行记录ID
`data.rows._createAt`	`string<date-time>`	创建时间 (格式：yyyy-MM-dd HH:mm:ss)
`data.rows._updatedAt`	`string<date-time>`	更新时间 (格式：yyyy-MM-dd HH:mm:ss)
`data.rows._owner`	`object`	拥有者信息
`data.rows._owner.id`	`string`	人员 id
`data.rows._owner.name`	`string`	名称
`data.rows._owner.avatar`	`string`	头像地址
`data.rows._owner.isPortal`	`boolean`	是否为门户用户
`data.rows._owner.status`	`integer`	状态
`data.rows._owner.accountId`	`string`	人员 id (兼容字段)
`data.rows._owner.fullname`	`string`	名称 (兼容字段)
`data.total`	`integer`	总条数

curl -X GET "https://example.com/v3/app/worksheets/worksheet_id/rows/row_id/relations/field" \  -H "HAP-Appkey: {{HAP-Appkey}}" \  -H "HAP-Sign: {{HAP-Sign}}"

{  "success": true,  "error_code": 0,  "error_msg": "string",  "data": {    "rows": [      {        "id": "string",        "_createAt": "2019-08-24T14:15:22Z",        "_updatedAt": "2019-08-24T14:15:22Z",        "_owner": {          "id": "string",          "name": "string",          "avatar": "string",          "isPortal": true,          "status": 0,          "accountId": "string",          "fullname": "string"        },        "property1": null,        "property2": null      }    ],    "total": 0  }}

名称

类型

必填

描述

worksheet_id

string

是

工作表ID

示例值："worksheet_id"

row_id

string

是

行记录ID

示例值："row_id"

field

string

是

关联字段ID

示例值："field"

名称

类型

必填

描述

HAP-Appkey

string

是

HAP应用密钥

HAP-Sign

string

是

HAP签名

名称

类型

必填

描述

pageSize

integer

否

每页数量

示例值：20

pageIndex

integer

否

页码

示例值：1

isReturnSystemFields

boolean

否

是否获取系统字段

示例值：false

名称

类型

描述

success

boolean

是否调用成功

error_code

integer

错误代码

error_msg

string

错误消息

data

object

—

data.rows

object[]

关联记录列表

data.rows.id

string

行记录ID

data.rows._createAt

string<date-time>

创建时间 (格式：yyyy-MM-dd HH:mm:ss)

data.rows._updatedAt

string<date-time>

更新时间 (格式：yyyy-MM-dd HH:mm:ss)

data.rows._owner

object

拥有者信息

data.rows._owner.id

string

人员 id

data.rows._owner.name

string

名称

data.rows._owner.avatar

string

头像地址

data.rows._owner.isPortal

boolean

是否为门户用户

data.rows._owner.status

integer

状态

data.rows._owner.accountId

string

人员 id (兼容字段)

data.rows._owner.fullname

string

名称 (兼容字段)

data.total

integer

总条数

{ "success": true, "error_code": 0, "error_msg": "string", "data": { "rows": [ { "id": "string", "_createAt": "2019-08-24T14:15:22Z", "_updatedAt": "2019-08-24T14:15:22Z", "_owner": { "id": "string", "name": "string", "avatar": "string", "isPortal": true, "status": 0, "accountId": "string", "fullname": "string" }, "property1": null, "property2": null } ], "total": 0 }}