Appearance
Query Dataset Page API
API Information
- Request Path:
/dataset/query/page - Request Method:
POST - Content-Type:
application/json
Request Headers
| Parameter | Type | Required | Description |
|---|---|---|---|
| Authorization | String | Yes | User authentication token |
| Content-Type | String | Yes | Must be set to application/json |
Request Body Structure
DataSetReq Object
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
| page | Integer | Yes | Page number | Must be positive integer |
| size | Integer | Yes | Page size | Must be positive integer |
| datasetName | String | No | Dataset name filter | Optional name filter |
| sortField | String | No | Sort field | Optional sorting field |
| sortOrder | String | No | Sort order | asc or desc, default: desc |
Request Body Example
json
{
"page": 1,
"size": 10,
"datasetName": "Satellite",
"sortField": "createTime",
"sortOrder": "desc"
}Response Body Structure
CommonResponse Object
| Field | Type | Description |
|---|---|---|
| code | Integer | Response status code |
| message | String | Response message |
| data | DataSetResp | Dataset list response |
DataSetResp Object
| Field | Type | Description |
|---|---|---|
| total | Long | Total number of records |
| pages | Integer | Total number of pages |
| dataSetVoList | List<DataSetVo> | List of dataset records |
DataSetVo Object (Nested in DataSetResp)
| Field | Type | Description |
|---|---|---|
| id | Long | Dataset ID |
| code | String | Dataset code |
| name | String | Dataset name |
| description | String | Dataset description |
| pictureurl | String | Dataset cover image URL |
| providerApp | String | Dataset provider |
| ctime | Long | Creation timestamp |
| boundMetaDataList | List<MetaData> | List of bound metadata |
| tagList | List<DatasetTagVo> | List of dataset tags |
| userName | String | User name |
| avatar | String | User avatar URL |
| creator | String | Creator name |
Response Examples
Success Response
json
{
"code": 200,
"message": "success",
"data": {
"total": 25,
"pages": 3,
"dataSetVoList": [
{
"id": 1,
"code": "DS_001",
"name": "Satellite Imagery 2024",
"description": "High resolution satellite images",
"pictureurl": "https://example.com/covers/dataset1.jpg",
"providerApp": "User Upload",
"ctime": 1704105600000,
"boundMetaDataList": [],
"tagList": [
{
"id": 1,
"name": "Satellite"
},
{
"id": 2,
"name": "Imagery"
}
],
"userName": "john_doe",
"avatar": "https://example.com/avatars/john.jpg",
"creator": "John Doe"
}
]
}
}Failure Response
json
{
"code": 400,
"message": "Invalid request parameters",
"data": null
}Error Code Description
| Error Code | Description |
|---|---|
| 200 | Success |
| 400 | Request parameter error |
| 401 | Unauthorized |
| 500 | Server internal error |
Usage Instructions
- This API is used to query dataset list with pagination
- User authentication is required
- Supports filtering by dataset name and sorting
- Returns paginated results with total count and detailed dataset information
Notes
- User authentication token must be included in request headers
- Request body must be valid JSON format
- Pagination parameters are required
- Demo users can only see their own datasets
- Response includes comprehensive dataset information including tags and metadata