> For the complete documentation index, see [llms.txt](https://docs.eclipse-pass.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.eclipse-pass.org/pass-documentation-dev/developer-documentation/pass-core/model/file.md).

# File

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

| 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](/pass-documentation-dev/developer-documentation/pass-core/model/user.md) |
| 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](/pass-documentation-dev/developer-documentation/pass-core/model/submission.md) | 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](/pass-documentation-dev/developer-documentation/pass-core/model/publication.md) |
| figure       | An image, data plot, map, or schematic                                                                                      |
| table        | Tabular data                                                                                                                |