File Registry

Handles files and attachments.

We will never create multiple file registries, unlike the other types of registries.

Files can be stored with information about year, financial statement, and purposes.

Files

Files can be stored and used across all years and different financial statements

Endpoints located at /files return information about the files, not the actual content.

Endpoints located at /storage/files return the actual files with content.

Attachments

Attachments are links between a file and a financial statement.

Endpoints located at /attachments expose information about the attachments and the files.

REST Api

Files

Method

Uri

Description

POST

file-registry/files/:add

GET

file-registry/files?purpose={purpose}

DELETE

file-registry/files/{fileUuid}

Attachments

POST

file-registry/attachments/:add

GET

file-registry/attachments?fsUuid={fsUuid}

GET

file-registry/attachments/-/files?fileIdentifier={fileIdentifier}&purpose={purpose}&fsUuid={fsUuid}

PUT

file-registry/attachments/:update

DELETE

file-registry/attachments/:delete

Storage

GET

file-registry/storage/files/{fileUuid}