You need to enable JavaScript to run this app.
导航
ListDataModelRows - 查询数据模型行
最近更新时间:2024.04.23 14:21:05首次发布时间:2023.02.10 20:00:03

查询数据模型行

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

ListDataModelRows

要执行的操作,取值:ListDataModelRows。

Version
String

2021-03-04

API的版本,取值:2021-03-04。

ID
String

dcxxxxxxxxxxxxxxxxxxx

数据模型ID

PageNumber
Integer

1

分页页码

PageSize
Integer

10

分页页长

Filter
ListDataModelRowsFilter

null

过滤条件

SortBy
String

id

数据模型排序关键字

SortOrder
String

Desc

指定排序顺序

WorkspaceID
String

wcxxxxxxxxxxxxxxxxxxx

工作空间ID

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
TotalCount
Integer

100

总条数

PageSize
Integer

10

分页页长

PageNumber
Integer

1

分页页码

Rows
Array of ListString

[["your-sample-3-id","AAA","BBB"]]

对象列表,字符串数组的数组

Headers
Array of String

["my_entity_id","aaa","bbb"]

表头列表

请求示例

POST /?Action=ListDataModelRows&Version=2021-03-04
Content-Type:application/json
{
    "WorkspaceID": "wcxxxxxxxxxxxxxxxxxxx",
    "ID": "dcxxxxxxxxxxxxxxxxxxx",
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "Keyword": "key",
        "InSetIDs": ["xxxx"],
        "RowIDs": ["xxxx"]
    },
    "SortBy": "id",
    "SortOrder": "Desc"
}

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "ListDataModelRows",
        "Version": "2021-03-04",
        "Service": "bio",
        "Region": "cn-beijing"
    },
    "Result": {
        "Headers": ["my_entity_id","aaa","bbb"],
        "Rows": [
            ["your-sample-1-id","AAA","BBB"]
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 100
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
ParamErr
<透传错误内容>

参数错误

403
ForbiddenErr
<透传错误内容>

无权限

404
NotFoundErr
<资源类型>[<具体资源id>] not found

资源不存在

500
InternalErr
<透传错误内容>

内部错误