Import

Large volume import operations

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

post

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

Request can either accept id of the uploaded file that contains CSV input which should be used for import - or the file itself.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Body

sendNotificationbooleanOptional

Whether job status notification should be sent. The default value is false.

Default: false

batchSizeinteger · int32 · min: 1OptionalDeprecated

The batchSize parameter is now deprecated and is ignored during command execution.

Default: 1000

simulationbooleanOptional

Whether the import should be triggered as a simulation. The default value is false.

If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.

This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.

Default: false

saveResultbooleanOptionalDeprecated

Whether the import Result should be persisted or forgotten. The default value is false.

If true, the list of added/updated/removed resources will be stored in the job message.

If the resulting job message is too long, no resource information will be stored.

DEPRECATED:This parameter is deprecated and will be removed in the future..

Default: false

fileIdstring · uuidOptional

The id of uploaded file.

NOTE: if this field is used, file should not be set.

filestring · binaryOptional

The file to upload. If set, then also fileName should be provided.

NOTE: if this field is used, fileId should not be set.

fileNamestringOptional

The name of the file to upload. If set, then also file should be provided.

NOTE: if this field is used, fileId should not be set.

Default: import_file

deleteFilebooleanOptional

Delete the file from the Collibra Platform if the import / synchronization job is successful. The default value is false

NOTE: if the file corresponds to an attachment, the attachment will be deleted.

Default: false

continueOnErrorbooleanOptional

Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.

If true, the valid commands are still committed to the database, which can lead to partial results being stored.

Default: false

relationsActionstringOptional

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

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

attributesActionstringOptional

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: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

separatorstringRequired

The delimiter character used to separate entries. The default value is ';'.

Default: ;

quotestringRequired

The delimiter character used for quoted entries. The default value is '"'.

Default: "

escapestringRequired

The delimiter character used to escape separator or quote character. The default value is '\'.

Default: \

strictQuotesbooleanOptional

Whether the characters outside quotes should be ignored. The default value is false.

Default: false

ignoreLeadingWhitespacebooleanOptional

Whether whitespace characters before quotes should be ignored. The default value is false.

Default: false

headerRowbooleanOptional

Whether the first row of the imported CSV file is the header. The default value is false.

Default: false

templatestring · min: 1Required

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

There is one placeholder currently supported:

${x} - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)

Example of a correct JSON template:

[
  {
    "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}"
      } ]
    }
  }
]

Responses

200

Import job successfully started.

application/json

Represents a job. Job is a single atomic task that is to be performed asynchronously

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

namestringOptional

The name of the resource.

Example: Test name

typestringOptional

The type of the job.

Example: IMPORT

userIdstring · uuidOptional

The ID of the user that initiated this job.

visibilityinteger · int32Optional

The visibility of the job.

progressPercentagenumber · doubleOptional

The progress percentage of the job.

Example: 50

cancelablebooleanOptional

Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted.

startDateinteger · int64Optional

The start date of the job.

Example: 1488016800

endDateinteger · int64Optional

The end date of the job.

Example: 1488021800

statestring · enumOptional

The state of the job.

Example: COMPLETEDPossible values:

resultstring · enumOptional

The result of the job.

Example: SUCCESSPossible values:

messagestringOptional

The message of the job.

Example: Import finished in 12s.

post/import/csv-job

POST /rest/2.0/import/csv-job HTTP/1.1
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 366

{
  "sendNotification": false,
  "simulation": false,
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "file": "binary",
  "fileName": "import_file",
  "deleteFile": false,
  "continueOnError": false,
  "relationsAction": "REPLACE",
  "attributesAction": "REPLACE",
  "separator": ";",
  "quote": "\"",
  "escape": "\\",
  "strictQuotes": false,
  "ignoreLeadingWhitespace": false,
  "headerRow": false,
  "template": "text"
}

200

Import job successfully started.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "type": "IMPORT",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "visibility": 1,
  "progressPercentage": 50,
  "cancelable": true,
  "startDate": 1488016800,
  "endDate": 1488021800,
  "state": "COMPLETED",
  "result": "SUCCESS",
  "message": "Import finished in 12s."
}

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

post

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

Request can either accept id of the uploaded file that contains Excel input which should be used for import - or the file itself.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Body

sendNotificationbooleanOptional

Whether job status notification should be sent. The default value is false.

Default: false

batchSizeinteger · int32 · min: 1OptionalDeprecated

The batchSize parameter is now deprecated and is ignored during command execution.

Default: 1000

simulationbooleanOptional

Whether the import should be triggered as a simulation. The default value is false.

If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.

This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.

Default: false

saveResultbooleanOptionalDeprecated

Whether the import Result should be persisted or forgotten. The default value is false.

If true, the list of added/updated/removed resources will be stored in the job message.

If the resulting job message is too long, no resource information will be stored.

DEPRECATED:This parameter is deprecated and will be removed in the future..

Default: false

fileIdstring · uuidOptional

The id of uploaded file.

NOTE: if this field is used, file should not be set.

filestring · binaryOptional

The file to upload. If set, then also fileName should be provided.

NOTE: if this field is used, fileId should not be set.

fileNamestringOptional

The name of the file to upload. If set, then also file should be provided.

NOTE: if this field is used, fileId should not be set.

Default: import_file

deleteFilebooleanOptional

Delete the file from the Collibra Platform if the import / synchronization job is successful. The default value is false

NOTE: if the file corresponds to an attachment, the attachment will be deleted.

Default: false

continueOnErrorbooleanOptional

Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.

If true, the valid commands are still committed to the database, which can lead to partial results being stored.

Default: false

relationsActionstringOptional

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

attributesActionstringOptional

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

sheetNamestringOptional

The name of the Excel sheet

If the name is null and sheetIndex is null, the first sheet of the workbook will be used for the import.

If the name is null and sheetIndex is not null, the sheet with the index specified by value of sheetIndex will be used for the import.

sheetIndexinteger · int32Optional

The index of the Excel sheet

If the index is null and sheetName is null, the first sheet of the workbook will be used for the import.

If the index is null and sheetName is not null, the sheet with the name specified by value of sheetName will be used for the import.

headerRowbooleanOptional

Whether the first row of the imported Excel sheet is the header. The default value is false.

Default: false

templatestring · min: 1Required

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

    <br/><p>There is one placeholder currently supported:
    <ul>
         <li><b>${x}</b> - refers to the n-th column in the Excel 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>

Responses

200

Import job successfully started.

application/json

Represents a job. Job is a single atomic task that is to be performed asynchronously

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

typestringOptional

The type of the job.

Example: IMPORT

userIdstring · uuidOptional

The ID of the user that initiated this job.

visibilityinteger · int32Optional

The visibility of the job.

progressPercentagenumber · doubleOptional

The progress percentage of the job.

Example: 50

cancelablebooleanOptional

Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted.

startDateinteger · int64Optional

The start date of the job.

Example: 1488016800

endDateinteger · int64Optional

The end date of the job.

Example: 1488021800

statestring · enumOptional

The state of the job.

Example: COMPLETEDPossible values:

resultstring · enumOptional

The result of the job.

Example: SUCCESSPossible values:

messagestringOptional

The message of the job.

Example: Import finished in 12s.

post/import/excel-job

POST /rest/2.0/import/excel-job HTTP/1.1
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 304

{
  "sendNotification": false,
  "simulation": false,
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "file": "binary",
  "fileName": "import_file",
  "deleteFile": false,
  "continueOnError": false,
  "relationsAction": "REPLACE",
  "attributesAction": "REPLACE",
  "sheetName": "text",
  "sheetIndex": 1,
  "headerRow": false,
  "template": "text"
}

200

Import job successfully started.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "type": "IMPORT",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "visibility": 1,
  "progressPercentage": 50,
  "cancelable": true,
  "startDate": 1488016800,
  "endDate": 1488021800,
  "state": "COMPLETED",
  "result": "SUCCESS",
  "message": "Import finished in 12s."
}

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

post

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

Request can either accept id of the uploaded file that contains JSON input which should be used for import - or the file itself.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Body

sendNotificationbooleanOptional

Whether job status notification should be sent. The default value is false.

Default: false

batchSizeinteger · int32 · min: 1OptionalDeprecated

The batchSize parameter is now deprecated and is ignored during command execution.

Default: 1000

simulationbooleanOptional

Whether the import should be triggered as a simulation. The default value is false.

If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.

This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.

Default: false

saveResultbooleanOptionalDeprecated

Whether the import Result should be persisted or forgotten. The default value is false.

If true, the list of added/updated/removed resources will be stored in the job message.

If the resulting job message is too long, no resource information will be stored.

DEPRECATED:This parameter is deprecated and will be removed in the future..

Default: false

fileIdstring · uuidOptional

The id of uploaded file.

NOTE: if this field is used, file should not be set.

filestring · binaryOptional

The file to upload. If set, then also fileName should be provided.

NOTE: if this field is used, fileId should not be set.

fileNamestringOptional

The name of the file to upload. If set, then also file should be provided.

NOTE: if this field is used, fileId should not be set.

Default: import_file

deleteFilebooleanOptional

Delete the file from the Collibra Platform if the import / synchronization job is successful. The default value is false

NOTE: if the file corresponds to an attachment, the attachment will be deleted.

Default: false

continueOnErrorbooleanOptional

Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.

If true, the valid commands are still committed to the database, which can lead to partial results being stored.

Default: false

relationsActionstringOptional

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

attributesActionstringOptional

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

allowEmptyAttributeValuesbooleanOptional

Whether empty attribute values should be allowed during import. The default value is false.

When false (default), attribute values that are empty or blank are filtered out and not imported. When true, empty attribute values are preserved and imported as-is.

Default: false

Responses

200

Import job successfully started.

application/json

Represents a job. Job is a single atomic task that is to be performed asynchronously

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

typestringOptional

The type of the job.

Example: IMPORT

userIdstring · uuidOptional

The ID of the user that initiated this job.

visibilityinteger · int32Optional

The visibility of the job.

progressPercentagenumber · doubleOptional

The progress percentage of the job.

Example: 50

cancelablebooleanOptional

Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted.

startDateinteger · int64Optional

The start date of the job.

Example: 1488016800

endDateinteger · int64Optional

The end date of the job.

Example: 1488021800

statestring · enumOptional

The state of the job.

Example: COMPLETEDPossible values:

resultstring · enumOptional

The result of the job.

Example: SUCCESSPossible values:

messagestringOptional

The message of the job.

Example: Import finished in 12s.

post/import/json-job

POST /rest/2.0/import/json-job HTTP/1.1
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 268

{
  "sendNotification": false,
  "simulation": false,
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "file": "binary",
  "fileName": "import_file",
  "deleteFile": false,
  "continueOnError": false,
  "relationsAction": "REPLACE",
  "attributesAction": "REPLACE",
  "allowEmptyAttributeValues": false
}

200

Import job successfully started.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "type": "IMPORT",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "visibility": 1,
  "progressPercentage": 50,
  "cancelable": true,
  "startDate": 1488016800,
  "endDate": 1488021800,
  "state": "COMPLETED",
  "result": "SUCCESS",
  "message": "Import finished in 12s."
}

Removes all cache entries corresponding to the provided synchronization id.

delete

Removes all cache entries corresponding to the provided synchronization id.

The synchronization component is optimized to only execute commands that differ from cycle to cycle. Call this method to clear the command cache and force the execution of all commands in this cycle.

Note: this operation does not stop the tracking of the resources identified by the provided synchronization id. The next synchronization process usingthe same id will still be able to detect resources that should be removed.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

synchronizationIdstringRequired

The synchronization id of the operation.

Responses

204

Synchronization cache entries successfully removed.

No content

delete/import/synchronize/{synchronizationId}/evict

DELETE /rest/2.0/import/synchronize/{synchronizationId}/evict HTTP/1.1
Authorization: Basic username:password
Accept: */*

204

Synchronization cache entries successfully removed.

No content

Checks whether given synchronization id already exists.

get

Checks whether given synchronization id already exists.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

synchronizationIdstringRequired

The synchronization id of the operation.

Responses

200

Returns true if synchronization id already exists, false otherwise.

application/json

booleanOptional

get/import/synchronize/exists/{synchronizationId}

GET /rest/2.0/import/synchronize/exists/{synchronizationId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

Returns true if synchronization id already exists, false otherwise.

true

Returns synchronization information matching the given search criteria.

get

Returns synchronization information matching the given search criteria.

Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored.

The returned synchronization information satisfies all constraints that are specified in this search criteria. By default a result containing 1000 synchronization infos is returned.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters

offsetinteger · int32Optional

The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0

limitinteger · int32Optional

The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.

Default: 0

countLimitinteger · int32Optional

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

Default: -1

Responses

200

The paged response with found synchronization information.

application/json

Response containing the paged information.

totalinteger · int64Optional

The total number of results.

Example: 1000

offsetinteger · int64Optional

The offset for the results.

Example: 10

limitinteger · int64Optional

The maximum number of results to be returned.

Example: 100

get/import/synchronize

GET /rest/2.0/import/synchronize HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

The paged response with found synchronization information.

{
  "total": 1000,
  "offset": 10,
  "limit": 100,
  "results": [
    {
      "synchronizationId": "ABCDEF123456789"
    }
  ]
}

Removes all information about synchronization process corresponding to provided synchronization id.

delete

Removes all information about synchronization process corresponding to provided synchronization id.

This operation stops tracking of synchronization identified by provided synchronization id. The next synchronization process specified with this id will not be able to detect resources that should be removed.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

synchronizationIdstringRequired

The synchronization id of the operation.

Responses

204

Synchronization successfully untracked.

No content

delete/import/synchronize/{synchronizationId}

DELETE /rest/2.0/import/synchronize/{synchronizationId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

204

Synchronization successfully untracked.

No content

Starts batch synchronization from the CSV file in job (asynchronously).

post

Starts batch synchronization from the CSV file in job (asynchronously).

Request can either accept id of the uploaded file that contains CSV input which should be used for import or the file itself. The input file is treated as a part (batch) of synchronization process. After last batch, finalization (cleanup) process should be called.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

synchronizationIdstring · min: 1 · max: 50Required

The synchronization id used to distinguish different synchronizations.

Body

sendNotificationbooleanOptional

Whether job status notification should be sent. The default value is false.

Default: false

batchSizeinteger · int32 · min: 1OptionalDeprecated

The batchSize parameter is now deprecated and is ignored during command execution.

Default: 1000

simulationbooleanOptional

Whether the import should be triggered as a simulation. The default value is false.

If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.

This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.

Default: false

saveResultbooleanOptionalDeprecated

Whether the import Result should be persisted or forgotten. The default value is false.

If true, the list of added/updated/removed resources will be stored in the job message.

If the resulting job message is too long, no resource information will be stored.

DEPRECATED:This parameter is deprecated and will be removed in the future..

Default: false

fileIdstring · uuidOptional

The id of uploaded file.

NOTE: if this field is used, file should not be set.

filestring · binaryOptional

The file to upload. If set, then also fileName should be provided.

NOTE: if this field is used, fileId should not be set.

fileNamestringOptional

The name of the file to upload. If set, then also file should be provided.

NOTE: if this field is used, fileId should not be set.

Default: synchronization_file

deleteFilebooleanOptional

Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.

NOTE: if the file corresponds to an attachment, the attachment will be deleted.

Default: false

continueOnErrorbooleanOptional

Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.

If true, the valid commands are still committed to the database, which can lead to partial results being stored.

Default: false

relationsActionstringOptional

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

attributesActionstringOptional

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

separatorstringRequired

The delimiter character used to separate entries. The default value is ';'.

Default: ;

quotestringRequired

The delimiter character used for quoted entries. The default value is '"'.

Default: "

escapestringRequired

The delimiter character used to escape separator or quote character. The default value is '\'.

Default: \

strictQuotesbooleanOptional

Whether the characters outside quotes should be ignored. The default value is false.

Default: false

ignoreLeadingWhitespacebooleanOptional

Whether whitespace characters before quotes should be ignored. The default value is false.

Default: false

headerRowbooleanOptional

Whether the first row of the synchronized CSV file is the header. The default value is false.

Default: false

templatestring · min: 1Required

The template that should be used for parsing and synchronizing 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>

Responses

200

Synchronization batch job successfully started.

application/json

Represents a job. Job is a single atomic task that is to be performed asynchronously

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

typestringOptional

The type of the job.

Example: IMPORT

userIdstring · uuidOptional

The ID of the user that initiated this job.

visibilityinteger · int32Optional

The visibility of the job.

progressPercentagenumber · doubleOptional

The progress percentage of the job.

Example: 50

cancelablebooleanOptional

Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted.

startDateinteger · int64Optional

The start date of the job.

Example: 1488016800

endDateinteger · int64Optional

The end date of the job.

Example: 1488021800

statestring · enumOptional

The state of the job.

Example: COMPLETEDPossible values:

resultstring · enumOptional

The result of the job.

Example: SUCCESSPossible values:

messagestringOptional

The message of the job.

Example: Import finished in 12s.

post/import/synchronize/{synchronizationId}/batch/csv-job

POST /rest/2.0/import/synchronize/{synchronizationId}/batch/csv-job HTTP/1.1
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 375

{
  "sendNotification": false,
  "simulation": false,
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "file": "binary",
  "fileName": "synchronization_file",
  "deleteFile": false,
  "continueOnError": false,
  "relationsAction": "REPLACE",
  "attributesAction": "REPLACE",
  "separator": ";",
  "quote": "\"",
  "escape": "\\",
  "strictQuotes": false,
  "ignoreLeadingWhitespace": false,
  "headerRow": false,
  "template": "text"
}

200

Synchronization batch job successfully started.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "type": "IMPORT",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "visibility": 1,
  "progressPercentage": 50,
  "cancelable": true,
  "startDate": 1488016800,
  "endDate": 1488021800,
  "state": "COMPLETED",
  "result": "SUCCESS",
  "message": "Import finished in 12s."
}

Starts batch synchronization from the Excel file in job (asynchronously).

post

Starts batch synchronization from the Excel file in job (asynchronously).

Request can either accept id of the uploaded file that contains Excel input which should be used for import or the file itself. The input file is treated as a part (batch) of synchronization process. After last batch, finalization (cleanup) process should be called.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

synchronizationIdstring · min: 1 · max: 50Required

The synchronization id used to distinguish different synchronizations.

Body

sendNotificationbooleanOptional

Whether job status notification should be sent. The default value is false.

Default: false

batchSizeinteger · int32 · min: 1OptionalDeprecated

The batchSize parameter is now deprecated and is ignored during command execution.

Default: 1000

simulationbooleanOptional

Whether the import should be triggered as a simulation. The default value is false.

If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.

This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.

Default: false

saveResultbooleanOptionalDeprecated

Whether the import Result should be persisted or forgotten. The default value is false.

If true, the list of added/updated/removed resources will be stored in the job message.

If the resulting job message is too long, no resource information will be stored.

DEPRECATED:This parameter is deprecated and will be removed in the future..

Default: false

fileIdstring · uuidOptional

The id of uploaded file.

NOTE: if this field is used, file should not be set.

filestring · binaryOptional

The file to upload. If set, then also fileName should be provided.

NOTE: if this field is used, fileId should not be set.

fileNamestringOptional

The name of the file to upload. If set, then also file should be provided.

NOTE: if this field is used, fileId should not be set.

Default: synchronization_file

deleteFilebooleanOptional

Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.

NOTE: if the file corresponds to an attachment, the attachment will be deleted.

Default: false

continueOnErrorbooleanOptional

Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.

If true, the valid commands are still committed to the database, which can lead to partial results being stored.

Default: false

relationsActionstringOptional

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

attributesActionstringOptional

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

sheetNamestringOptional

The name of the Excel sheet.

If the name is null and sheetIndex is null, the first sheet of the workbook will be used for the synchronization.

If the name is null and sheetIndex is not null, the sheet with the index specified by value of sheetIndex will be used for the synchronization.

sheetIndexinteger · int32Optional

The index of the Excel sheet.

If the index is null and sheetName is null, the first sheet of the workbook will be used for the synchronization.

If the index is null and sheetName is not null, the sheet with the name specified by value of sheetName will be used for the synchronization.

headerRowbooleanOptional

Whether the first row of the synchronized Excel file is the header. The default value is false.

templatestring · min: 1Required

The template that should be used for parsing and synchronizing the contents of the Excel file.

There is one placeholder currently supported:

${x} - refers to the n-th column in the Excel file, e.g. ${1}, ${2}, ...)

Example of a correct JSON template:

[
  {
    "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}"
      } ]
    }
  }
]

Responses

200

Synchronization batch job successfully started.

application/json

Represents a job. Job is a single atomic task that is to be performed asynchronously

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

typestringOptional

The type of the job.

Example: IMPORT

userIdstring · uuidOptional

The ID of the user that initiated this job.

visibilityinteger · int32Optional

The visibility of the job.

progressPercentagenumber · doubleOptional

The progress percentage of the job.

Example: 50

cancelablebooleanOptional

Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted.

startDateinteger · int64Optional

The start date of the job.

Example: 1488016800

endDateinteger · int64Optional

The end date of the job.

Example: 1488021800

statestring · enumOptional

The state of the job.

Example: COMPLETEDPossible values:

resultstring · enumOptional

The result of the job.

Example: SUCCESSPossible values:

messagestringOptional

The message of the job.

Example: Import finished in 12s.

post/import/synchronize/{synchronizationId}/batch/excel-job

POST /rest/2.0/import/synchronize/{synchronizationId}/batch/excel-job HTTP/1.1
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 312

{
  "sendNotification": false,
  "simulation": false,
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "file": "binary",
  "fileName": "synchronization_file",
  "deleteFile": false,
  "continueOnError": false,
  "relationsAction": "REPLACE",
  "attributesAction": "REPLACE",
  "sheetName": "text",
  "sheetIndex": 1,
  "headerRow": true,
  "template": "text"
}

200

Synchronization batch job successfully started.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "type": "IMPORT",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "visibility": 1,
  "progressPercentage": 50,
  "cancelable": true,
  "startDate": 1488016800,
  "endDate": 1488021800,
  "state": "COMPLETED",
  "result": "SUCCESS",
  "message": "Import finished in 12s."
}

Starts batch synchronization from the JSON file in job (asynchronously).

post

Starts batch synchronization from the JSON file in job (asynchronously).

Request can either accept id of the uploaded file that contains JSON input which should be used for import or the file itself. The input file is treated as a part (batch) of synchronization process. After last batch, finalization (cleanup) process should be called.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

synchronizationIdstring · min: 1 · max: 50Required

The synchronization id used to distinguish different synchronizations.

Body

sendNotificationbooleanOptional

Whether job status notification should be sent. The default value is false.

Default: false

batchSizeinteger · int32 · min: 1OptionalDeprecated

The batchSize parameter is now deprecated and is ignored during command execution.

Default: 1000

simulationbooleanOptional

Whether the import should be triggered as a simulation. The default value is false.

If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.

This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.

Default: false

saveResultbooleanOptionalDeprecated

Whether the import Result should be persisted or forgotten. The default value is false.

If true, the list of added/updated/removed resources will be stored in the job message.

If the resulting job message is too long, no resource information will be stored.

DEPRECATED:This parameter is deprecated and will be removed in the future..

Default: false

fileIdstring · uuidOptional

The id of uploaded file.

NOTE: if this field is used, file should not be set.

filestring · binaryOptional

The file to upload. If set, then also fileName should be provided.

NOTE: if this field is used, fileId should not be set.

fileNamestringOptional

The name of the file to upload. If set, then also file should be provided.

NOTE: if this field is used, fileId should not be set.

Default: synchronization_file

deleteFilebooleanOptional

Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.

NOTE: if the file corresponds to an attachment, the attachment will be deleted.

Default: false

continueOnErrorbooleanOptional

Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.

If true, the valid commands are still committed to the database, which can lead to partial results being stored.

Default: false

relationsActionstringOptional

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

attributesActionstringOptional

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

allowEmptyAttributeValuesbooleanOptional

Whether empty attribute values should be allowed during import. The default value is false.

When false (default), attribute values that are empty or blank are filtered out and not imported. When true, empty attribute values are preserved and imported as-is.

Default: false

Responses

200

Synchronization batch job successfully started.

application/json

Represents a job. Job is a single atomic task that is to be performed asynchronously

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

typestringOptional

The type of the job.

Example: IMPORT

userIdstring · uuidOptional

The ID of the user that initiated this job.

visibilityinteger · int32Optional

The visibility of the job.

progressPercentagenumber · doubleOptional

The progress percentage of the job.

Example: 50

cancelablebooleanOptional

Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted.

startDateinteger · int64Optional

The start date of the job.

Example: 1488016800

endDateinteger · int64Optional

The end date of the job.

Example: 1488021800

statestring · enumOptional

The state of the job.

Example: COMPLETEDPossible values:

resultstring · enumOptional

The result of the job.

Example: SUCCESSPossible values:

messagestringOptional

The message of the job.

Example: Import finished in 12s.

post/import/synchronize/{synchronizationId}/batch/json-job

POST /rest/2.0/import/synchronize/{synchronizationId}/batch/json-job HTTP/1.1
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 277

{
  "sendNotification": false,
  "simulation": false,
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "file": "binary",
  "fileName": "synchronization_file",
  "deleteFile": false,
  "continueOnError": false,
  "relationsAction": "REPLACE",
  "attributesAction": "REPLACE",
  "allowEmptyAttributeValues": false
}

200

Synchronization batch job successfully started.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "type": "IMPORT",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "visibility": 1,
  "progressPercentage": 50,
  "cancelable": true,
  "startDate": 1488016800,
  "endDate": 1488021800,
  "state": "COMPLETED",
  "result": "SUCCESS",
  "message": "Import finished in 12s."
}

Starts full synchronization from the CSV file in job (asynchronously).

post

Starts full synchronization from the CSV file in job (asynchronously).

Request can either accept id of the uploaded file that contains CSV input which should be used for import or the file itself. The input file is treated as a full input of synchronization process.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

synchronizationIdstring · min: 1 · max: 50Required

The synchronization id used to distinguish different synchronizations.

Body

sendNotificationbooleanOptional

Whether job status notification should be sent. The default value is false.

Default: false

batchSizeinteger · int32 · min: 1OptionalDeprecated

The batchSize parameter is now deprecated and is ignored during command execution.

Default: 1000

simulationbooleanOptional

Whether the import should be triggered as a simulation. The default value is false.

If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.

This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.

Default: false

saveResultbooleanOptionalDeprecated

Whether the import Result should be persisted or forgotten. The default value is false.

If true, the list of added/updated/removed resources will be stored in the job message.

If the resulting job message is too long, no resource information will be stored.

DEPRECATED:This parameter is deprecated and will be removed in the future..

Default: false

fileIdstring · uuidOptional

The id of uploaded file.

NOTE: if this field is used, file should not be set.

filestring · binaryOptional

The file to upload. If set, then also fileName should be provided.

NOTE: if this field is used, fileId should not be set.

fileNamestringOptional

The name of the file to upload. If set, then also file should be provided.

NOTE: if this field is used, fileId should not be set.

Default: synchronization_file

deleteFilebooleanOptional

Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.

NOTE: if the file corresponds to an attachment, the attachment will be deleted.

Default: false

continueOnErrorbooleanOptional

Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.

If true, the valid commands are still committed to the database, which can lead to partial results being stored.

Default: false

relationsActionstringOptional

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

attributesActionstringOptional

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

finalizationStrategystringOptional

The synchronization finalization strategy used in the clean up action. This determines whether to remove, ignore or change the status of assets that no longer exist in the external system.
Possible values are REMOVE_RESOURCES, CHANGE_STATUS and IGNORE.
When you select CHANGE_STATUS, you must also provide a value for missingAssetStatusId.

Default: REMOVE_RESOURCESPattern: REMOVE_RESOURCES|CHANGE_STATUS|IGNORE

missingAssetStatusIdstring · uuidOptional

If finalizationStrategy is set to CHANGE_STATUS then this parameter determines the new status ID for assets that no longer exist in the external system.

separatorstringRequired

The delimiter character used to separate entries. The default value is ';'.

Default: ;

quotestringRequired

The delimiter character used for quoted entries. The default value is '"'.

Default: "

escapestringRequired

The delimiter character used to escape separator or quote character. The default value is '\'.

Default: \

strictQuotesbooleanOptional

Whether the characters outside quotes should be ignored. The default value is false.

ignoreLeadingWhitespacebooleanOptional

Whether whitespace characters before quotes should be ignored. The default value is false.

headerRowbooleanOptional

Whether the first row of the synchronized CSV file is the header. The default value is false.

templatestring · min: 1Required

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

There is one placeholder currently supported:

${x} - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)

Example of a correct JSON template:

[
  {
    "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}"
      } ]
    }
  }
]

Responses

200

Synchronization job successfully started.

application/json

Represents a job. Job is a single atomic task that is to be performed asynchronously

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

typestringOptional

The type of the job.

Example: IMPORT

userIdstring · uuidOptional

The ID of the user that initiated this job.

visibilityinteger · int32Optional

The visibility of the job.

progressPercentagenumber · doubleOptional

The progress percentage of the job.

Example: 50

cancelablebooleanOptional

Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted.

startDateinteger · int64Optional

The start date of the job.

Example: 1488016800

endDateinteger · int64Optional

The end date of the job.

Example: 1488021800

statestring · enumOptional

The state of the job.

Example: COMPLETEDPossible values:

resultstring · enumOptional

The result of the job.

Example: SUCCESSPossible values:

messagestringOptional

The message of the job.

Example: Import finished in 12s.

post/import/synchronize/{synchronizationId}/csv-job

POST /rest/2.0/import/synchronize/{synchronizationId}/csv-job HTTP/1.1
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 476

{
  "sendNotification": false,
  "simulation": false,
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "file": "binary",
  "fileName": "synchronization_file",
  "deleteFile": false,
  "continueOnError": false,
  "relationsAction": "REPLACE",
  "attributesAction": "REPLACE",
  "finalizationStrategy": "REMOVE_RESOURCES",
  "missingAssetStatusId": "123e4567-e89b-12d3-a456-426614174000",
  "separator": ";",
  "quote": "\"",
  "escape": "\\",
  "strictQuotes": true,
  "ignoreLeadingWhitespace": true,
  "headerRow": true,
  "template": "text"
}

200

Synchronization job successfully started.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "type": "IMPORT",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "visibility": 1,
  "progressPercentage": 50,
  "cancelable": true,
  "startDate": 1488016800,
  "endDate": 1488021800,
  "state": "COMPLETED",
  "result": "SUCCESS",
  "message": "Import finished in 12s."
}

Starts full synchronization from the Excel file in job (asynchronously).

post

Starts full synchronization from the Excel file in job (asynchronously).

Request can either accept id of the uploaded file that contains Excel input which should be used for import or the file itself. The input file is treated as a full input of synchronization process.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

synchronizationIdstring · min: 1 · max: 50Required

The synchronization id used to distinguish different synchronizations.

Body

sendNotificationbooleanOptional

Whether job status notification should be sent. The default value is false.

Default: false

batchSizeinteger · int32 · min: 1OptionalDeprecated

The batchSize parameter is now deprecated and is ignored during command execution.

Default: 1000

simulationbooleanOptional

Whether the import should be triggered as a simulation. The default value is false.

If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.

This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.

Default: false

saveResultbooleanOptionalDeprecated

Whether the import Result should be persisted or forgotten. The default value is false.

If true, the list of added/updated/removed resources will be stored in the job message.

If the resulting job message is too long, no resource information will be stored.

DEPRECATED:This parameter is deprecated and will be removed in the future..

Default: false

fileIdstring · uuidOptional

The id of uploaded file.

NOTE: if this field is used, file should not be set.

filestring · binaryOptional

The file to upload. If set, then also fileName should be provided.

NOTE: if this field is used, fileId should not be set.

fileNamestringOptional

The name of the file to upload. If set, then also file should be provided.

NOTE: if this field is used, fileId should not be set.

Default: synchronization_file

deleteFilebooleanOptional

Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.

NOTE: if the file corresponds to an attachment, the attachment will be deleted.

Default: false

continueOnErrorbooleanOptional

Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.

If true, the valid commands are still committed to the database, which can lead to partial results being stored.

Default: false

relationsActionstringOptional

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

attributesActionstringOptional

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

finalizationStrategystringOptional

Default: REMOVE_RESOURCESPattern: REMOVE_RESOURCES|CHANGE_STATUS|IGNORE

missingAssetStatusIdstring · uuidOptional

If finalizationStrategy is set to CHANGE_STATUS then this parameter determines the new status ID for assets that no longer exist in the external system.

sheetNamestringOptional

The name of the Excel sheet.

If the name is null and sheetIndex is null, the first sheet of the workbook will be used for the synchronization.

If the name is null and sheetIndex is not null, the sheet with the index specified by value of sheetIndex will be used for the synchronization.

sheetIndexinteger · int32Optional

The index of the Excel sheet.

If the index is null and sheetName is null, the first sheet of the workbook will be used for the synchronization.

If the index is null and sheetName is not null, the sheet with the name specified by value of sheetName will be used for the synchronization.

headerRowbooleanOptional

Whether the first row of the synchronized Excel file is the header. The default value is false.

templatestring · min: 1Required

The template that should be used for parsing and synchronizing the contents of the Excel file.

There is one placeholder currently supported:

${x} - refers to the n-th column in the Excel file, e.g. ${1}, ${2}, ...)

Example of a correct JSON template:

[
  {
    "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}"
      } ]
    }
  }
]

Responses

200

Synchronization job successfully started.

application/json

Represents a job. Job is a single atomic task that is to be performed asynchronously

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

typestringOptional

The type of the job.

Example: IMPORT

userIdstring · uuidOptional

The ID of the user that initiated this job.

visibilityinteger · int32Optional

The visibility of the job.

progressPercentagenumber · doubleOptional

The progress percentage of the job.

Example: 50

cancelablebooleanOptional

Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted.

startDateinteger · int64Optional

The start date of the job.

Example: 1488016800

endDateinteger · int64Optional

The end date of the job.

Example: 1488021800

statestring · enumOptional

The state of the job.

Example: COMPLETEDPossible values:

resultstring · enumOptional

The result of the job.

Example: SUCCESSPossible values:

messagestringOptional

The message of the job.

Example: Import finished in 12s.

post/import/synchronize/{synchronizationId}/excel-job

POST /rest/2.0/import/synchronize/{synchronizationId}/excel-job HTTP/1.1
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 416

{
  "sendNotification": false,
  "simulation": false,
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "file": "binary",
  "fileName": "synchronization_file",
  "deleteFile": false,
  "continueOnError": false,
  "relationsAction": "REPLACE",
  "attributesAction": "REPLACE",
  "finalizationStrategy": "REMOVE_RESOURCES",
  "missingAssetStatusId": "123e4567-e89b-12d3-a456-426614174000",
  "sheetName": "text",
  "sheetIndex": 1,
  "headerRow": true,
  "template": "text"
}

200

Synchronization job successfully started.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "type": "IMPORT",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "visibility": 1,
  "progressPercentage": 50,
  "cancelable": true,
  "startDate": 1488016800,
  "endDate": 1488021800,
  "state": "COMPLETED",
  "result": "SUCCESS",
  "message": "Import finished in 12s."
}

Starts synchronization finalization in job (asynchronously).

post

Starts synchronization finalization in job (asynchronously).

Note that while the only mandatory parameter is synchronizationId, requests that omit all optional parameters fail because the multipart-based setup requires at least one part to be present in the body. To meet this requirement and still use all the default values, you can pass a dummy part, for example -F 'foo=bar' if using curl.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

synchronizationIdstring · min: 1 · max: 50Required

The synchronization ID used to distinguish different synchronizations.

Body

sendNotificationbooleanOptional

Whether job status notification should be sent. The default value is false.

Default: false

batchSizeinteger · int32 · min: 1OptionalDeprecated

The batchSize parameter is now deprecated and is ignored during command execution.

Default: 1000

simulationbooleanOptional

Whether the import should be triggered as a simulation. The default value is false.

If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.

This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.

Default: false

saveResultbooleanOptionalDeprecated

Whether the import Result should be persisted or forgotten. The default value is false.

If true, the list of added/updated/removed resources will be stored in the job message.

If the resulting job message is too long, no resource information will be stored.

DEPRECATED:This parameter is deprecated and will be removed in the future..

Default: false

finalizationStrategystringOptional

Default: REMOVE_RESOURCESPattern: REMOVE_RESOURCES|CHANGE_STATUS|IGNORE

missingAssetStatusIdstring · uuidOptional

If finalizationStrategy is set to CHANGE_STATUS then this parameter determines the new status ID for assets that no longer exist in the external system.

continueOnErrorbooleanOptional

Whether the operation should continue if some of the finalization steps failed to execute. The default value is false.

If true, the valid steps are still committed to the database, which can lead to partial results being stored.

Default: false

Responses

200

Synchronization finalization job successfully started.

application/json

Represents a job. Job is a single atomic task that is to be performed asynchronously

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

typestringOptional

The type of the job.

Example: IMPORT

userIdstring · uuidOptional

The ID of the user that initiated this job.

visibilityinteger · int32Optional

The visibility of the job.

progressPercentagenumber · doubleOptional

The progress percentage of the job.

Example: 50

cancelablebooleanOptional

Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted.

startDateinteger · int64Optional

The start date of the job.

Example: 1488016800

endDateinteger · int64Optional

The end date of the job.

Example: 1488021800

statestring · enumOptional

The state of the job.

Example: COMPLETEDPossible values:

resultstring · enumOptional

The result of the job.

Example: SUCCESSPossible values:

messagestringOptional

The message of the job.

Example: Import finished in 12s.

post/import/synchronize/{synchronizationId}/finalize/job

POST /rest/2.0/import/synchronize/{synchronizationId}/finalize/job HTTP/1.1
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 173

{
  "sendNotification": false,
  "simulation": false,
  "finalizationStrategy": "REMOVE_RESOURCES",
  "missingAssetStatusId": "123e4567-e89b-12d3-a456-426614174000",
  "continueOnError": false
}

200

Synchronization finalization job successfully started.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "type": "IMPORT",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "visibility": 1,
  "progressPercentage": 50,
  "cancelable": true,
  "startDate": 1488016800,
  "endDate": 1488021800,
  "state": "COMPLETED",
  "result": "SUCCESS",
  "message": "Import finished in 12s."
}

Starts full synchronization from the JSON file in job (asynchronously).

post

Starts full synchronization from the JSON file in job (asynchronously).

Request can either accept id of the uploaded file that contains JSON input which should be used for import or the file itself. The input file is treated as a full input of synchronization process.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

synchronizationIdstring · min: 1 · max: 50Required

The synchronization id used to distinguish different synchronizations.

Body

sendNotificationbooleanOptional

Whether job status notification should be sent. The default value is false.

Default: false

batchSizeinteger · int32 · min: 1OptionalDeprecated

The batchSize parameter is now deprecated and is ignored during command execution.

Default: 1000

simulationbooleanOptional

Whether the import should be triggered as a simulation. The default value is false.

If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.

This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.

Default: false

saveResultbooleanOptionalDeprecated

Whether the import Result should be persisted or forgotten. The default value is false.

If true, the list of added/updated/removed resources will be stored in the job message.

If the resulting job message is too long, no resource information will be stored.

DEPRECATED:This parameter is deprecated and will be removed in the future..

Default: false

fileIdstring · uuidOptional

The id of uploaded file.

NOTE: if this field is used, file should not be set.

filestring · binaryOptional

The file to upload. If set, then also fileName should be provided.

NOTE: if this field is used, fileId should not be set.

fileNamestringOptional

The name of the file to upload. If set, then also file should be provided.

NOTE: if this field is used, fileId should not be set.

Default: synchronization_file

deleteFilebooleanOptional

Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.

NOTE: if the file corresponds to an attachment, the attachment will be deleted.

Default: false

continueOnErrorbooleanOptional

Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.

If true, the valid commands are still committed to the database, which can lead to partial results being stored.

Default: false

relationsActionstringOptional

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

attributesActionstringOptional

Default: REPLACEPattern: ADD_OR_IGNORE|REPLACE

finalizationStrategystringOptional

Default: REMOVE_RESOURCESPattern: REMOVE_RESOURCES|CHANGE_STATUS|IGNORE

missingAssetStatusIdstring · uuidOptional

If finalizationStrategy is set to CHANGE_STATUS then this parameter determines the new status ID for assets that no longer exist in the external system.

allowEmptyAttributeValuesbooleanOptional

Whether empty attribute values should be allowed during import. The default value is false.

When false (default), attribute values that are empty or blank are filtered out and not imported. When true, empty attribute values are preserved and imported as-is.

Default: false

Responses

200

Synchronization job successfully started.

application/json

Represents a job. Job is a single atomic task that is to be performed asynchronously

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

typestringOptional

The type of the job.

Example: IMPORT

userIdstring · uuidOptional

The ID of the user that initiated this job.

visibilityinteger · int32Optional

The visibility of the job.

progressPercentagenumber · doubleOptional

The progress percentage of the job.

Example: 50

cancelablebooleanOptional

Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted.

startDateinteger · int64Optional

The start date of the job.

Example: 1488016800

endDateinteger · int64Optional

The end date of the job.

Example: 1488021800

statestring · enumOptional

The state of the job.

Example: COMPLETEDPossible values:

resultstring · enumOptional

The result of the job.

Example: SUCCESSPossible values:

messagestringOptional

The message of the job.

Example: Import finished in 12s.

post/import/synchronize/{synchronizationId}/json-job

POST /rest/2.0/import/synchronize/{synchronizationId}/json-job HTTP/1.1
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 381

{
  "sendNotification": false,
  "simulation": false,
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "file": "binary",
  "fileName": "synchronization_file",
  "deleteFile": false,
  "continueOnError": false,
  "relationsAction": "REPLACE",
  "attributesAction": "REPLACE",
  "finalizationStrategy": "REMOVE_RESOURCES",
  "missingAssetStatusId": "123e4567-e89b-12d3-a456-426614174000",
  "allowEmptyAttributeValues": false
}

200

Synchronization job successfully started.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "type": "IMPORT",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "visibility": 1,
  "progressPercentage": 50,
  "cancelable": true,
  "startDate": 1488016800,
  "endDate": 1488021800,
  "state": "COMPLETED",
  "result": "SUCCESS",
  "message": "Import finished in 12s."
}

PreviousImport REST API (Version 2)NextImport Results

Last updated 22 days ago

Was this helpful?