|
Http Verb |
POST |
|---|---|
|
Url |
/documents/r1/directories |
|
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 manages the creation of new directories, ensuring data consistency and proper notifications.
-
Validation Phase:
-
Validates parent UUID presence. If not specified, assigns root directory as parent (initializing root directory if not previously created)
-
Verifies all required fields are present
-
Validates the parent directory exists and is accessible
-
Checks validity date intervals and permissions
-
-
Data Completion:
-
Completes the directory data (type, active flag, etc.)
-
Generates and assigns a unique physical path based on the configured saving strategy
-
-
Saving:
-
Saves the directory data
-
Notifies interested components about new directory
-
Header Parameters
Default.
Request Body Parameters
|
Field |
Validations |
Note |
|---|---|---|
|
name |
Not Null Max Length: 200 |
|
|
startValidityDate |
|
|
|
endValidityDate |
|
|
|
originId |
Not Null |
|
|
parentUuid |
Max Length: 4000 |
|
|
draft |
|
|
Response documentation
Response payload fields
|
Field |
Note |
|---|---|
|
uuid |
|
Response error codes
BASE_0001, BASE_0017, SHAREDRESOURCE_003