POST /documents/r1/files

Business Logic

This API creates a new file.

When a new file is created, the system performs several steps:

1. Validation Phase:

   • Verifies all required fields are present

   • Validates the parent directory exists and is accessible

   • Checks validity date intervals and permissions

2. Data Completion:

   • Completes the file data (type, original name, creation date, etc.)

   • Generates and assigns a unique physical path based on the configured saving strategy

   • Inherits and extends the UUID path from the parent directory

3. Saving:

   • Saves the file data

   • Creates the necessary file system structure

   • Returns the newly generated file ID

This process ensures that each file is properly stored, traceable, and maintains its relationship with the directory structure while preserving all necessary data.

HOW TO: steps to create a complete file

In order to create a file that contains all the completed information and can be correctly used, you need to follow these steps:

1. Create your file using this POST

2. Use the GET /documents/r1/files/upload-urls API to retrieve the upload pre-signed URL

3. Use the retrieved URL to upload your ‘physical’ file

4. Use POST /documents/r1/files/{fileUuid}/activations to activate the file and make sure your uploaded ‘physical’ file is aligned with the file you created during step 1.

Header Parameters

Default.

Request Body Parameters

Response documentation

Response payload fields

Response error codes

BASE_0001, BASE_0017, SHAREDRESOURCE_001