Blue Web Services For Data Sync

The following functions are specifically designed to assist clients with importing data into the Blue database.

BaseResponse2 PushObjectDataV2(DataObjectTransfertRequestV2 TransferRequest)

This function is used to push external data and store it temporarily in the Blue database. There is no validation or transformation of data.

NOTE

Supports all type of data blocks (primary, row, extension, relation)
Introduced in version 7.10 of Blue.

Inputs: DataObjectTransfertRequestV2

RegisterImportRequest Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value used to authorize the access of this web function.
TransactionID: long	Message Header	The transaction id of sync process
ColumnNamesList: List	Message Header	The list of column name in a data block
DataBlockName: string	Message Header	The name of data block that pushing data
Data: List	Message Body Member	The pushed data.

Outputs: BaseResponse2

RegisterImportResponse Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value that indicates whether the API key is valid.
Message: string	Message Body Member	Returns 'Success' if all processes (including API key validation) were created successfully, otherwise returns an error code.
Result: bool	Message Body Member	Either the result is a success (true) or a failure (false)
HasWarningMessage: bool	Message Body Member	If the result is success, it will let know if there is a warning message or not

BaseResponse2 PushStreamDataV2(DataStreamTransfertRequestV2 TransferRequest)

This function is same as PushObjectDataV2, the only difference is that the format of the data that receives is a stream.

Inputs: DataStreamTransfertRequestV2

RegisterImportRequest Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value used to authorize the access of this web function.
TransactionID: long	Message Header	The transaction id of sync process
ColumnNamesList: List	Message Header	The list of column name in a data block
DataBlockName: string	Message Header	The name of data block that pushing data
Data: Stream	Message Body Member	The pushed data.

Outputs: BaseResponse2

RegisterImportResponse Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value that indicates whether the API key is valid.
Message: string	Message Body Member	Returns 'Success' if a transaction ID was created successfully, otherwise returns an error code.
Result: bool	Message Body Member	Either the result is a success (true) or a failure (false)
HasWarningMessage: bool	Message Body Member	If the result is success, it will let know if there is a warning message or not

BaseResponse2 PrepareDataToFinalizeImportV2(BasicRequest Request)

This function is used to validate and transform and update (if necessary) the data that was pushed into web service. Basically this function will be used after PushObjectDataV2 or PushStreamDataV2.

Inputs: BasicRequest

RegisterImportRequest Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value used to authorize the access of this web function.
TransactionID: long	Message Header	The transaction id of sync process

Outputs: BaseResponse2

RegisterImportResponse Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value that indicates whether the API key is valid.
Message: string	Message Body Member	Returns 'Success' if a transaction ID was created successfully, otherwise returns an error code.
Result: bool	Message Body Member	Either the result is a success (true) or a failure (false)
HasWarningMessage: bool	Message Body Member	If the result is success, it will let know if there is a warning message or not

RegisterImportResponse RegisterImport(RegisterImportRequest registerRequest)

Used to create a new transaction ID for managing the data import process.

Inputs: RegisterImportRequest

RegisterImportRequest Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value used to authorize the access of this web function.
DataSourceID: string	Message Header	The datasource ID for the imported data.

Outputs: RegisterImportResponse

RegisterImportResponse Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value that indicates whether the API key is valid.
TransactionID: long	Message Header	Represents the current import transaction. Used later as an input parameter when executing and finalizing the data import. A TransactionID of 0 indicates that the there was an error and a transaction ID was not created.
Message: string	Message Header	Returns 'Success' if a transaction ID was created successfully, otherwise returns an error code.

BaseResponse ExecuteDataObjectImport(DataObjectTransferRequest transferRequest)

Used to transfer data to the web service when data is wrapped in a data object.

NOTE

In IIS7, the ‘Maximum Allowed Content Length’ setting in Request Filter settings defaults to 30000000 bytes. A 404.13 error indicates that the data being imported exceeds that value.

Inputs: DataObjectTransferRequest

DataObjectTransferRequest Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value used to authorize the access of this web function.
TransactionID: string	Message Header	A value that indicates the current transaction.
IncrementalImport: Boolean	Message Header	A true or false value indicates whether this request is part of a previous import request. This is used when importing large data sets that must be broken into smaller chunks.
Data: IDataRow[]	Message Member	The actual data.
ColumnName: string []	Message Header	The column names of the actual data.
ColumnType: string []	Message Header	The types of each data column.

iDataRow Data Structure

Properties	Attribute Type	Description
IDataRowValue: IDataObj[]		A list of IDataObj. Each IDataRow represents one data row record in the datasource table.

iDataObj Data Structure

Properties	Attribute Type	Description
IDataObjValue: string		Each IDataObj represents one column value of one data row in the datasource table.

Outputs: BaseResponse

BaseResponse Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value that indicates whether the API key is valid.
Message: string	Message Header	Returns 'Success' if the data transfer was successful, otherwise returns an error code.

BaseResponse ExecuteDataFileImport(DataStreamTransferRequest transferRequest)

Used to transfer data to the web service when the data is wrapped in a CSV file.

Inputs: DataStreamTransferRequest

DataStreamTransferRequest Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value used to authorize the access of this web function.
TransactionID: string	Message Header	A value that indicates the current transaction.
IncrementalImport: bool	Message Header	A true or false value indicates whether this request is an incremental import to previous request. This is used when client import large data. Therefore, the data has to be break into small chunks.
Data: Stream (File Stream)	Message Member	The actual data.
ColumnName: string []	Message Header	The column names of the actual data.
ColumnType: string []	Message Header	The types of each data column.

Outputs: BaseResponse

BaseResponse Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value that indicates whether the API key is valid.
Message: string	Message Header	Returns 'Success' if the data transfer was successful, otherwise returns an error code.

BaseResponse ExecuteDataStreamImport(DataStreamTransferRequest transferRequest)

Used to transfer data to the web service when data is wrapped in a data stream.

Inputs: DataStreamTransferRequest

DataStreamTransferRequest Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value used to authorize the access of this web function.
TransactionID: string	Message Header	A value that indicates the current transaction.
IncrementalImport: bool	Message Header	A true or false value indicates whether this request is an incremental import to previous requests. This is used when client import large data. Therefore, the data has to be break into small chunks.
Data: Stream (Memory Stream)	Message Member	The actual data.
ColumnName: string []	Message Header	The column names of the actual data.
ColumnType: string []	Message Header	The types of each data column.

Outputs: BaseResponse

BaseResponse Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value that indicates whether the API key is valid.
Message : string	Message Header	Returns 'Success' if the data transfer was successful, otherwise returns an error code.

BaseResponse FinalizeImport(FinalizeImportRequest FinalizeRequest)

Used to finalize the data import process.

NOTE

When the datasource being imported does not contain any data, this function will return a message that indicates the empty datasource cannot be imported.

Inputs: FinalizeImportRequest

FinalizeImportRequest Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value used to authorize the access of this web function.
TransactionID: string	Message Header	A value that indicates the current transaction.

Outputs: BaseResponse

BaseResponse Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value that indicates whether the API key is valid.
Message: string	Message Header	Returns 'Success' if the data import was successfully finalized, otherwise returns an error code.

BaseResponse CancelImport(CancelImportRequest cancelRequest)

Used to cancel the data import process.

Inputs: CancelImportRequest

CancelImportRequest Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value used to authorize the access of this web function.
TransactionID: string	Message Header	A value indicates the current transaction.

Outputs: BaseResponse

BaseResponse Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value that indicates whether the API key is valid.
Message: string	Message Header	Returns 'Success' if the data import was successfully canceled, otherwise returns an error code.

DataSourceResponse GetDataSourceList(BaseRequest request)

Used to get the available datasource list in Blue.

Inputs: BaseRequest

BaseRequest Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value used to authorize the access of this web function.

Outputs: DataSourceResponse

DataSourceResponse Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value that indicates whether the API key is valid.
Message : string	Message Header	Returns 'Success' if the datasource list was successfully retrieved, otherwise returns an error code.
DataSources: Array of IDataSource	Message Body Member	Datasource array.

DataSourceSchemaResponse GetDataSourceSchemaColumns(DataSourceSchemaRequest request)

Used to get the datasource schema information from the latest transaction.

Inputs: DataSourceSchemaRequest

DataSourceSchemaRequest Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value used to authorize the access of this web function.
SourceId: string	Message Body Member	The ID of datasource to retrieve schema.

Outputs: DataSourceSchemaResponse

DataSourceSchemaResponse Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value that indicates whether the API key is valid.
Message : string	Message Header	Returns 'Success' if the datasource schema was successfully retrieved, otherwise returns an error code.
Columns: Array of IDataSourceSchema	Message Body Member	Array of datasource schema.

BaseResponse SendDataImportResultEmail(SendEmailRequest emailRequest)

Used to email the results of the data import transaction process.

NOTE

Make sure that the email settings are configured in the Blue Administration Console, otherwise, this function will not send email.

Inputs: SendEmailRequest

SendEmailRequest Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value used to authorize the access of this web function.
DataSourceID: string	Message Header	The ID of the datasource where data is being imported.
EmailType: int	Message Header	1 sends a success email, 2 send a failure email.

Outputs: BaseResponse

BaseResponse Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value that indicates whether the API key is valid.
Message : string	Message Header	Returns 'Success' if the email was successfully sent, otherwise returns an error code.

FileStreamDownloadResponse ExportData(FileStreamDownloadRequest request)

Used to export the imported data of a specific datasource.

Inputs: FileStreamDownloadRequest

FileStreamDownloadRequest Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value used to authorize the access of this web function.
DataSourceId: string	Message Body Member	The ID of datasource.
DataSourceType: string	Message Body Member	Datasource type (user, object, relation or field filter).
DataSourceFields: List	Message Body Member	The list of fields in the datasource to export.

Outputs: FileStreamDownloadResponse

FileStreamDownloadResponse Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value that indicates whether the API key is valid.
Length : long	Message Header	The size of the file to export.
FileByteStream: stream	Message Body Member	The data stream of the file being exported.

ProgressStatusResponse GetProgressStatus(ProgressStatusRequest request)

Used to retrieve the status of a specific datasource.

Inputs: ProgressStatusRequest

ProgressStatusRequest Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value used to authorize the access of this web function.
DataSourceId: string	Message Body Member	The ID of the datasource.

Outputs: ProgressStatusResponse

ProgressStatusResponse Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value that indicates whether the API key is valid.
ProgressStatus: int	Message Body Member	The percent completed of the datasource import process. The value is -1 if the API key is not valid or if the progress could not be retrieved.
TransactionId: long	Message Body Member	The transaction ID of the datasource import process. The value is -1 if the API key is not valid or if the transaction ID could not be retrieved.
DataSourceId: string	Message Body Member	The datasource ID. The value is empty if the API key is not valid or if the datasource ID could not be retrieved.

ProgressStatusResponse GetCurrentImportingDataSourceProcess(BaseRequest request)

Used to retrieve the information about the datasource which is currently processing the datasource import.

Inputs: BaseRequest

BaseRequest Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value used to authorize the access of this web function.

Outputs: ProgressStatusResponse

ProgressStatusResponse Structure

Properties	Attribute Type	Description
APIKeyHeader: String	Message Header	A value that indicates whether the API key is valid.
ProgressStatus : int	Message Body Member	The percentage of progress of datasource import process. The value is -1 if the API key is not valid or failed to get the progress status.
TransactionId: long	Message Body Member	The transaction ID of the datasource import process. The value is -1 if the API key is not valid or failed to get the transaction ID.
DataSourceId: string	Message Body Member	The ID of the datasource. The value is empty if the API key is not valid or if the datasource ID could not be retrieved.

BaseResponse TestWebService(BaseRequest request)

Used to verify that the web service is available.

Inputs: BaseRequest

BaseRequest Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value used to authorize the access of this web function.

Outputs: BaseResponse

BaseResponse Structure

Properties	Attribute Type	Description
APIKeyHeader: string	Message Header	A value that indicates whether the API key is valid.
Message : string	Message Header	Returns 'Success' if the web service is available, otherwise returns an error code.