The Open API specification for Synapse is now available for download!

Download Open API Spec

FileHandleStatus

org.sagebionetworks.repo.model.file.FileHandleStatus

The status of the file handle as computed by the backend. This value cannot be changed, any file handle that is not AVAILABLE should not be used.

Enumeration
name description
AVAILABLE The default status of a file handle that is considered available and linked to at least on object (For the possible associations see FileHandleAssociateType).
UNLINKED The file handle has been detected as not linked to any object (For the possible associations see FileHandleAssociateType), this file will eventually be archived.
ARCHIVED The file handle has been archived after being UNLINKED for more than 30 days. The file handle can be restored by the creator using the dedicated API. When ARCHIVED the file might not be readily accessible and restoring might take a few hours.