Working with Import API v2

The import functionality allows you to create or edit data in bulk in Collibra Data Intelligence Cloud.

When you import, you create or edit communities, domains, assets, mappings or complex relations and their characteristics such as attributes, relations and tags.

Note All Import API operations require authentication. For instructions, see the Collibra REST API authentication tutorial.

Import REST API endpoints and parameters

You can import communities, domains, assets, mappings and complex relations using the following endpoints:

/import/json-job
/import/csv-job
/import/excel-job

Mandatory parameters

You must provide the following parameters:

Parameter	Parameter type	Description
fileId	String (UUID)	The universally unique identifier (UUID) of a file previously uploaded to Collibra Data Intelligence Cloud.
file	String (binary)	The JSON, CSV or Excel file. During the import, CSV and Excel files are converted to JSON.
template	String	The JSON template interprets the tabular data for CSV and Excel files.

Warning You cannot provide both fileId and file in the same call because the operation will fail. Use only one of the two options.

Optional import parameters

The following table summarizes additional Import API v2 POST parameters:

Parameter	Parameter type	Description
batchSize	Integer	The number of import commands handled in a batch, between `1` and `50000`. The default value is :`10000`.
fileName	String	The name the file will receive once uploaded to Collibra. The default value is `import_file`.
sendNotification	Boolean	Whether notifications about the import job should be sent. The default value is `false`.
synchronizationId	String (UUID)	The synchronization ID of the operation.

Tip

To avoid possible performance issues:

Disable indexing and hyperlinking calculations before starting import or synchronization operations that handle large volumes of data.
Restrict import jobs to a maximum of 50 000 resources (communities, domains, assets, complex relations or mappings) and 500 000 additional characteristics (attributes, relations or tags).

Additional resources

Read the Getting Started with the Import API tutorial.
Consult the Collibra REST Import API documentation provided with your version of Collibra Data Intelligence Cloud at https://<your_collibra_platform_url>/docs/rest-importer/index.html.