Files collections are used by the API in scenarios where you typically process one or more files. For example:
-
When uploading files from an order form. The files collection is the mechanism to allow an online user to manipulate the files in the form.
-
When importing work that has been taken offline (projects/{did}/documents/offline/import/init (GET) )
-
And other scenarios.
A files collection is identified by a unique key. How do you obtain a key?
-
To obtain a key (create a new file collection) you need to read the documentation of the methods that do require a file collection.
The methods are:
-
media/filescollection/{key} -
media/filescollection/{key}/items -
media/filescollection/{key}/items/file (POST) -
media/filescollection/{key}/items/file -
media/filescollection/{key}/items/file (DELETE) -
media/filescollection/{key}/items (DELETE) -
media/filescollection/{key}/items/file/properties -
media/filescollection/{key}/items/file/properties?filename (PUT) -
media/filescollection/{key}/items/file/properties (PUT) -
File object