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": "0ab1250a-d6e1-4faf-b7a4-9fbc24f162fe",
  "parent_id": "197c530d-66cf-430b-946b-b96cbf813a5e",
  "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-04-16T21:53:15.4685972+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": "d0162b72-2eda-4386-8b25-d6dc50f20eab",
  "parent_id": "61a02238-bb11-4255-80b7-57908f9e6cd1",
  "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-04-16T21:53:15.4842238+00:00"
}