Skip to content

Query Dataset Page API ​

API Information ​

  • Request Path: /dataset/query/page
  • Request Method: POST
  • Content-Type: application/json

Request Headers ​

ParameterTypeRequiredDescription
AuthorizationStringYesUser authentication token
Content-TypeStringYesMust be set to application/json

Request Body Structure ​

DataSetReq Object ​

FieldTypeRequiredDescriptionConstraints
pageIntegerYesPage numberMust be positive integer
sizeIntegerYesPage sizeMust be positive integer
datasetNameStringNoDataset name filterOptional name filter
sortFieldStringNoSort fieldOptional sorting field
sortOrderStringNoSort orderasc or desc, default: desc

Request Body Example ​

json
{
  "page": 1,
  "size": 10,
  "datasetName": "Satellite",
  "sortField": "createTime",
  "sortOrder": "desc"
}

Response Body Structure ​

CommonResponse Object ​

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataDataSetRespDataset list response

DataSetResp Object ​

FieldTypeDescription
totalLongTotal number of records
pagesIntegerTotal number of pages
dataSetVoListList<DataSetVo>List of dataset records

DataSetVo Object (Nested in DataSetResp) ​

FieldTypeDescription
idLongDataset ID
codeStringDataset code
nameStringDataset name
descriptionStringDataset description
pictureurlStringDataset cover image URL
providerAppStringDataset provider
ctimeLongCreation timestamp
boundMetaDataListList<MetaData>List of bound metadata
tagListList<DatasetTagVo>List of dataset tags
userNameStringUser name
avatarStringUser avatar URL
creatorStringCreator 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 CodeDescription
200Success
400Request parameter error
401Unauthorized
500Server internal error

Usage Instructions ​

  1. This API is used to query dataset list with pagination
  2. User authentication is required
  3. Supports filtering by dataset name and sorting
  4. 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