NameDescriptionTypeAdditional information
id

Primary key

globally unique identifier

Required

uploaded_by_user_id

User who uploaded/created this import

globally unique identifier
date_creation

Date when import was created

date
date_creation

Date when import was created (XML/JSON serialization, "yyyy-MM-ddTHH:mm:ss.fffZ"). JSON uses this string property (rather than the raw date_creation above) because api/DbImport/... endpoints are plain (non-OData) routes: Json.NET's native DateTimeOffset serialization would otherwise write "+00:00" instead of "Z".

string
date_start_import

Date when import process started

date
date_start_import

Date when import process started (XML/JSON serialization, "yyyy-MM-ddTHH:mm:ss.fffZ"). JSON uses this string property (rather than the raw date_start_import above) because api/DbImport/... endpoints are plain (non-OData) routes: Json.NET's native DateTimeOffset serialization would otherwise write "+00:00" instead of "Z".

string
date_end_import

Date when import process completed

date
date_end_import

Date when import process completed (XML/JSON serialization, "yyyy-MM-ddTHH:mm:ss.fffZ"). JSON uses this string property (rather than the raw date_end_import above) because api/DbImport/... endpoints are plain (non-OData) routes: Json.NET's native DateTimeOffset serialization would otherwise write "+00:00" instead of "Z".

string
lines_total

Total number of lines in import file

integer
lines_imported

Number of lines successfully imported

integer
is_ready

Indicates if import is ready to be processed

boolean
is_locked

Indicates if import is locked (being processed)

boolean
is_done

Indicates if import is completed

boolean
remark

Additional remarks about the import

string

Max length: 4000

result

Result message of the import process

string
template_name

Name of the template used for this import (ASG-4066). On create, provide the exact name of the template to use when more than one template exists for the import_type; optional when only one template exists (it's used automatically). Maps to the underlying db_import.name column, but is exposed as template_name in the API.

string

Max length: 255

db_file_id

Foreign key to db_file containing the import data

globally unique identifier

Required

error_file_id

Foreign key to db_file containing error log

globally unique identifier
import_type

Type of import: COMPANY, CONTACT, ARTICLE, EQUIPMENT_MODEL, INSTALLATION, LOCATION, JOB, TASK, WORK_INSTRUCTION_DETAILS, PRODUCT_STOCK

string

Required

Max length: 100

import_error_count

Number of errors encountered during import

integer
is_template

Indicates if this is a template import configuration

boolean
percentage_done

Percentage of import completion (0-100)

integer
mapping

JSON mapping configuration for field mapping

string
options

JSON options configuration for import options

string
db_syncerp_log_id

Foreign key to db_syncerp_log if import is from ERP sync

globally unique identifier
modified_dateutc

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

date
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding, updating (XML/JSON serialization). JSON also uses this string property so non-OData endpoints (api/DbImport/Stock) output the same "yyyy-MM-ddTHH:mm:ss.fffZ" format as the OData endpoints.

string