Upload Documents Complete
This endpoint is used to finalize the upload process.
Definitions
Route: /documents/upload/{upload_id} from upload resigned process
Method: POST
OperationId: {upload_id} from upload resigned process
Permissions
The user must be a member of one of the following roles:
- documents:manager
- documents:uploader
Request
Headers
| Name | Description | Notes | |
|---|---|---|---|
| accept | The expected format of the response | application/json |
|
| osg-client-id | The unique identifier assigned to your organization | ||
| client_customer_id | The unique identifier assigned to your client | ||
| correlation_id | The unique identifier for correlation |
Parameters
- upload id from the presigned step
Responses
| Status | Description | Body |
|---|---|---|
| 200 | The request was successful and is being processed. | UploadCompleteResult |
Failures
| Status | Description | Body |
|---|---|---|
| 400 | The request was invalid. | UploadCompleteResult |
| 401 | The request was not authorized. | None |
| 403 | The request was not allowed. | None |
| Default | An unexpected error occurred. | None |
Schemas
UploadResult
{
"upload_id": "string",
"upload_url": "string",
"result": {
"is_success": "boolean",
"errors": [
"string"
],
"message": "string",
"sent_on_utc": "string",
"trace_id": "string",
"correlation_id": "string"
}
}
Upload Id
The upload Id used to close out the upload process.
Upload Url
The url to use to upload a file.