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": "7066a964-159f-4a9d-b1b9-1872b82e70f6", "parent_id": "2e90426a-6372-4e2e-9434-2758356c448b", "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-14T19:44:32.632985+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": "5b8559af-c305-4afd-9425-ba743a472af1", "parent_id": "bae29490-89ed-415a-bbae-fc2e4a8a4423", "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-14T19:44:32.6486116+00:00" }