Appearance
Upload Success API
API Information
- Request Path:
/datafile/file/upload-success/:type - Request Method:
POST - Content-Type:
application/json
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| type | String | Yes | raster/vector/model/other/bim/pointcloud/document |
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
UploadDataFileResp Object
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
| dataType | Integer | Yes | Data Type | Must not be blank |
| fileId | String | Yes | File unique ID | Must not be blank |
| fileSize | Double | Yes | File size | Must be positive |
| fileName | String | Yes | File name | Must not be blank |
| extension | String | Yes | File extension | Must not be blank |
| parentId | Long | No | Parent directory ID | Optional parent directory |
| category | Integer | No | File category | Optional category |
| uploadMethod | Integer | Yes | Upload method | Must be 0 or 1 |
Request Body Example
json
{
"dataType": 0,
"fileId": "2JX0JS0JI",
"fileName": "test001",
"extension": "tif",
"parentId": 706,
"fileSize": 0.0006453590467572212,
"category": 1,
"uploadMethod": 0
}Response Body Structure
CommonResponse Object
| Field | Type | Description |
|---|---|---|
| code | Integer | Response status code |
| message | String | Response message |
| data | DataFileCreateResp | Data File create information |
DataFileCreateResp Object
| Field | Type | Description |
|---|---|---|
| dateFileId | Long | Data File ID |
Response Examples
Success Response
json
{
"code": 200,
"message": "success",
"data": {
"dateFileId": 18
}
}Failure Response
json
{
"code": 400,
"message": "Invalid upload information",
"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 notify the server about successful file upload
- User authentication is required
- Upload result information must be provided
- Returns success message
Notes
- Upload ID and file information are required
- This API should be called after successful file upload to S3
- Triggers file processing and metadata extraction
- User authentication token must be included in request headers