Request Information
URI Parameters :
None.
Body Parameters :
db_file_folderName | Description | Type | Additional information |
---|---|---|---|
id |
Primary Key |
globally unique identifier | |
parent_id |
Reference to a parent folder (in case of Child/Parent) when adding/updating folder |
globally unique identifier | |
parent_reference_back_office |
Reference to a parent folder (in case of Child/Parent) when adding/updating folder |
string | |
parent_db_file_folder |
Reference to a parent folder (in case of Child/Parent) using embedded entity when adding/updating folder |
db_file_folder | |
name | string |
Required Max length: 255 |
|
description |
Description of the folder |
string |
Max length: 255 |
sequence |
Sorting field (0 first) |
integer | |
is_sales |
Indicate that this folder should be shown on the Sales environemnt (Company/Contact details) |
boolean | |
is_services |
Indicate that this folder should be shown on the Services environemnt (Task/Project and Jobs details) |
boolean | |
is_articles |
Indicate that this folder should be shown on the Article Details |
boolean | |
reference_back_office | string |
Max length: 255 |
|
modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
{ "id": "c6204a1d-fe9a-4568-8535-b5d60d29d79c", "parent_id": "f39183c9-f1c7-4747-ae24-9f206427b31e", "parent_reference_back_office": "sample string 3", "name": "sample string 4", "description": "sample string 5", "sequence": 6, "is_sales": true, "is_services": true, "is_articles": true, "reference_back_office": "sample string 10", "modified_dateutc": "2025-07-13T05:50:29.9978983+00:00" }
Response Information
Resource Description :
db_file_folderName | Description | Type | Additional information |
---|---|---|---|
id |
Primary Key |
globally unique identifier | |
parent_id |
Reference to a parent folder (in case of Child/Parent) when adding/updating folder |
globally unique identifier | |
parent_reference_back_office |
Reference to a parent folder (in case of Child/Parent) when adding/updating folder |
string | |
parent_db_file_folder |
Reference to a parent folder (in case of Child/Parent) using embedded entity when adding/updating folder |
db_file_folder | |
name | string |
Required Max length: 255 |
|
description |
Description of the folder |
string |
Max length: 255 |
sequence |
Sorting field (0 first) |
integer | |
is_sales |
Indicate that this folder should be shown on the Sales environemnt (Company/Contact details) |
boolean | |
is_services |
Indicate that this folder should be shown on the Services environemnt (Task/Project and Jobs details) |
boolean | |
is_articles |
Indicate that this folder should be shown on the Article Details |
boolean | |
reference_back_office | string |
Max length: 255 |
|
modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
{ "id": "31a6e271-594c-4d47-9217-87b99820e799", "parent_id": "53fe37bb-b571-404b-820a-29c98a76cf3d", "parent_reference_back_office": "sample string 3", "name": "sample string 4", "description": "sample string 5", "sequence": 6, "is_sales": true, "is_services": true, "is_articles": true, "reference_back_office": "sample string 10", "modified_dateutc": "2025-07-13T05:50:30.0135216+00:00" }