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": "07616c74-4e5d-4c02-9e49-d2364a822e5f", "parent_id": "0a62177f-89a5-4ce0-b4b9-fe1fb764f360", "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-09-04T20:24:55.6210717+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": "c2039d24-a8a8-40be-9e2e-b4edfd5d0109", "parent_id": "dafb52e2-7053-4499-84a7-486a7bd49c68", "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-09-04T20:24:55.6210717+00:00" }