v1

latestOpenAPI 3.0.02026-08-064842333.5 MB
General

Insert Bulk Data From a File (async)

Creates a JST job (the LOADDATA_FILE type) for inserting multiple records to the Master Data table from a CSV file.<p> You can get the status of the job by calling the admin.fetchjst/{jstId} endpoint. The jstId can be found in the response of the /loaddata.file/{TypeCode}/async endpoint.<br> Allows parallel loaddata calls. You can also view the job in Administration > Logs > Jobs & Tasks.

The /loaddata operation is a very efficient and quick way to insert bulk data to the Master Data table. The main advantage is its greater speed when loading thousands of records (compared to e.g. /integrate).<p>

If used in a Groovy logic, it is recommended to use the api.addOrUpdate() method instead of this loaddata endpoint within the boundCall().<br> For more details see the Avoid api.boundCall article.

<p> <!-- theme: warning -->

Please note If no joinFields are provided in the request, then this operation will insert entire records. It means that in this case (without joinFields) with /loaddata.file it is not possible to update just some fields (for this use the /integrate endpoint instead). The source data must always contain the entire row’s content.

post/loaddata.file/{TypeCode}/async

Query parameters

namestring

The name of the table you want to upload a file to.

Response

OK