COcollibra
Import

Starts import from the CSV file in job (asynchronously).

Starts import from the CSV file in job (asynchronously).

<br/><p>Request can either accept <code>id</code> of the uploaded file that contains CSV input which should be used for import - or the file itself.</p>

post/import/csv-job

Request

Request body multipart/form-data

sendNotificationboolean

Whether job status notification should be sent. <b>The default value</b> is <code>false</code>.

batchSizeinteger

<i>The batchSize parameter is now deprecated and is ignored during command execution.</i>

simulationboolean

Whether the import should be triggered as a simulation. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.<p><b>This parameter does not apply to synchronization requests.</b> It is only relevant for import and ignored for synchronization methods.

saveResultboolean

Whether the import Result should be persisted or forgotten. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the list of added/updated/removed resources will be stored in the job message.<p>If the resulting job message is too long, no resource information will be stored.<p><b>DEPRECATED:</b>This parameter is deprecated and will be removed in the future.</b>.

fileIdstring uuid

The <code>id</code> of uploaded file.<p><b>NOTE:</b> if this field is used, <code>file</code> should not be set.

filestring binary

The file to upload. If set, then also <code>fileName</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set.

fileNamestring

The name of the file to upload. If set, then also <code>file</code> should be provided.<p><b>NOTE:</b> if this field is used, <code>fileId</code> should not be set.

deleteFileboolean

Delete the file from the Collibra Platform if the import / synchronization job is successful. <b>The default value</b> is <code>false</code><p><b>NOTE:</b> if the file corresponds to an attachment, the attachment will be deleted.

continueOnErrorboolean

Whether the import should continue if some of the import commands are invalid or failed to execute. <b>The default value</b> is <code>false</code>.<p>If <code>true</code>, the valid commands are still committed to the database, which can lead to partial results being stored.

relationsActionstring

Should all existing relations for the specified relation types be replaced or should the import only add new relations. Possible values are: <b>ADD_OR_IGNORE</b> and <b>REPLACE</b>. The default value is: <b>REPLACE</b>.

attributesActionstring

Should all existing attributes for the specified attribute types be replaced or should the import only add new attributes whose value didn't exist yet. Possible values are: <b>ADD_OR_IGNORE</b> and <b>REPLACE</b>. The default value is: <b>REPLACE</b>.

separatorstring required

The delimiter character used to separate entries. <b>The default value</b> is <code>';'</code>.

quotestring required

The delimiter character used for quoted entries. <b>The default value</b> is <code>'"'</code>.

escapestring required

The delimiter character used to escape separator or quote character. <b>The default value</b> is <code>'\'</code>.

strictQuotesboolean

Whether the characters outside quotes should be ignored. <b>The default value</b> is <code>false</code>.

ignoreLeadingWhitespaceboolean

Whether whitespace characters before quotes should be ignored. <b>The default value</b> is <code>false</code>.

headerRowboolean

Whether the first row of the imported CSV file is the header. <b>The default value</b> is <code>false</code>.

templatestring required

The template that should be used for parsing and importing the contents of the CSV file.

<br/><p>There is one placeholder currently supported:

<ul> <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li> </ul> <p>Example of a correct JSON template:</p> <pre> [ { "resourceType": "Asset", "identifier": { "name": "${1}", "domain": { "name": "${2}", "community": { "name": "Some Community" } } }, "attributes" : { "00000000-0000-0000-0000-000000003115" : [ { "value" : "${3}" } ], "00000000-0000-0000-0000-000000000222" : [ { "value" : "${4}" } ] } } ] </pre>

Response

Import job successfully started.

idstring uuid required
createdBystring uuid required
createdOnstring date-time required
startDatestring date-time required
endDatestring date-time
status'Waiting' | 'Running' | 'Completed' | 'Failed' required
reportobject

Changes

No recorded changes to this operation across all 1 revision of this API.