Creates or updates a job file.

Request Information

URI Parameters :

None.

Body Parameters :

db_file
NameDescriptionTypeAdditional information
id

Primary key

globally unique identifier

Required

db_table_id

Table.id of the linked entity

globally unique identifier
id_in_table

Id of the linked entity

globally unique identifier
file_type

Free-text classification of this file's type/purpose.

string
is_default

Indicates this is the default/primary file for the linked entity.

boolean
file_name

File_name of the file

string
mime_type

MIME type of the file (e.g. "application/pdf", "image/jpeg").

string
file_content

Raw binary content of the file.

Collection of byte
image_width

In case of picture, the original width

integer
image_heigth

In case of picture, the original heigth

integer
user_id

Foreign key of the user who uploaded this file.

globally unique identifier
description

Free-text description of the file.

string
tags

Free-text, comma-separated tags applied to this file (denormalized summary; see for the structured link).

string
date_update

Local date and time this file was last updated.

date
date_add

Local date and time this file was added.

date
dateutc_add

UTC date and time this file was added.

date
name

Display name of the file.

string
file_size

Size of the file, in bytes.

integer
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

date
is_showonweb

Is available on ServiceDesk?

boolean
sys_logical_delete

Soft-delete flag: when true, this file is considered deleted, optimizing synchronization (can be physically deleted offline).

boolean

Request Formats :

application/json, text/json

Sample:
{
  "id": "29c02bfa-1c20-4fa1-96c5-b44e214042dc",
  "db_table_id": "fa14e8c3-005a-463d-867e-84d0a18536a6",
  "id_in_table": "77b40a05-39cb-410b-8e98-b8576466b879",
  "file_type": "sample string 4",
  "is_default": true,
  "file_name": "sample string 6",
  "mime_type": "sample string 7",
  "file_content": "QEA=",
  "image_width": 8,
  "image_heigth": 9,
  "user_id": "1a5952da-66a4-4e00-a653-548d27efe285",
  "description": "sample string 11",
  "tags": "sample string 12",
  "date_update": "2026-09-16T09:22:37.6017855+00:00",
  "date_add": "2026-09-16T09:22:37.6017855+00:00",
  "dateutc_add": "2026-09-16T09:22:37.6017855+00:00",
  "name": "sample string 16",
  "file_size": 17,
  "modified_dateutc": "2026-09-16T09:22:37.6017855+00:00",
  "is_showonweb": true,
  "sys_logical_delete": true
}

application/xml, text/xml

Sample:
<db_file xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <date_add>2026-09-16T09:22:37.601Z</date_add>
  <date_update>2026-09-16T09:22:37.601Z</date_update>
  <dateutc_add>2026-09-16T09:22:37.601Z</dateutc_add>
  <db_table_id>fa14e8c3-005a-463d-867e-84d0a18536a6</db_table_id>
  <description>sample string 11</description>
  <file_content>QEA=</file_content>
  <file_name>sample string 6</file_name>
  <file_size>17</file_size>
  <file_type>sample string 4</file_type>
  <id>29c02bfa-1c20-4fa1-96c5-b44e214042dc</id>
  <id_in_table>77b40a05-39cb-410b-8e98-b8576466b879</id_in_table>
  <image_heigth>9</image_heigth>
  <image_width>8</image_width>
  <is_default>true</is_default>
  <is_showonweb>true</is_showonweb>
  <mime_type>sample string 7</mime_type>
  <modified_dateutc>2026-09-16T09:22:37.601Z</modified_dateutc>
  <name>sample string 16</name>
  <sys_logical_delete>true</sys_logical_delete>
  <tags>sample string 12</tags>
  <user_id>1a5952da-66a4-4e00-a653-548d27efe285</user_id>
</db_file>

Response Information

Resource Description :

IHttpActionResult containing the saved job file.

db_file
NameDescriptionTypeAdditional information
id

Primary key

globally unique identifier

Required

db_table_id

Table.id of the linked entity

globally unique identifier
id_in_table

Id of the linked entity

globally unique identifier
file_type

Free-text classification of this file's type/purpose.

string
is_default

Indicates this is the default/primary file for the linked entity.

boolean
file_name

File_name of the file

string
mime_type

MIME type of the file (e.g. "application/pdf", "image/jpeg").

string
file_content

Raw binary content of the file.

Collection of byte
image_width

In case of picture, the original width

integer
image_heigth

In case of picture, the original heigth

integer
user_id

Foreign key of the user who uploaded this file.

globally unique identifier
description

Free-text description of the file.

string
tags

Free-text, comma-separated tags applied to this file (denormalized summary; see for the structured link).

string
date_update

Local date and time this file was last updated.

date
date_add

Local date and time this file was added.

date
dateutc_add

UTC date and time this file was added.

date
name

Display name of the file.

string
file_size

Size of the file, in bytes.

integer
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

date
is_showonweb

Is available on ServiceDesk?

boolean
sys_logical_delete

Soft-delete flag: when true, this file is considered deleted, optimizing synchronization (can be physically deleted offline).

boolean

Response Formats

application/json, text/json

Sample:
{
  "id": "c1b0a092-3cae-44c6-acfe-28dec63c1774",
  "db_table_id": "f12c8665-62c3-4b74-9961-be1b124b7b91",
  "id_in_table": "c3271231-3cf7-4850-b0b5-add21a473719",
  "file_type": "sample string 4",
  "is_default": true,
  "file_name": "sample string 6",
  "mime_type": "sample string 7",
  "file_content": "QEA=",
  "image_width": 8,
  "image_heigth": 9,
  "user_id": "c0afad0b-4c8f-4f4d-bde1-487c76231123",
  "description": "sample string 11",
  "tags": "sample string 12",
  "date_update": "2026-09-16T09:22:37.6017855+00:00",
  "date_add": "2026-09-16T09:22:37.6017855+00:00",
  "dateutc_add": "2026-09-16T09:22:37.6017855+00:00",
  "name": "sample string 16",
  "file_size": 17,
  "modified_dateutc": "2026-09-16T09:22:37.6017855+00:00",
  "is_showonweb": true,
  "sys_logical_delete": true
}

application/xml, text/xml

Sample:
<db_file xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <date_add>2026-09-16T09:22:37.601Z</date_add>
  <date_update>2026-09-16T09:22:37.601Z</date_update>
  <dateutc_add>2026-09-16T09:22:37.601Z</dateutc_add>
  <db_table_id>f12c8665-62c3-4b74-9961-be1b124b7b91</db_table_id>
  <description>sample string 11</description>
  <file_content>QEA=</file_content>
  <file_name>sample string 6</file_name>
  <file_size>17</file_size>
  <file_type>sample string 4</file_type>
  <id>c1b0a092-3cae-44c6-acfe-28dec63c1774</id>
  <id_in_table>c3271231-3cf7-4850-b0b5-add21a473719</id_in_table>
  <image_heigth>9</image_heigth>
  <image_width>8</image_width>
  <is_default>true</is_default>
  <is_showonweb>true</is_showonweb>
  <mime_type>sample string 7</mime_type>
  <modified_dateutc>2026-09-16T09:22:37.601Z</modified_dateutc>
  <name>sample string 16</name>
  <sys_logical_delete>true</sys_logical_delete>
  <tags>sample string 12</tags>
  <user_id>c0afad0b-4c8f-4f4d-bde1-487c76231123</user_id>
</db_file>