ManageEngine Analytics Plus Client APIImportResult

ImportResult contains the result of an import operation.

Summary

Methods

Properties

Constants

getImportType()
getTotalColumnCount()
getSelectedColumnCount()
getTotalRowCount()
getSuccessRowCount()
getRowWithWarningCount()
getImportOperation()
getImportErrors()
getImportedColumns()
getColumnDataType()
toString()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$import_type
$total_column_count
$selected_column_count
$total_row_count
$success_row_count
$warnings
$import_operation
$import_errors
$column_details

N/A

Properties

$import_type

$import_type : string

Type

string — The type of the import operation.

$total_column_count

$total_column_count : integer

Type

integer — The total columns that were present in the imported file.

$selected_column_count

$selected_column_count : integer

Type

integer — The number of columns that were imported.See ZOHO_SELECTED_COLUMNS parameter.

$total_row_count

$total_row_count : \long

Type

long — The total row count in the imported file.

$success_row_count

$success_row_count : \long

Type

long — The number of rows that were imported successfully without errors.

$warnings

$warnings : string

Type

string — The number of rows that were imported with warnings.

$import_operation

$import_operation : string

Type

string — The type of import operation.

$import_errors

$import_errors : string

Type

string — The first 100 import errors.

$column_details

$column_details : string

Type

string — The column names of the imported columns.

Methods

getImportType()

getImportType() : string

Get the type of the import operation.

Returns

string —

The type of the import operation.

getTotalColumnCount()

getTotalColumnCount() : integer

Get the total columns that were present in the imported file.

Returns

integer —

The total columns that were present in the imported file.

getSelectedColumnCount()

getSelectedColumnCount() : integer

Get the number of columns that were imported.See ZOHO_SELECTED_COLUMNS parameter.

Returns

integer —

The number of columns that were imported.

getTotalRowCount()

getTotalRowCount() : long

Get the total row count in the imported file.

Returns

long —

The total row count in the imported file.

getSuccessRowCount()

getSuccessRowCount() : long

Get the number of rows that were imported successfully without errors.

Returns

long —

The number of rows that were imported successfully without errors.

getRowWithWarningCount()

getRowWithWarningCount() : long

Get the number of rows that were imported with warnings. Applicable if ZOHO_ON_IMPORT_ERROR parameter has been set to SETCOLUMNEMPTY.

Returns

long —

The number of rows that were imported with warnings.

getImportOperation()

getImportOperation() : string

Get the type of import operation. Can be either.

created --> if the specified table has been created. For this ZOHO_CREATE_TABLE parameter should have been set to true or updated --> if the specified table already exists.

Returns

string —

The type of import operation.

getImportErrors()

getImportErrors() : string

Get the first 100 import errors. Applicable if ZOHO_ON_IMPORT_ERROR parameter is either SKIPROW or SETCOLUMNEMPTY. In case of ABORT , ServerException is thrown.

Returns

string —

The first 100 import errors.

getImportedColumns()

getImportedColumns() : string

Get the column names of the imported columns.

Returns

string —

The imported column names.

getColumnDataType()

getColumnDataType(string  $column_name) : string

Get the data type of the specified column.

Parameters

string

$column_name

Name of the column.

Returns

string —

The column datatype.

toString()

toString() : string

Get the complete response content as sent by the server.

Returns

string —

The complete response content.