UpsertData-Async

post

https://api.dengage.com/rest/dataspace/async/upsert

UpsertData-Async

There are two versions of UpsertData API calls, synchronous and asynchronous. This particular version is the asynchronous version where more than 1000 records rows are subject to be inserted/updated on a data table in a single call.

The method is used to insert bulk new records or update existing ones on a data table except master_contact table.

This method should be called once a minute for a specific table with a single request!

If the target data table has primary key values, UpsertData call has to include these primary key values in input data rows as well as the rest of the to-be-updated column values.

If the target data table has no primary key values, UpsertData appends input data rows to the data table.

Input data row has to include all the column values of the target data table, otherwise an error will be returned.

The difference between the synchronous version and asynchronous version of this call is that Asynchronous version returns the uuid of the upsert job started. The status and the result of the on-going UpsertData jobs must be queried with GetStatus API call.

The maximum request size limit is 50mb.

DateTime Format:

* yyyy-MM-dd
* yyyy-MM-dd HH:mm
* yyyy-MM-ddTHH:mm
* yyyy-MM-dd HH:mm:ss
* yyyy-MM-ddTHH:mm:ss
* yyyy-MM-dd HH:mm:ss.f
* yyyy-MM-dd HH:mm:ss.ff
* yyyy-MM-dd HH:mm:ss.fff
* yyyy-MM-ddTHH:mm:ss.f
* yyyy-MM-ddTHH:mm:ss.ff
* yyyy-MM-ddTHH:mm:ss.fff
* yyyy-MM-ddTHH:mm:ssZ

Body Params

tableId OR tableName is required.

columnMapping

array of objects

Mapping between the table columns and the columns in the file header.

Please note that the columns in the file header must be separated with either ; or ,

columnMapping

fileContent

string

The base64 encoded content of the complete file. The first line of the file must include headers separated by ; or ,

tableColumn and fileColumnHeader are the fields that map table column and the column in the file together.

If tableColumn is used and fileColumnHeader is omitted or set to null, the constant value is assigned to the column in tableColumn.

jobName

string

This is an optional field. It names the async delete job.

overwriteEmptyValues

boolean

The value will overwrite table value with empty text if file contains empty values

tableId

string

The uuid of the table. Either tableId or tableName is required.

tableName

string

The name of the table. Either tableId or tableName is required.

Headers

Authorization

string

required

Defaults to {$$.env.access_token}

Responses

401

Not-authenticated. Please re-login.

200The operation is successful and the async upsert request has been sent to the system. This request returns a job id assigned to this async upsert job. Please use this jobId to check the status of your job.

400Bad request. This can occur due to several reasons:

403The operation is not allowed. Your api user is not authorized to use this api.

404The table is not found.