Files

We differentiates between the content of a file and its metadata. While you can retrieve the metadata like any other object of the API, the content is available separately on dedicated endpoints. When you upload new files, this distinction is not made and the file is created by a single multipart/form-data POST request with all the metadata and content in the body of the request.

Another convenient feature is that we create different versions of your files. You can update the metadata and content of an existing file without losing the original file. We automatically create a new version in this case and link it to the existing version.

For images, they are special API endpoints that allow you to automatically scale and crop images as needed.

Shared Files

Shared files are files that awork provides for public access. To retrieve a file, a token generated by awork is necessary.

Temporary Files

Temporary files are files that have no current association with an entity and are not global. They allow you to upload files and assign them later to an entity. Temporary files are not visible in awork.

Permissions

Files are linked to a specific entity using an EntityId. This also determines whether the user is allowed to work with these files. Depending on the entity, permissions are required on the corresponding master-data feature. This also applies to the images.

It is also possible to work with files that do not have a link to an entity. These are available for all users in the team who have permissions to the feature files-master-data.

If you want to try out these endpoints, click the following button and get all the endpoints as a collection for Postman.