Uploads

This section describes the endpoints related to file uploads in the Artesa API.

You can upload files to various resources, such as assignments and assignment events. The API supports file uploads through multipart/form-data requests.

Uploading files to assignments or assignment events

You can either upload files to assignments or directly to assignment events. The API provides endpoints for both scenarios.

When to use uploads to assignments?

Use uploads to assignments when you want to attach files that are relevant to the entire assignment and need to be accessed by various stakeholders, such as an offer, invoice, manufacturing files or material lists.

When to use uploads to assignment events?

Use uploads to assignment events when you want to attach files that are specific to a particular event within the assignment, such as a photo of the completed work or a document related to that specific event.

Uploads to assignments

You can upload files to assignments. You find all operations in /v1/assignments. Specifically, the /v1/assignments/{assignmentId}/uploads operation allows you to upload files related to an assignment.

INFO

In order to upload files, you need to provide the assignmentId in the URL. The API will handle the file upload and associate it with the specified assignment. Also make sure to set the Content-Type header to multipart/form-data when making the request.

Additionally to the file, you can also provide a categoryId to categorize the upload. This is useful for organizing uploads and making them easier to find later.

Uploads to assignment events

You can upload files to assignment events. You find all operations in /v1/assignment-events. Specifically, the v1/assignment-events/{assignmentEventId}/uploads operation allows you to upload files related to an assignment event.

INFO

In order to upload files, you need to provide the assignmentEventId in the URL. The API will handle the file upload and associate it with the specified assignment event. Also make sure to set the Content-Type header to multipart/form-data when making the request.

Additionally to the file, you can also provide a categoryId to categorize the upload. This is useful for organizing uploads and making them easier to find later.