|
Http Verb |
PATCH |
|---|---|
|
Url |
PATCH /documents/resources/r1/files/{fileUuid} |
|
Permissions required |
|
|
Personally Identifiable Information (PII) |
No |
|
Sensitive Information |
No |
|
Last Modified Version |
r1 |
|
Released since |
2025 W2 (FSM 20.0) |
|
Deprecated since |
|
|
Removed since |
|
|
Tech Tags |
|
Business Logic
This API updates an existing file object.
The file update process manages modifications to existing files while maintaining data integrity and consistency. The process steps are:
-
Field Protection:
-
Critical fields are protected from modification (UUID, physical path, parent references, etc.)
-
System-generated values remain immutable (file size, generation date, author, etc.)
-
Directory structure relationships are preserved
-
-
Data Consistency:
-
Validates the modified file properties
-
Automatically sets modification timestamp and editor information
-
-
Saving:
-
Updates all the modi
-
Automatically sets modification timestamp and editor information
-
This controlled update mechanism ensures that file modifications maintain system integrity while allowing legitimate changes to user-modifiable properties.
Path Parameters
|
Field |
|---|
|
fileUuid |
Header Parameters
Default.
Request Body Parameters
|
Field |
Validations |
Note |
|---|---|---|
|
name |
Max Length: 200 |
|
|
startValidityDate |
|
|
|
endValidityDate |
|
|
|
draft |
|
|