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": "9e7dcbd2-4452-4566-b2a9-10a5b9474ad9",
  "parent_id": "436f76fc-2e7e-472d-a8a2-5e0ee7e3421e",
  "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": "2022-12-02T21:14:38.3989594+01: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": "8a9ab9d9-a8de-4832-b548-3f1883c2c9e8",
  "parent_id": "c8ed71a6-2b83-40c0-bd3b-73b86b233ff8",
  "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": "2022-12-02T21:14:38.3989594+01:00"
}