ContextQMD
Back to Nocobase

nb api resource get

docs/docs/cn/api/cli/api/resource/get.md

2.1.301.0 KB
Original Source

nb api resource get

获取指定资源的一条记录。通常使用 --filter-by-tk 指定主键。

用法

bash
nb api resource get --resource <resource> [flags]

参数

参数类型说明
--resourcestring资源名称，必填
--data-sourcestring数据源 key，默认 main
--source-idstring关联资源的源记录 ID
--filter-by-tkstring主键值，复合或多个 key 可以传 JSON 数组
--fieldsstring[]查询字段，可重复传入或传 JSON 数组
--appendsstring[]要追加的关联字段，可重复传入或传 JSON 数组
--exceptstring[]要排除的字段，可重复传入或传 JSON 数组

同时支持 nb api resource 的通用连接参数。

示例

bash
nb api resource get --resource users --filter-by-tk 1
nb api resource get --resource posts.comments --source-id 1 --filter-by-tk 2

相关命令