The File Store API
API Messages and Records
Communication with the FileStore occurs via specific CRecord messages, which are divided into two main categories: Requests for performing an action and Data Records for describing file information.
1. Requests to the File Store
These records request an action from the microservice (e.g., registration or retrieval of information).
| Record | Description |
|---|---|
| CRecordFileStoreGetFileInfo | Get the metadata for a file from a network file store. |
| CRecordFileStoreAddLocalFile | Add a local file to the file store. |
| CRecordFileStoreRequestFile | Request a file from the local file store. |
2. Data Records of the File Store
| Record | Description |
|---|---|
| CRecordFileStoreFile | A file record. |
3. Messages for internal communication within or between FileStores
| Record | Description |
|---|---|
| CRecordFileStoreAddFileToList | It is used to add a local file (for example, one that has just been created) from the Filestore directory to the FileStore's internal list of all managed files. |
| CRecordFileStoreGetChunk | Get a file chunk from a network file store. |
| CRecordFileStoreNotifyFileDownloaded | Notification: A file has been downloaded and saved into the indexed directory. |
| CRecordFileStoreNotifyFileImported | Notification: A file has been imported into the indexed directory. |
| CRecordFileStoreStoreChunk | Store a file chunk into a network file store. |
| CRecordFileStoreStoreFile | Store a file into a network file store. |