Request Information

URI Parameters :

None.

Body Parameters :

db_file_folder
NameDescriptionTypeAdditional 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

Sample: 
{
  "id": "034b7e48-d805-48ee-8590-3e832271208d",
  "parent_id": "8dd1927a-c80c-4c7b-8966-046aeef51a51",
  "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": "2026-08-06T19:59:03.8625951+00:00"
}

Response Information

Resource Description :

db_file_folder
NameDescriptionTypeAdditional 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

Sample: 
{
  "id": "f7fd5f0d-f470-426e-9f5c-00388ee06ded",
  "parent_id": "a7fd8d79-197c-4e90-8bb2-4026d8249d09",
  "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": "2026-08-06T19:59:03.8782181+00:00"
}