Query Data

GET 
/v1/rdb/rest/:table

Query data in tables with support for complex queries, join queries, pagination, sorting, and more

Request

Path Parameters

table stringrequired

Table name

Query Parameters

select string

Specify fields to return, supporting * or a list of specific fields, and supporting join queries such as class_id(grade,class_number)

limit integer

Limit the number of rows returned

offset integer

Offset for pagination

order string

Sorting field in the format of field.asc or field.desc

Header Parameters

Prefer string

Preference settings, such as count=exact

Responses

200

The query is successful.

Response Headers

• Content-Range string

  Data Range

application/json

Schema

Schema

• Array [

object

• ]

Example (from schema)

[
  {}
]

400

Request error

application/json

Schema

Schema

code string

Error code

message string

Error message

requestId string

Unique request ID

Example (from schema)

{
  "code": "BadApiRequest",
  "message": "UPDATE requires a WHERE clause",
  "requestId": "req-123456"
}

401

Authentication Failure

application/json

Schema

Schema

code string

Error code

message string

Error message

requestId string

Unique request ID

Example (from schema)

{
  "code": "BadApiRequest",
  "message": "UPDATE requires a WHERE clause",
  "requestId": "req-123456"
}

404

Table does not exist

application/json

Schema

Schema

code string

Error code

message string

Error message

requestId string

Request unique ID

Example (from schema)

{
  "code": "BadApiRequest",
  "message": "UPDATE requires a WHERE clause",
  "requestId": "req-123456"
}

Loading...