Appearance
Create Metadata API
API Information
- Request Path:
/metadata/create - 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
CreateMetaDataReq Object
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
| name | String | Yes | Metadata name | Cannot be empty, maximum 50 characters |
| dataFileId | Long | Yes | Data file ID | Must reference an existing data file |
| datasetIds | List<Long> | No | Dataset IDs to associate with metadata(At this time, transmission of more than one datasetId is not supported.) | Optional list of dataset IDs |
| tagIds | List<Long> | No | Tag IDs to associate with metadata | Optional list of tag IDs |
Request Body Example
json
{
"name": "Satellite Image Metadata",
"dataFileId": 12345,
"datasetIds": [1001],
"tagIds": [1, 2, 3]
}Response Body Structure
CommonResponse Object
| Field | Type | Description |
|---|---|---|
| code | Integer | Response status code |
| message | String | Response message |
| data | MetaDataCreateResp | MetaData create information |
MetaDataCreateResp Object
| Field | Type | Description |
|---|---|---|
| metaDataId | Long | MetaData ID |
Response Examples
Success Response
json
{
"code": 200,
"message": "success",
"data": {
"metaDataId": 13
}
}Failure Response
json
{
"code": 400,
"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 create new metadata entries
- User authentication is required
- Dataset ID must reference an existing dataset
- Returns boolean indicating creation success
Notes
- Metadata name is required
- Dataset ID must be valid and reference an existing dataset
- Data type must be one of the supported types (RASTER, VECTOR, etc.)
- User authentication token must be included in request headers