Skip to content

Upload Success API

API Information

  • Request Path: /datafile/file/upload-success/:type
  • Request Method: POST
  • Content-Type: application/json

Path Parameters

ParameterTypeRequiredDescription
typeStringYesraster/vector/model/other/bim/pointcloud/document

Request Headers

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

Request Body Structure

UploadDataFileResp Object

FieldTypeRequiredDescriptionConstraints
dataTypeIntegerYesData TypeMust not be blank
fileIdStringYesFile unique IDMust not be blank
fileSizeDoubleYesFile sizeMust be positive
fileNameStringYesFile nameMust not be blank
extensionStringYesFile extensionMust not be blank
parentIdLongNoParent directory IDOptional parent directory
categoryIntegerNoFile categoryOptional category
uploadMethodIntegerYesUpload methodMust 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

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataDataFileCreateRespData File create information

DataFileCreateResp Object

FieldTypeDescription
dateFileIdLongData 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 CodeDescription
200Success
400Request parameter error
401Unauthorized
500Server internal error

Usage Instructions

  1. This API is used to notify the server about successful file upload
  2. User authentication is required
  3. Upload result information must be provided
  4. 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