Creates or updates a file.
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 | |
| 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
{
"id": "26fa2033-265d-4a22-96cd-cba30c68061e",
"db_table_id": "6fa1844f-701d-4609-a6b9-e07684950408",
"id_in_table": "d6e6282a-2978-4e7d-8f64-1ca2dc30063c",
"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": "219e4406-de76-4e5b-8cf9-d4a9963f3e0f",
"description": "sample string 11",
"tags": "sample string 12",
"date_update": "2026-11-12T14:27:22.5245331+00:00",
"date_add": "2026-11-12T14:27:22.5245331+00:00",
"dateutc_add": "2026-11-12T14:27:22.5245331+00:00",
"name": "sample string 16",
"file_size": 17,
"modified_dateutc": "2026-11-12T14:27:22.5245331+00:00",
"is_showonweb": true,
"sys_logical_delete": true
}
application/xml, text/xml
<db_file xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <date_add>2026-11-12T14:27:22.524Z</date_add> <date_update>2026-11-12T14:27:22.524Z</date_update> <dateutc_add>2026-11-12T14:27:22.524Z</dateutc_add> <db_table_id>6fa1844f-701d-4609-a6b9-e07684950408</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>26fa2033-265d-4a22-96cd-cba30c68061e</id> <id_in_table>d6e6282a-2978-4e7d-8f64-1ca2dc30063c</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-11-12T14:27:22.524Z</modified_dateutc> <name>sample string 16</name> <sys_logical_delete>true</sys_logical_delete> <tags>sample string 12</tags> <user_id>219e4406-de76-4e5b-8cf9-d4a9963f3e0f</user_id> </db_file>
Response Information
Resource Description :
IHttpActionResult containing the saved file.
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 | |
| 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
{
"id": "e9fda03a-83dc-45aa-93e0-a149bdc41c31",
"db_table_id": "a7927e15-78f1-45bd-bb5b-02a48a4e6e62",
"id_in_table": "359741d4-830e-4751-9169-d3140f6d6737",
"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": "95002abc-2370-4b2e-ae07-fb936c9de0dd",
"description": "sample string 11",
"tags": "sample string 12",
"date_update": "2026-11-12T14:27:22.5245331+00:00",
"date_add": "2026-11-12T14:27:22.5245331+00:00",
"dateutc_add": "2026-11-12T14:27:22.5245331+00:00",
"name": "sample string 16",
"file_size": 17,
"modified_dateutc": "2026-11-12T14:27:22.5245331+00:00",
"is_showonweb": true,
"sys_logical_delete": true
}
application/xml, text/xml
<db_file xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <date_add>2026-11-12T14:27:22.524Z</date_add> <date_update>2026-11-12T14:27:22.524Z</date_update> <dateutc_add>2026-11-12T14:27:22.524Z</dateutc_add> <db_table_id>a7927e15-78f1-45bd-bb5b-02a48a4e6e62</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>e9fda03a-83dc-45aa-93e0-a149bdc41c31</id> <id_in_table>359741d4-830e-4751-9169-d3140f6d6737</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-11-12T14:27:22.524Z</modified_dateutc> <name>sample string 16</name> <sys_logical_delete>true</sys_logical_delete> <tags>sample string 12</tags> <user_id>95002abc-2370-4b2e-ae07-fb936c9de0dd</user_id> </db_file>