Creates a new db_file by supplying directly the field db_file.file_content as Byte Array
Request Information
URI Parameters :
None.
Body Parameters :
db_file| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| db_table_id |
Table.id of the linked entity |
globally unique identifier | |
| db_table_name |
Foreign key to the table of the linked entity using table name. Can be article,company,contact,jobs,job_approval,project or task.Will be also filled on Get to allow Odata Filter on it |
string | |
| id_in_table |
Id of the linked entity |
globally unique identifier | |
| name |
Name of the file |
string |
Required Max length: 100 |
| description |
Description of the file |
string |
Max length: 4000 |
| file_name |
File_name of the file |
string |
Max length: 100 |
| image_width |
In case of picture, the original width |
integer | |
| image_heigth |
In case of picture, the original heigth |
integer | |
| mime_type |
Mime-type of the file.Used when redirect user to the data, like application/pdf or image/jpeg |
string |
Max length: 100 |
| file_content |
The file content, in Byte Array. Use this field when using POST/Put |
Collection of byte | |
| db_file_folder_id |
For Global Files : Foreign key to db file folder |
globally unique identifier | |
| db_file_folder_reference_back_office |
Embedded entity "db_file_folder" using ERP PK when adding/updating db_file |
string | |
| db_file_folder |
Embedded entity "db_file_folder" using node when adding/updating db_file |
db_file_folder | |
| sales_organization_id |
In case of global files - you can specifiy if it's available for all organization or only one |
globally unique identifier | |
| sales_organization_code |
Embedded entity "sales_organization" using ERP PK when adding/updating db_file |
string | |
| sales_organization |
Embedded entity "sales_organization" using node when adding/updating db_file |
sales_organization | |
| file_type_name |
Readonly :Constant in case of specific file. Can be JOB_APPROVAL, ORDERPDF, PURCHASE_ORDERPDF |
string | |
| file_size |
Size in bytes of the file_content |
integer | |
| user_notification |
For Global files - indicate if user should be informed that this file is available |
boolean | |
| is_archived |
Indicate if the file has been deleted (content flushed) |
boolean | |
| date_add |
Date when file has been added |
date | |
| date_update |
Update date, auto filled by Now if no value received |
date | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
{
"id": "f3ba9fd2-f5eb-4efe-90eb-1448420f959f",
"db_table_id": "9579c8bf-877e-430c-9835-225f79ff1b69",
"db_table_name": "sample string 3",
"id_in_table": "3abb8297-e927-41ef-a0d5-0cc8fc855f19",
"name": "sample string 5",
"description": "sample string 6",
"file_name": "sample string 7",
"image_width": 8,
"image_heigth": 9,
"mime_type": "sample string 10",
"file_content": "QEA=",
"db_file_folder_id": "1fe674c7-04f5-424b-850e-fe6997efe63c",
"db_file_folder_reference_back_office": "sample string 12",
"sales_organization_id": "d81cf837-7d14-4cf5-b218-fd36e514f344",
"sales_organization_code": "sample string 14",
"file_type_name": "sample string 15",
"file_size": 16,
"user_notification": true,
"is_archived": true,
"date_add": "2025-04-27T09:12:42.0977153+00:00",
"date_update": "2025-04-27T09:12:42.0977153+00:00",
"modified_dateutc": "2025-04-27T09:12:42.0977153+00:00"
}
Response Information
Resource Description :
db_file| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| db_table_id |
Table.id of the linked entity |
globally unique identifier | |
| db_table_name |
Foreign key to the table of the linked entity using table name. Can be article,company,contact,jobs,job_approval,project or task.Will be also filled on Get to allow Odata Filter on it |
string | |
| id_in_table |
Id of the linked entity |
globally unique identifier | |
| name |
Name of the file |
string |
Required Max length: 100 |
| description |
Description of the file |
string |
Max length: 4000 |
| file_name |
File_name of the file |
string |
Max length: 100 |
| image_width |
In case of picture, the original width |
integer | |
| image_heigth |
In case of picture, the original heigth |
integer | |
| mime_type |
Mime-type of the file.Used when redirect user to the data, like application/pdf or image/jpeg |
string |
Max length: 100 |
| file_content |
The file content, in Byte Array. Use this field when using POST/Put |
Collection of byte | |
| db_file_folder_id |
For Global Files : Foreign key to db file folder |
globally unique identifier | |
| db_file_folder_reference_back_office |
Embedded entity "db_file_folder" using ERP PK when adding/updating db_file |
string | |
| db_file_folder |
Embedded entity "db_file_folder" using node when adding/updating db_file |
db_file_folder | |
| sales_organization_id |
In case of global files - you can specifiy if it's available for all organization or only one |
globally unique identifier | |
| sales_organization_code |
Embedded entity "sales_organization" using ERP PK when adding/updating db_file |
string | |
| sales_organization |
Embedded entity "sales_organization" using node when adding/updating db_file |
sales_organization | |
| file_type_name |
Readonly :Constant in case of specific file. Can be JOB_APPROVAL, ORDERPDF, PURCHASE_ORDERPDF |
string | |
| file_size |
Size in bytes of the file_content |
integer | |
| user_notification |
For Global files - indicate if user should be informed that this file is available |
boolean | |
| is_archived |
Indicate if the file has been deleted (content flushed) |
boolean | |
| date_add |
Date when file has been added |
date | |
| date_update |
Update date, auto filled by Now if no value received |
date | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
{
"id": "72343cb2-ab2b-43f8-8f88-332dfdd6fcd0",
"db_table_id": "ef1c0231-2602-47b5-8364-5f72b82ba7fa",
"db_table_name": "sample string 3",
"id_in_table": "7dcf8611-a8b1-4bba-bbde-0207555b62cb",
"name": "sample string 5",
"description": "sample string 6",
"file_name": "sample string 7",
"image_width": 8,
"image_heigth": 9,
"mime_type": "sample string 10",
"file_content": "QEA=",
"db_file_folder_id": "d64352bc-0925-4a4a-b78e-b5575cd3c77d",
"db_file_folder_reference_back_office": "sample string 12",
"sales_organization_id": "d47b055b-8e6d-4e72-bdb1-5f845f73b7b5",
"sales_organization_code": "sample string 14",
"file_type_name": "sample string 15",
"file_size": 16,
"user_notification": true,
"is_archived": true,
"date_add": "2025-04-27T09:12:42.1777175+00:00",
"date_update": "2025-04-27T09:12:42.1777175+00:00",
"modified_dateutc": "2025-04-27T09:12:42.1777175+00:00"
}