Multipart Upload
GET Multiparts uploads#
Get all multipart uploads.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/uploads |
| Headers | Authorization |
| Parameters | version, projectId, name |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | Guid | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of project |
| {name} | Yes | string | string | Shows the name of bucket |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| Name | Yes | string | randomstring | Shows the bucket name |
| Delimiter | No | string | randomstring | Character you use to group keys. |
| Encoding.Value | No | string | randomstring | Encode the object keys in the response |
| Prefix | No | string | randomstring | Lists in-progress uploads only for those keys that begin with the specified prefix |
| KeyMarker | No | string | randomstring | Specifies the multipart upload after which listing should begin |
| MaxUploads | No | string | randomstring | Sets the maximum number of multipart uploads, from 1 to 1,000 |
| UploadIdMarker | No | string | randomstring | Together with key-marker, specifies the multipart upload after which listing should begin |
Request body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "responseMetadata": { "requestId": "string", "metadata": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "checksumAlgorithm": 0, "checksumValidationStatus": 0 }, "contentLength": 0, "httpStatusCode": 100, "bucketName": "string", "keyMarker": "string", "uploadIdMarker": "string", "nextKeyMarker": "string", "nextUploadIdMarker": "string", "maxUploads": 0, "isTruncated": true, "multipartUploads": [ { "checksumAlgorithm": { "value": "string" }, "initiated": "2022-04-01T07:23:15.203Z", "initiator": { "displayName": "string", "id": "string" }, "key": "string", "owner": { "displayName": "string", "id": "string" }, "storageClass": { "value": "string" }, "uploadId": "string" } ], "prefix": "string", "delimiter": "string", "commonPrefixes": [ "string" ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Return a list of created buckets | |
| responseMetadata | array [object] | Returns the object of response metadata | |
| requestId | long | 1234 | Returns the request Id |
| metadata | array [object] | Returns an object of metadata | |
| additionalProp1 | string | "string" | Returns the additional property of metadata |
| additionalProp2 | string | "string" | Returns the additional property of metadata |
| additionalProp3 | string | "string" | Returns the additional property of metadata |
| checksumAlgorithm | int | 0 | Returns the check sum algorithm |
| checksumValidationStatus | int | 0 | Returns the status of check sum validation |
| contentLength | int | 0 | Returns the content length |
| httpStatusCode | int | 200 | Returns the http status code |
| bucketName | string | "string" | Returns the bucket name |
| keyMarker | string | "string | Returns the key marker of an object |
| uploadIdMarker | string | "string" | Returns the upload id marker |
| nextKeyMarker | string | "string" | Returns the next key marker |
| nextUploadIdMarker | string | "string" | Returns the next upload id marker |
| maxUploads | int | 0 | Returns the maximum uploads |
| isTruncated | bool | true | Returns the result if object is truncated |
| multipartUploads | array[object] | Returns the object of multipart uploads | |
| checksumAlgorithm | array[object] | Returns the object of check sum algorithm | |
| value | string | "string" | Returns the value of check sum algorithm |
| initiated | DateTime | "2022-03-31T14:27:14.768Z" | Returns the initiation date time |
| initiator | array[object] | Returns the object of initiatior | |
| displayName | string | "string" | Returns the display name of initiator |
| id | string | "string" | Returns the id of initiator |
| key | string | "string" | Returns the key |
| owner | array[object] | Returns the object of the owner | |
| displayName | string | "string" | Returns the display name of owner |
| id | string | "string" | Returns the id of owner |
| storageClass | array[object] | Returns the object of storage classes | |
| value | string | "string" | Returns the value of the storage class |
| uploadId | string | "string" | Returns the upload id |
| prefix | string | "string" | Returns the prefix of which key should be listed |
| delimiter | bool | true | Returns the delimiter you specified in the request |
| commonPrefixes | array[string] | Returns the common prefixes | |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors#
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code: 401 Unauthorized
HTTP Status Code: 403 Forbidden
HTTP Status Code: 404 If the service is down
POST MultipartUpload#
Initiate a new multipart upload.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/uploads |
| Headers | Authorization |
| Parameters | projectId, version, name |
| Body |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Shows the project Id |
| {name} | Yes | string | string | Shows the bucket name |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| version | Yes | string($uuid) | v1 | Shows the version of API |
| projectId | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Id of the project |
| name | Yes | string | string | Shows the bucket name |
| key | No | string | string | Shows the key of an object you want to upload |
Request body#
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": "string", "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | string | "string" | Returns the result if its completed successfully |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Responses#
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in json format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 400 Bad Request
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
GET Multipart parts#
Gets all multipart parts.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/uploads/{uploadId} |
| Headers | Authorization |
| Parameters | version, projectId, name, uploadId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | Guid | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of project |
| {name} | Yes | string | "string" | Shows the name of the bucket |
| {uploadId} | Yes | string | "string" | Shows the upload id |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| Name | Yes | string | "string" | Shows the name of the bucket |
| UploadId | Yes | string | "string" | Shows the upload id |
| Key | No | string | "string" | Shows the key of the object |
Request body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "partNumber": 0, "eTag": "string", "checksumCRC32": "string", "checksumCRC32C": "string", "checksumSHA1": "string", "checksumSHA256": "string", "lastModified": "2022-04-01T08:20:02.302Z", "size": 0 } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns the result of created bucket | |
| partNumber | string | "string" | Returns the specified part after which listing begun. |
| eTag | array[object] | Returns the e-tag of the multipart | |
| checksumCRC32 | string | "string" | Returns checksum algorithm used to detect data corruption. |
| checksumCRC32C | string | "string" | Returns the cyclic redundancy rheck checksum |
| checksumSHA1 | string | "string" | Returns the verified file that has been unaltered |
| checksumSHA256 | string | "string" | Returns the secure password hashing. |
| lastModified | DateTime | "2022-03-31T14:36:48.792Z" | Returns the date time of where multipart was last modified |
| size | int | 0 | Returns the size of the multipart |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
PUT Multipart upload#
Complete or abort a multipart upload
| PUT | |
|---|---|
| Method | PUT |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/lifecycle/{id} |
| Headers | Authorization |
| Parameters | projectId, version, name, id |
| Body | {key, abort} |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Shows the project Id |
| name | Yes | string | "string" | Shows the bucket name |
| id | Yes | string | "string" | Shows the id of lifecycle |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| version | Yes | string($uuid) | v1 | Shows the version of API |
| projectId | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Put the id of project |
| name | Yes | string | "string" | Put the bucket name |
| id | Yes | string | "string" | Shows the id of lifecycle |
Request body#
{ "key": "string", "abort": true}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| key | Yes | string | "string" | Sends key of an object to complete or abort a multipart upload |
| abort | Yes | bool | true | Sends the true/false value if you want to abort multipart upload |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": true, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | bool | true | Returns the result if its completed successfully |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 400 Bad Request
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found