Objects
GET All Objects#
Get all bucket objects or specific folder objects.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/objects/get |
| Headers | Authorization |
| Parameters | projectId,name, version |
| Body | {key,maxKeys,continuationToken} |
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 | randombucket | 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 |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| Name | Yes | string | randombucket | Shows the bucket name |
Request body#
{ "key": "string", "maxKeys": 0, "continuationToken": "string"}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| key | Yes | string | "string" | Send the key of Folder to get all objects |
| maxKeys | Yes | integer($int32) | 0 | Send the number of objects to be listed. |
| continuationToken | Yes | string | "string" | Send the key of an object to start listing other objects |
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": { "objectListModel": [ { "key": "object", "bucket": "bucketname", "size": 0, "isFolder": true, "lastModified": "2021-06-30T12:01:51.225Z", "status": 0, "eventType": 0, "url": "string" } ], "storageEventTypeOptions": { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 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] | ||
| key | string | "string" | Returns the key of an object. |
| bucket | string | "string" | Returns bucket name. |
| size | string | "string" | Returns the size of an object. |
| isFolder | bool | true | Returns if object is a folder. |
| lastModified | DateTime | "2021-06-30T12:01:51.225Z" | Returns the last modified date |
| status | integer($int32) | 0 | Returns status of an object. |
| eventType | integer($int32) | 0 | Returns the event type of an object. |
| url | string | "string" | Return the url of an object. |
| 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
POST Object#
Add new object to a bucket.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/objects |
| Headers | Authorization |
| Parameters | projectId, name, version |
| Body | { key, isFolder, duration, contentType, isPublic } |
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 | randombucket | 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 |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| Name | Yes | string | randombucket | Shows the bucket name |
Request body#
{ "key": "string", "isFolder": true, "duration": 0, "contentType": "string", "isPublic": true}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| key | Yes | string | "string" | Send the key to create new object. |
| isFolder | Yes | string | "string" | Send true if object is a folder |
| duration | No | int | 0 | Send the duration if for the presigned Url for upload an object. |
| contentType | Yes | string | "string" | Send the content type of an object. |
| isPublic | Yes | string | "string" | Sent true if you want to upload a public object. |
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": "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 ETag if folder is created or presigned URL for uploading an object |
| 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
POST Quick Share Link#
Gets a presigned URL for sharing an object.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/objects/url |
| Headers | Authorization |
| Parameters | projectId, name, version |
| Body | { key, isFolder, duration, contentType, isPublic, versionId } |
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 | randombucket | 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 |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| Name | Yes | string | randombucket | Shows the bucket name |
Request body#
{ "key": "string", "duration": 0, "contentType": "string", "isPublic": true, "versionId": "string"}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| key | Yes | string | "string" | Send the key to create a presigned url for that object. |
| duration | No | int($int32) | 0 | Send the duration for link to expire. |
| contentType | No | string | "string" | Send the content type of an object. |
| isPublic | No | bool | true | No needded. |
| isPublic | No | string | "string" | Send the version id to get a specific version of an object. |
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": "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 presigned URL for sharing an object |
| 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
DELETE Object#
Deletes a object associated with this key.
| DELETE | |
|---|---|
| Method | DELETE |
| URL or EndPoint | /api/v{version:apiVersion}/projects/{projectId}/buckets/{name}/objects |
| Headers | Authorization |
| Parameters | projectId, name, version |
| Body | keys[], prefixes[] |
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 | randombucket | 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 |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| Name | Yes | string | randombucket | Displays the bucket name |
Request body#
{ "keys": [ "string" ], "prefixes": [ "string" ]}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| keys | No | List < string > | "string" | Send the keys of Objects to be deleted |
| prefixes | No | List < string > | "string" | Send the prefixes to be deleted |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned 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 | array [object] | ||
| keys | List < string > | "string" | Returns the keys of the objects. |
| 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 Object#
Move or rename objects.
| PUT | |
|---|---|
| Method | PUT |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/objects/move |
| Headers | Authorization |
| Parameters | projectId, name, version |
| Body | { key[], prefixes[] } |
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 | randombucket | 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 |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| Name | Yes | string | randombucket | Shows the bucket name |
Request body#
{ "keys": { "key1": "newkey1", "key2": "newkey2", "key3": "newkey3" }, "prefixes": { "folder1/": "newFolder1/", "folder2/": "newFolder2/", "folder3/": "newFolder3/" }}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| keys | No | Dictionary < string,string > | Dictionary < string,string > | Send the key as old key and value as new key |
| prefixes | No | Dictionary < string,string > | Dictionary < string,string > | Send the key as old key and value as new key |
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 True if folder is deleted or moved |
| 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