Skip to content

Get Dataset Detail API

API Information

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

Request Headers

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

Request Body Structure

MetaDataReq Object

FieldTypeRequiredDescriptionConstraints
datasetIdLongYesDataset IDMust be valid dataset ID

Request Body Example

json
{
  "datasetId": 12345
}

Response Body Structure

CommonResponse Object

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataDataSetDetailRespDataset detail information

DataSetDetailResp Object

FieldTypeDescription
idLongDataset ID
datasetNameStringDataset name
clientIdStringClient ID
secretKeyStringSecret key
descriptionStringDataset description
captureTimeLongCapture timestamp
metadataListList<MetaDataVo>List of metadata associated with dataset

Response Examples

Success Response

json
{
  "code": 200,
  "message": "success",
  "data": {
    "id": 12345,
    "datasetName": "Satellite Imagery 2024",
    "clientId": "client_123",
    "secretKey": "secret_key_456",
    "description": "High resolution satellite images for analysis",
    "captureTime": 1704105600000,
    "metadataList": [
      {
        "id": 1,
        "name": "Satellite Metadata",
        "description": "Satellite image metadata",
        "type": 1
      }
    ]
  }
}

Failure Response

json
{
  "code": 404,
  "message": "Dataset not found",
  "data": null
}

Error Code Description

Error CodeDescription
200Success
400Request parameter error
401Unauthorized
404Dataset not found
500Server internal error

Usage Instructions

  1. This API is used to get detailed information about a specific dataset
  2. Dataset ID must be provided
  3. User authentication is required
  4. Returns comprehensive dataset information including metadata and client credentials

Notes

  • Dataset ID is required and cannot be null
  • User must have appropriate permissions to access the dataset
  • Returns detailed information including metadata list and client credentials
  • User authentication token must be included in request headers