Begin of the insertion# This specification is "Work in progress" an has not yet finished.

## Nextcloud file identifiers in OpenProject

In Nextcloud every file has an `id` and a `fileid`. The `id` differentiates a file from another within the same Nextcloud instance. The `fileid` in contrast is globally unique as it is a composition of the unique Nextcloud instance ID and the file's `id`. More information on this [here.](https://help.nextcloud.com/t/difference-between-id-and-fileid-in-webdav/91414) In OpenProject we use the `fileid` as we might want to support multiple Nextcloud instances in the future and still want to have a simple way to query on them. By using the `fileid` we only need one value to identify a file and not two (file id and instance id).

## File (link) resources

`File` resources in OpenProject describe links between resources in OpenProject (work packages, wiki pages, etc.) and their representation in a file store, i.e. a file in Nextcloud or in a Google Drive. 

### Example:

_"GetEnd of the insertion Begin of the deletion * ReturnEnd of the deletion all Begin of the insertionfiles linked toEnd of the insertion work packages Begin of the insertionin project 5End of the insertion that are Begin of the insertionstored in file store 1"_

For readability reasons we chose to show the URL params not URL encoded in this example. The params must be URL encoded first if you want to use them in a real example.

`/api/v3/files?filters=[{"resource_type":{"operator":"=","values":["WorkPackage"]}},{"project_id":{"operator":"=","values":["5"]}},{"file_store":{"operator":"=","values":["1"]}}]`

This will return a collection of work package resources.

## Work packages that areEnd of the insertion related to a Begin of the insertionNextcloud "fileid"

To query all work packages that are linked to a NextcloudEnd of the insertion file Begin of the insertionyou need to apply the filter `nextcloudFileid` to the `work_packages` API endpoint. The filter allows only one operator `=` and multiple `fileid`s as values.

### Example:

_"GetEnd of the insertion Begin of the deletion ID
* ReturnEnd of the deletion all Begin of the insertionwork packagesEnd of the insertion Begin of the deletion filesEnd of the deletion that are related to Begin of the insertiona Nextcoud_ `_fileid_`_"_

For readability reasons we chose to show the URL params not URL encoded in this example. The params must be URL encoded first if you want to use them in a real example.

`/api/v3/work_packages?filters=[{"nextcloudFileid":{"operator":"=","values":["00001234","00001235"]}}]`

This will return a collection of work package resources.

## **Files that are related to a work package**

To query all linked files ofEnd of the insertion a work package