Retrieves the db_file with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

db_file
NameDescriptionTypeAdditional 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

Sample: 
{
  "id": "aa1d004f-bae4-4c88-8c47-3d2e70cd9f99",
  "db_table_id": "72968c2e-327e-4d44-8b9b-a46eea20ab92",
  "db_table_name": "sample string 3",
  "id_in_table": "fccd9d09-12e4-4881-8c7a-1bedcbfd2033",
  "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": "0b60641a-8886-4cd1-acdf-120118d6c027",
  "db_file_folder_reference_back_office": "sample string 12",
  "sales_organization_id": "3fdefdc1-907b-429c-a16b-fe161eeeb911",
  "sales_organization_code": "sample string 14",
  "file_type_name": "sample string 15",
  "file_size": 16,
  "user_notification": true,
  "is_archived": true,
  "date_add": "2024-11-21T09:32:03.9009913+00:00",
  "date_update": "2024-11-21T09:32:03.9009913+00:00",
  "modified_dateutc": "2024-11-21T09:32:03.9009913+00:00"
}