Retrieves the db_file with the specified key
Request Information
URI Parameters :
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
db_fileName | 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": "6e1ea634-4b0c-4195-8c5e-3a8279833e89", "db_table_id": "4ce78189-8366-485c-896d-1f77cbce22f3", "db_table_name": "sample string 3", "id_in_table": "12b88340-c527-4421-bc26-d509be68bfa7", "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": "54a2aa4e-44ba-4374-b03f-3b3851d693c9", "db_file_folder_reference_back_office": "sample string 12", "sales_organization_id": "8e032cfc-0c17-4f69-aa16-355489f1336a", "sales_organization_code": "sample string 14", "file_type_name": "sample string 15", "file_size": 16, "user_notification": true, "is_archived": true, "date_add": "2024-12-11T10:30:55.3240879+00:00", "date_update": "2024-12-11T10:30:55.3240879+00:00", "modified_dateutc": "2024-12-11T10:30:55.3240879+00:00" }