Skip to content

获取记录详情

获取对象中指定的记录详情

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/apaas/v1/applications/:namespace/objects/:object_api_name/records/:id/query
HTTP MethodPOST
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用app_engine:object.record:read 查看对象记录数据

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

路径参数

名称类型描述
namespacestring应用命名空间
示例值:"package_test__c"
数据校验规则
- 长度范围:0255 字符
object_api_namestring对象唯一标识
示例值:"user"
数据校验规则
- 长度范围:0256 字符
idstring记录ID
示例值:"1764024447556775"

请求体

名称类型必填描述
selectstring\[\]需要获取的字段,使用字段唯一标识符进行查询,关联字段可使用 . 进行下钻
示例值:["_id"]
数据校验规则
- 长度范围:0256

请求体示例

json
{
    "select": [
        "_id"
    ]
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemstring记录详情,格式为 Map

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "item": "{}"
    }
}

错误码

HTTP状态码错误码描述排查建议
4002320001param is invalid请检查输入参数

内容来源:飞书开放平台 · 自动爬取整理