Appearance
Get Dataset Detail API
API Information
- Request Path:
/dataset/detail - 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
MetaDataReq Object
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
| datasetId | Long | Yes | Dataset ID | Must be valid dataset ID |
Request Body Example
json
{
"datasetId": 12345
}Response Body Structure
CommonResponse Object
| Field | Type | Description |
|---|---|---|
| code | Integer | Response status code |
| message | String | Response message |
| data | DataSetDetailResp | Dataset detail information |
DataSetDetailResp Object
| Field | Type | Description |
|---|---|---|
| id | Long | Dataset ID |
| datasetName | String | Dataset name |
| clientId | String | Client ID |
| secretKey | String | Secret key |
| description | String | Dataset description |
| captureTime | Long | Capture timestamp |
| metadataList | List<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 Code | Description |
|---|---|
| 200 | Success |
| 400 | Request parameter error |
| 401 | Unauthorized |
| 404 | Dataset not found |
| 500 | Server internal error |
Usage Instructions
- This API is used to get detailed information about a specific dataset
- Dataset ID must be provided
- User authentication is required
- 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