SmartConnect 2018

Classes returned by the WCF REST service

MapList : List<MapListItem>

 

MapListItem

Field Name

Type

Description

MapId

string

The id of the map.

MapDescription

string

The description of the map.

 

 

MapColumnList : List<ColumnListItem>

 

ColumnListItem

Field Name

Type

Description

ColumnName

string

The technical name of the column.

IsRequired

boolean

Returns true if the column is a key field on the map data source.

 

RunMapResponse

Field Name

Type

Description

ErrorCount

int

Number of documents that failed processing.

Errors

string

An xml data table containing run errors.

ErrorMessage

string

The last error message recorded by the map.

MapDescription

string

The map description.

MapId

string

The map id.

RecordCount

int

The number of documents in the data source.

RunNumber

long

The run number.

Status

RunMapStatus

The completed status of the map run.

 

RunMapAllResponse

Field Name

Type

Description

ErrorCount

int

Number of documents that failed processing.

Errors

string

An xml data table containing run errors.

MapDescription

string

The map description.

MapId

string

The map id.

RecordCount

int

The number of documents in the data source.

RunNumber

long

The run number.

Status

RunMapStatus

The completed status of the map run.

ValidationErrors

ValidationErrors

Errors that occurred in validation tasks.

 

RunMapXmlResponse

Field Name

Type

Description

ErrorCount

int

Number of documents that failed processing.

Errors

string

An xml data table containing run errors.

MapDescription

string

The map description.

MapId

string

The map id.

RecordCount

int

The number of documents in the data source.

RunNumber

long

The run number.

Status

RunMapStatus

The completed status of the map run.

OutputXml

string[]

An array of strings, each string contains the xml output for a single document.

 

 

ValidationErrors : List<ValidationError>

 

ValidationError

Field Name

Type

Description

Tenant

string

The technical name of the tenant where the validation error occurred.

TaskName

string

The name of the task that gave rise to the validation error.

ErrorDataType

ErrorDataType

Always set to ErrorDataType.ValidationErrors.

Xml

string

An xml data table containing the errors.