Get File from Local File Storage

GET 
/api/assets/**

Retrieve a file from the local file storage.

This endpoint will be provided if Singularity is configured to use the local file storage implementation of file storage. You can learn more here.

Responses

200

OK

400

The following error codes correspond to this status:

• BAD_FILE_REQUEST: Thrown when the file request is malformed or invalid.

401

The following error codes correspond to this status:

• ACCESS_TOKEN_EXPIRED: Indicates that the access token is expired.
• ACCESS_TOKEN_INVALID: Indicates that the access token cannot be decoded.
• AUTHENTICATION_REQUIRED: User is not authenticated.

403

The following error codes correspond to this status:

• FILE_ACCESS_NOT_AUTHORIZED: Thrown when access to the requested file is not permitted.

404

The following error codes correspond to this status:

• FILE_NOT_FOUND: Thrown when the requested file is not found.

409

The following error codes correspond to this status:

• FILE_KEY_TAKEN: This exception is thrown when attempting to store a file with a file key that is already taken or in use.

415

The following error codes correspond to this status:

• UNSUPPORTED_MEDIA_TYPE: Thrown when a request is made with an unsupported media type.

500

The following error codes correspond to this status:

• ACCESS_TOKEN_ALLOWLIST_READING_FAILURE: Represents an exception indicating a failure when reading the allowlist for an access token cache.
• FILE_METADATA_FAILURE: Thrown to indicate that a failure occurred during the handling of file metadata which is stored in the database.
• FILE_METADATA_OUT_OF_SYNC: Represents an exception thrown when file metadata saved in the database is out of sync with the expected state of the actual file.
• FILE_OPERATION_FAILURE: Represents an error that occurred during a file operation, such as saving or updating a file.
• FILE_STREAM_FAILURE: Thrown when an error occurred during a file stream.