Get row record list - Application API

获取工作表记录列表，包含记录创建者、拥有者信息，各字段对应的值

Request

Path Params

Header Params

Body Params application/json

Example

{
    "pageSize": 20,
    "pageIndex": 1,
    "viewId": "view_123",
    "fields": [
        "field1",
        "field2"
    ],
    "filter": {
        "type": "group",
        "logic": "OR",
        "children": [
            {
                "type": "group",
                "logic": "AND",
                "children": [
                    {
                        "type": "condition",
                        "field": "677b4a73d14fcf3edf4e7f15",
                        "operator": "eq",
                        "value": [
                            "1"
                        ]
                    },
                    {
                        "type": "condition",
                        "field": "677b4a73d14fcf3edf4e7f15",
                        "operator": "eq",
                        "value": "test"
                    }
                ]
            }
        ]
    },
    "sorts": {
        "type": "array",
        "description": "Sort field",
        "items": {
            "type": "object",
            "properties": {
                "field": {
                    "type": "string",
                    "description": "Field ID or alias"
                },
                "isAsc": {
                    "type": "boolean",
                    "description": "Whether ascending; default is descending"
                }
            },
            "required": [
                "field"
            ]
        }
    },
    "example": {
        "pageSize": 20,
        "pageIndex": 1,
        "viewId": "view_123",
        "fields": [
            "field1",
            "field2"
        ],
        "filter": {
            "type": "group",
            "logic": "OR",
            "children": [
                {
                    "type": "group",
                    "logic": "AND",
                    "children": [
                        {
                            "type": "condition",
                            "field": "677b4a73d14fcf3edf4e7f15",
                            "operator": "eq",
                            "value": [
                                "1"
                            ]
                        },
                        {
                            "type": "condition",
                            "field": "677b4a73d14fcf3edf4e7f15",
                            "operator": "eq",
                            "value": "test"
                        }
                    ]
                }
            ]
        },
        "sorts": [
            {
                "field": "createdAt",
                "isAsc": true
            }
        ]
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://www.nocoly.com/v3/app/worksheets//rows/list' \
--header 'HAP-Appkey;' \
--header 'HAP-Sign;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pageSize": 20,
    "pageIndex": 1,
    "viewId": "view_123",
    "fields": [
        "field1",
        "field2"
    ],
    "filter": {
        "type": "group",
        "logic": "OR",
        "children": [
            {
                "type": "group",
                "logic": "AND",
                "children": [
                    {
                        "type": "condition",
                        "field": "677b4a73d14fcf3edf4e7f15",
                        "operator": "eq",
                        "value": [
                            "1"
                        ]
                    },
                    {
                        "type": "condition",
                        "field": "677b4a73d14fcf3edf4e7f15",
                        "operator": "eq",
                        "value": "test"
                    }
                ]
            }
        ]
    },
    "sorts": {
        "type": "array",
        "description": "Sort field",
        "items": {
            "type": "object",
            "properties": {
                "field": {
                    "type": "string",
                    "description": "Field ID or alias"
                },
                "isAsc": {
                    "type": "boolean",
                    "description": "Whether ascending; default is descending"
                }
            },
            "required": [
                "field"
            ]
        }
    },
    "example": {
        "pageSize": 20,
        "pageIndex": 1,
        "viewId": "view_123",
        "fields": [
            "field1",
            "field2"
        ],
        "filter": {
            "type": "group",
            "logic": "OR",
            "children": [
                {
                    "type": "group",
                    "logic": "AND",
                    "children": [
                        {
                            "type": "condition",
                            "field": "677b4a73d14fcf3edf4e7f15",
                            "operator": "eq",
                            "value": [
                                "1"
                            ]
                        },
                        {
                            "type": "condition",
                            "field": "677b4a73d14fcf3edf4e7f15",
                            "operator": "eq",
                            "value": "test"
                        }
                    ]
                }
            ]
        },
        "sorts": [
            {
                "field": "createdAt",
                "isAsc": true
            }
        ]
    }
}'

Responses

🟢200OK

application/json

Successfully retrieved record list

Body

Example

{
    "data": {
        "rows": [
            {
                "id": "row123",
                "fields": [
                    {
                        "id": "field1",
                        "value": "Sample value",
                        "type": "2",
                        "controlName": "Text field"
                    }
                ],
                "_createdBy": {
                    "accountId": "user123",
                    "fullname": "Zhang San"
                },
                "_owner": {
                    "accountId": "user123",
                    "fullname": "Zhang San"
                },
                "_createdAt": "2024-03-25T15:52:58.000Z",
                "_updatedAt": "2024-03-25T15:52:58.000Z",
                "_updatedBy": {
                    "accountId": "user123",
                    "fullname": "Zhang San"
                }
            }
        ],
        "total": 100,
        "pageIndex": 1,
        "pageSize": 20
    },
    "success": true
}