DataImport Object

DataImport Object Formats

JSON Format

{
    "_t" : "dataimport",
	"_v" : "1.0",
	"ImportID" : "",
	"MimeType" : "",
	"ObjType" : "",
	"OriginalName" : "",
	"Size" : "",
	"Status" : 1001,
	"SubmitDate" : "",
	"ProcessingStart" : "",
	"ProcessingEnd" : "",
	"Results" : {
		"Success" : 0,
		"Errors" : 0,
		"Messages" : [
			{
				"row" : "",
				"error" : ""
			}
		]
	}
}

DataImport Object Properties

Required properties are in Bold.

Property Type Description

ImportID string Specifies the data import ID associated with the import request. This ID is automatically assigned by the system when the import data is submitted.

MimeType

string

Identifies the HTTP mime type of the imported data file.

ObjType

string

Identifies the object type that was imported. This value is determined by the value of the first sheet name of the MS Excel file.

Valid values are:

Value	Description
1001	Accounts
1002	Account Locations
1003	Users
1004	Products
1005	Work Orders

OriginalName string Identifies the original file name of the uploaded data import file.

ProcessingStart string Contains the date and time, in UTC format, when system started processing the data import file. This property will only be present in the document once processing has started.

ProcessingEnd string Contains the date and time, in UTC format, when the system completed processing of the data import file. This property will only be present in the document one processing has completed.

Results

object

Contains processing error messages.

Property Type Description

Success integer Contains the number of rows that were successfully processed.

Error

integer

Contains the number of rows that had processing errors.

If there errors with the Excel spreadsheet itself, Error may indicate 0 as the system was not able to start processing the individual rows.

Messages

array

Contains a separate message for each error that occurred during processing.

Property	Type	Description
Row	string	If an error occurred while processing a row, this property will be set to the actual row that contained an error. Otherwise, this property will not be present.
Text	string	Contains details of the error that occurred.

Size integer Identifies the size, in bytes, of the uploaded MS Excel spreadsheet.

Status

integer

Identifies the current processing status of the imported data file.

Valid values are:

1001 - Pending. The data file is waiting to be processed.
1002 - Processing . The data file is currently being processed.
1003 - Success.The data file processing has been complete successfully.
1004 - Error. Errors occurred during the processing of the data file.

If the Status is 1004, it is important to review the Results property to determine how many records were successfully processed.

SubmitDate string Contains the date and time, in UTC format, when the data import file was submitted for processing.