Object Store Management

Get Object Store File

Introduction

Get Object Store file of a specific organization and key.

Request

Get Object Store files of a specific organization and key. The /object/get API accepts requests in the following format:

GetObjectStoreJobIdRequest Model - Request to get JobId for the requested Object Store files.
organizationId string
Organization ID we would like to get the Object Store files from.
keys string Array
Keys to the Object Store files.
Example 
{
  "organizationId": "string",
  "keys": [
    "string"
  ]
}
GetObjectStoreURLRequest Model - Request to get a download URL for certain Object Store files.
organizationId string
Organization ID we would like to get the Object Store files from.
jobId string
Job ID for getting a download URL for.
Example 
{
  "organizationId": "string",
  "jobId": "string"
}

Responses

The /object/get API provides a response in the following format:

200 Success

GetObjectStoreResponse Model - Response received when fetching Object Store file.
jobId string
Job ID which can be used for querying state or packaging.
url string
The URL to download the object. This can also be null.
success boolean
Indicate if the API request was successful.
errors string Array
List of errors with the API call.
Example 
{
  "jobId": "string",
  "url": "string",
  "success": true,
  "errors": [
    "string"
  ]
}

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: