Object Store Management
List Object Store Files
Request
List the Object Store files of a specific organization and path. The /object/list
API accepts requests in the following format:
ListObjectStoreRequest Model - Request to list Object Store files of a specific organization and key. | |
---|---|
organizationId | string Organization id we'd like to list the Object Store files from. |
path | string Path to the Object Store files. |
Example |
{ "organizationId": "string", "path": "string" } |
Responses
The /object/list
API provides a response in the following format:
200 Success
ListObjectStoreResponse Model - Response received when listing Object of a project. | |
---|---|
path | string Path to the files in the Object Store. |
objects | ObjectStoreSummary Array Indicate if the API request was successful. |
success | boolean Indicate if the API request was successful. |
errors | string Array List of errors with the API call. |
Example |
{ "path": "Mia", "objects": [ { "key": "Mia/Test", "name": "string", "folder": true, "size": 13 } ], "success": true, "errors": [ "string" ] } |
ObjectStoreSummary Model - Summary information of the Object Store. | |
---|---|
key | string Object Store key. |
name | string File or folder name. |
folder | boolean True if it is a folder. |
size | float File size. |
Example |
{ "key": "Mia/Test", "name": "string", "folder": true, "size": 13 } |
401 Authentication Error
UnauthorizedError Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash. | |
---|---|
www_authenticate | string Header |