Skip to main content

Confirm Upload

Brief Description

  • Notify the server to complete the upload after successful direct file upload, and generate an accessible object address.

Request Method

  • post

Request URL

  • {API_ADDRESS}/object/complete_form_data
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringUsed for global link tracking, timestamp is recommended, independent in each request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameter Example

{
"id": "upload-task-id"
}
Field NameOptionalTypeDescription
idRequiredstringID returned in the initialization phase

Success Return Example

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"url": "https://cdn.example.com/avatar.png"
}
}

Parameter Description for Success Return Example

Parameter NameTypeDescription
errCodeintError code, 0 means success
errMsgstringBrief error message, empty
errDlterrDltDetailed error message, empty
dataobjectGeneric data object, specific structure is below
urlstringThe final address where the file can be accessed on the business side

Only after finishing direct upload using the certificate returned by initiate_form_data and confirming success, the server will return url. It can be written into business data or delivered to the client.

Failure Return Example

{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}

Parameter Description for Failure Return Example

Parameter NameTypeDescription
errCodeintError code, specifically check the global error code document
errMsgstringBrief error message
errDlterrDltDetailed error message