Request Information

URI Parameters :

None.

Body Parameters :

None.

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": "3f6aabcd-b9d5-4809-8844-7dd59ef7761a",
  "parent_id": "f1624308-4884-4e0a-80dd-07798f490352",
  "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": "2024-03-26T17:41:04.3126086+00:00"
}