# File

Files are associated with a [Submissions](https://docs.eclipse-pass.org/developer-documentation/pass-core/model/submission) to be used to form [Deposits](https://docs.eclipse-pass.org/developer-documentation/pass-core/model/deposit) into [Repositories](https://docs.eclipse-pass.org/developer-documentation/pass-core/model/repository)

| Attribute   | Type   | Description                                                                                                        |
| ----------- | ------ | ------------------------------------------------------------------------------------------------------------------ |
| id\*        | String | Autogenerated identifier of object                                                                                 |
| name\*      | String | File name, defaults to filesystem name                                                                             |
| uri\*       | String | Relative URI to the file servive which will return the bytestream                                                  |
| description | String | Description of file provided by [User](https://docs.eclipse-pass.org/developer-documentation/pass-core/model/user) |
| fileRole    | String | Role of the file ([*see list below*](#file-role-options))                                                          |
| mimeType    | String | Mime-type of file                                                                                                  |

| Relationship | Type   | Target                                                                                         | Description                      |
| ------------ | ------ | ---------------------------------------------------------------------------------------------- | -------------------------------- |
| submission\* | To One | [Submission](https://docs.eclipse-pass.org/developer-documentation/pass-core/model/submission) | Submission the File is a part of |

\*required

## File role options

Status options for grant

| Value        | Description                                                                                                                    |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| manuscript   | Author accepted manuscript                                                                                                     |
| supplemental | Supplemental material for the [Publication](https://docs.eclipse-pass.org/developer-documentation/pass-core/model/publication) |
| figure       | An image, data plot, map, or schematic                                                                                         |
| table        | Tabular data                                                                                                                   |