Object Store Management

List Object Store Files

Introduction

List the Object Store files of a specific organization and path.

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 path.
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 containing a list of stored objects metadata, as well as the total size of all of them.
path string
example: Mia
Path to the files in the Object Store.
objects ObjectStoreSummary Array
List of objects stored.
objectStorageUsed int
Size of all objects stored in bytes.
objectStorageUsedHuman string
Size of all the objects stored in human-readable format.
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",
      "modified": "2021-11-26T15:18:27.693Z",
      "mime": "application/json",
      "folder": true,
      "size": 13
    }
  ],
  "objectStorageUsed": ,
  "objectStorageUsedHuman": "string",
  "success": true,
  "errors": [
    "string"
  ]
}
ObjectStoreSummary Model - Summary information of the Object Store.
key string
example: Mia/Test
Object Store key.
name string
File or folder name.
modified string($date-time)
Last time it was modified.
mime string
example: application/json
MIME type.
folder boolean
True if it is a folder, false otherwise.
size float
example: 13
Object Store file size.
Example 
{
  "key": "Mia/Test",
  "name": "string",
  "modified": "2021-11-26T15:18:27.693Z",
  "mime": "application/json",
  "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

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: