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": "b6e51dff-6ab4-47ab-99c5-03910ca52290",
"db_table_id": "33166ca2-e4b5-404d-963c-ed1e189ed594",
"db_table_name": "sample string 3",
"id_in_table": "816a717a-b147-450e-aa21-db4e14833439",
"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": "b8773a7c-b51b-4493-8264-8e968727bf13",
"db_file_folder_reference_back_office": "sample string 12",
"sales_organization_id": "b54394c0-491e-4919-a5ad-b190292b9fa1",
"sales_organization_code": "sample string 14",
"file_type_name": "sample string 15",
"file_size": 16,
"user_notification": true,
"is_archived": true,
"date_add": "2024-04-17T00:21:55.1754875+00:00",
"date_update": "2024-04-17T00:21:55.1754875+00:00",
"modified_dateutc": "2024-04-17T00:21:55.1754875+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": "b8a1767e-b3f1-4133-a04b-c9f4ed32ee18",
"db_table_id": "a485ca0b-09f3-4af8-80ed-3daf81867f00",
"db_table_name": "sample string 3",
"id_in_table": "63fd2e31-65bb-40e7-b6b0-701f545d0fe6",
"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": "4c6d8ee6-adbb-40d5-a37a-a4bcf9622ad2",
"db_file_folder_reference_back_office": "sample string 12",
"sales_organization_id": "70a2a657-c359-4ad7-bc06-3db28ba03bb0",
"sales_organization_code": "sample string 14",
"file_type_name": "sample string 15",
"file_size": 16,
"user_notification": true,
"is_archived": true,
"date_add": "2024-04-17T00:21:55.2223639+00:00",
"date_update": "2024-04-17T00:21:55.2223639+00:00",
"modified_dateutc": "2024-04-17T00:21:55.2223639+00:00"
}