Creates a new sync log entry.

Request Information

URI Parameters :

None.

Body Parameters :

sync_log
NameDescriptionTypeAdditional information
id

Primary key

globally unique identifier

Required

application_code

Code identifying which client application performed the synchronization (e.g. "NativeService").

string
user_id

Foreign key of the user who ran the synchronization.

globally unique identifier
email

Email address of the user who ran the synchronization, captured for diagnostics.

string

Max length: 255

device_id

Foreign key of the device that ran the synchronization.

globally unique identifier
timeutc_start

Readonly system field: UTC date and time the synchronization started.

date
timeutc_end

Readonly system field: UTC date and time the synchronization finished.

date
duration

Total duration of the synchronization run, in milliseconds.

integer
total_api_calls

Total number of API calls made during this synchronization run.

integer
total_api_response_time

Total time spent waiting on API responses during this run, in milliseconds.

integer
avg_api_response_time

Average API response time across all calls in this run, in milliseconds.

integer
max_api_response_time_names

Names of the API calls that took the longest to respond, for diagnosing slow endpoints.

string

Max length: 8000

downloading_details

Free-text breakdown of what was downloaded during this synchronization run.

string

Max length: 8000

uploading_details

Free-text breakdown of what was uploaded during this synchronization run.

string

Max length: 8000

other_actions_details

Free-text breakdown of any other (non upload/download) actions performed during this run.

string

Max length: 8000

errors

Free-text details of any errors encountered during the synchronization run.

string
is_completed

Indicates whether the synchronization run finished successfully.

boolean
dateutc_added_on_server

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

date

Request Formats :

application/json, text/json

Sample:
{
  "id": "6f4df0f0-4abf-4436-8dac-95bed9d99794",
  "application_code": "sample string 2",
  "user_id": "eb0ad649-1a9a-4700-8088-16f428b39ea6",
  "email": "sample string 4",
  "device_id": "7a4f8d7b-9f2b-43cd-acc8-9f1c6d03aa44",
  "timeutc_start": "2026-11-12T14:27:51.6656275+00:00",
  "timeutc_end": "2026-11-12T14:27:51.6656275+00:00",
  "duration": 8,
  "total_api_calls": 9,
  "total_api_response_time": 10,
  "avg_api_response_time": 11,
  "max_api_response_time_names": "sample string 12",
  "downloading_details": "sample string 13",
  "uploading_details": "sample string 14",
  "other_actions_details": "sample string 15",
  "errors": "sample string 16",
  "is_completed": true,
  "dateutc_added_on_server": "2026-11-12T14:27:51.6656275+00:00"
}

application/xml, text/xml

Sample:
<sync_log xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <application_code>sample string 2</application_code>
  <avg_api_response_time>11</avg_api_response_time>
  <dateutc_added_on_server>2026-11-12T14:27:51.665Z</dateutc_added_on_server>
  <device_id>7a4f8d7b-9f2b-43cd-acc8-9f1c6d03aa44</device_id>
  <downloading_details>sample string 13</downloading_details>
  <duration>8</duration>
  <email>sample string 4</email>
  <errors>sample string 16</errors>
  <id>6f4df0f0-4abf-4436-8dac-95bed9d99794</id>
  <is_completed>true</is_completed>
  <max_api_response_time_names>sample string 12</max_api_response_time_names>
  <other_actions_details>sample string 15</other_actions_details>
  <timeutc_end>2026-11-12T14:27:51.665Z</timeutc_end>
  <timeutc_start>2026-11-12T14:27:51.665Z</timeutc_start>
  <total_api_calls>9</total_api_calls>
  <total_api_response_time>10</total_api_response_time>
  <uploading_details>sample string 14</uploading_details>
  <user_id>eb0ad649-1a9a-4700-8088-16f428b39ea6</user_id>
</sync_log>

Response Information

Resource Description :

IHttpActionResult containing the created sync log entry.

sync_log
NameDescriptionTypeAdditional information
id

Primary key

globally unique identifier

Required

application_code

Code identifying which client application performed the synchronization (e.g. "NativeService").

string
user_id

Foreign key of the user who ran the synchronization.

globally unique identifier
email

Email address of the user who ran the synchronization, captured for diagnostics.

string

Max length: 255

device_id

Foreign key of the device that ran the synchronization.

globally unique identifier
timeutc_start

Readonly system field: UTC date and time the synchronization started.

date
timeutc_end

Readonly system field: UTC date and time the synchronization finished.

date
duration

Total duration of the synchronization run, in milliseconds.

integer
total_api_calls

Total number of API calls made during this synchronization run.

integer
total_api_response_time

Total time spent waiting on API responses during this run, in milliseconds.

integer
avg_api_response_time

Average API response time across all calls in this run, in milliseconds.

integer
max_api_response_time_names

Names of the API calls that took the longest to respond, for diagnosing slow endpoints.

string

Max length: 8000

downloading_details

Free-text breakdown of what was downloaded during this synchronization run.

string

Max length: 8000

uploading_details

Free-text breakdown of what was uploaded during this synchronization run.

string

Max length: 8000

other_actions_details

Free-text breakdown of any other (non upload/download) actions performed during this run.

string

Max length: 8000

errors

Free-text details of any errors encountered during the synchronization run.

string
is_completed

Indicates whether the synchronization run finished successfully.

boolean
dateutc_added_on_server

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

date

Response Formats

application/json, text/json

Sample:
{
  "id": "42f60d9a-efd3-4be4-97be-3339398400f2",
  "application_code": "sample string 2",
  "user_id": "f3bf227d-96ca-49b5-915f-61cdbb64ab05",
  "email": "sample string 4",
  "device_id": "bbb76cd8-5842-4fa9-b1a5-75ddbd23a919",
  "timeutc_start": "2026-11-12T14:27:51.6656275+00:00",
  "timeutc_end": "2026-11-12T14:27:51.6656275+00:00",
  "duration": 8,
  "total_api_calls": 9,
  "total_api_response_time": 10,
  "avg_api_response_time": 11,
  "max_api_response_time_names": "sample string 12",
  "downloading_details": "sample string 13",
  "uploading_details": "sample string 14",
  "other_actions_details": "sample string 15",
  "errors": "sample string 16",
  "is_completed": true,
  "dateutc_added_on_server": "2026-11-12T14:27:51.6656275+00:00"
}

application/xml, text/xml

Sample:
<sync_log xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <application_code>sample string 2</application_code>
  <avg_api_response_time>11</avg_api_response_time>
  <dateutc_added_on_server>2026-11-12T14:27:51.665Z</dateutc_added_on_server>
  <device_id>bbb76cd8-5842-4fa9-b1a5-75ddbd23a919</device_id>
  <downloading_details>sample string 13</downloading_details>
  <duration>8</duration>
  <email>sample string 4</email>
  <errors>sample string 16</errors>
  <id>42f60d9a-efd3-4be4-97be-3339398400f2</id>
  <is_completed>true</is_completed>
  <max_api_response_time_names>sample string 12</max_api_response_time_names>
  <other_actions_details>sample string 15</other_actions_details>
  <timeutc_end>2026-11-12T14:27:51.665Z</timeutc_end>
  <timeutc_start>2026-11-12T14:27:51.665Z</timeutc_start>
  <total_api_calls>9</total_api_calls>
  <total_api_response_time>10</total_api_response_time>
  <uploading_details>sample string 14</uploading_details>
  <user_id>f3bf227d-96ca-49b5-915f-61cdbb64ab05</user_id>
</sync_log>