collibra-import-200 2.0.0

Collibra Import API

collibra-import_200

The Import API is an efficient way to load large volumes of data into the Collibra Data Governance Center. The API can automatically differentiate between creating and updating data.

This Python package is automatically generated by the Swagger Codegen project:

• API version: 2.0
• Package version: 2.0.0
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import collibra_import 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import collibra_import

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import collibra_import
from collibra_import.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = collibra_import.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_import.ImportApi(collibra_import.ApiClient(configuration))
synchronization_id = 'synchronization_id_example' # str | The synchronization id of the operation.

try:
    # Removes all cache entries corresponding to the provided synchronization id.
    api_instance.evict_synchronization_cache(synchronization_id)
except ApiException as e:
    print("Exception when calling ImportApi->evict_synchronization_cache: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_import.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_import.ImportApi(collibra_import.ApiClient(configuration))
synchronization_id = 'synchronization_id_example' # str | The synchronization id of the operation.

try:
    # Checks whether given synchronization id already exists.
    api_response = api_instance.exists(synchronization_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImportApi->exists: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_import.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_import.ImportApi(collibra_import.ApiClient(configuration))
offset = 0 # int | The first result to retrieve. If not set (offset = <code>0</code>), results will be retrieved starting from row <code>0</code>. (optional) (default to 0)
limit = 0 # int | The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used. The maximum allowed limit is 1000. (optional) (default to 0)
count_limit = -1 # int | Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped (optional) (default to -1)

try:
    # Returns synchronization information matching the given search criteria.
    api_response = api_instance.find_synchronization_infos(offset=offset, limit=limit, count_limit=count_limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImportApi->find_synchronization_infos: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_import.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_import.ImportApi(collibra_import.ApiClient(configuration))
send_notification = true # bool |  (optional)
batch_size = 56 # int |  (optional)
simulation = true # bool |  (optional)
save_result = true # bool |  (optional)
file_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
file = 'file_example' # str |  (optional)
file_name = 'file_name_example' # str |  (optional)
delete_file = true # bool |  (optional)
continue_on_error = true # bool |  (optional)
separator = 'separator_example' # str |  (optional)
quote = 'quote_example' # str |  (optional)
escape = 'escape_example' # str |  (optional)
strict_quotes = true # bool |  (optional)
ignore_leading_whitespace = true # bool |  (optional)
header_row = true # bool |  (optional)
template = 'template_example' # str |  (optional)

try:
    # Starts import from the CSV file in job (asynchronously).
    api_response = api_instance.import_csv_in_job(send_notification=send_notification, batch_size=batch_size, simulation=simulation, save_result=save_result, file_id=file_id, file=file, file_name=file_name, delete_file=delete_file, continue_on_error=continue_on_error, separator=separator, quote=quote, escape=escape, strict_quotes=strict_quotes, ignore_leading_whitespace=ignore_leading_whitespace, header_row=header_row, template=template)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImportApi->import_csv_in_job: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_import.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_import.ImportApi(collibra_import.ApiClient(configuration))
send_notification = true # bool |  (optional)
batch_size = 56 # int |  (optional)
simulation = true # bool |  (optional)
save_result = true # bool |  (optional)
file_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
file = 'file_example' # str |  (optional)
file_name = 'file_name_example' # str |  (optional)
delete_file = true # bool |  (optional)
continue_on_error = true # bool |  (optional)
sheet_name = 'sheet_name_example' # str |  (optional)
sheet_index = 56 # int |  (optional)
header_row = true # bool |  (optional)
template = 'template_example' # str |  (optional)

try:
    # Starts import from the Excel file in job (asynchronously).
    api_response = api_instance.import_excel_in_job(send_notification=send_notification, batch_size=batch_size, simulation=simulation, save_result=save_result, file_id=file_id, file=file, file_name=file_name, delete_file=delete_file, continue_on_error=continue_on_error, sheet_name=sheet_name, sheet_index=sheet_index, header_row=header_row, template=template)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImportApi->import_excel_in_job: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_import.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_import.ImportApi(collibra_import.ApiClient(configuration))
send_notification = true # bool |  (optional)
batch_size = 56 # int |  (optional)
simulation = true # bool |  (optional)
save_result = true # bool |  (optional)
file_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
file = 'file_example' # str |  (optional)
file_name = 'file_name_example' # str |  (optional)
delete_file = true # bool |  (optional)
continue_on_error = true # bool |  (optional)
relations_action = 'relations_action_example' # str |  (optional)

try:
    # Starts import from the JSON file in job (asynchronously).
    api_response = api_instance.import_json_in_job(send_notification=send_notification, batch_size=batch_size, simulation=simulation, save_result=save_result, file_id=file_id, file=file, file_name=file_name, delete_file=delete_file, continue_on_error=continue_on_error, relations_action=relations_action)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImportApi->import_json_in_job: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_import.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_import.ImportApi(collibra_import.ApiClient(configuration))
synchronization_id = 'synchronization_id_example' # str | The synchronization id of the operation.

try:
    # Removes all information about synchronization process corresponding to provided synchronization id.
    api_instance.remove_synchronization(synchronization_id)
except ApiException as e:
    print("Exception when calling ImportApi->remove_synchronization: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_import.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_import.ImportApi(collibra_import.ApiClient(configuration))
synchronization_id = 'synchronization_id_example' # str | The synchronization id used to distinguish different synchronizations.
send_notification = true # bool |  (optional)
batch_size = 56 # int |  (optional)
simulation = true # bool |  (optional)
save_result = true # bool |  (optional)
file_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
file = 'file_example' # str |  (optional)
file_name = 'file_name_example' # str |  (optional)
delete_file = true # bool |  (optional)
continue_on_error = true # bool |  (optional)
separator = 'separator_example' # str |  (optional)
quote = 'quote_example' # str |  (optional)
escape = 'escape_example' # str |  (optional)
strict_quotes = true # bool |  (optional)
ignore_leading_whitespace = true # bool |  (optional)
header_row = true # bool |  (optional)
template = 'template_example' # str |  (optional)

try:
    # Starts batch synchronization from the CSV file in job (asynchronously).
    api_response = api_instance.synchronize_batch_csv_in_job(synchronization_id, send_notification=send_notification, batch_size=batch_size, simulation=simulation, save_result=save_result, file_id=file_id, file=file, file_name=file_name, delete_file=delete_file, continue_on_error=continue_on_error, separator=separator, quote=quote, escape=escape, strict_quotes=strict_quotes, ignore_leading_whitespace=ignore_leading_whitespace, header_row=header_row, template=template)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImportApi->synchronize_batch_csv_in_job: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_import.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_import.ImportApi(collibra_import.ApiClient(configuration))
synchronization_id = 'synchronization_id_example' # str | The synchronization id used to distinguish different synchronizations.
send_notification = true # bool |  (optional)
batch_size = 56 # int |  (optional)
simulation = true # bool |  (optional)
save_result = true # bool |  (optional)
file_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
file = 'file_example' # str |  (optional)
file_name = 'file_name_example' # str |  (optional)
delete_file = true # bool |  (optional)
continue_on_error = true # bool |  (optional)
sheet_name = 'sheet_name_example' # str |  (optional)
sheet_index = 56 # int |  (optional)
header_row = true # bool |  (optional)
template = 'template_example' # str |  (optional)

try:
    # Starts batch synchronization from the Excel file in job (asynchronously).
    api_response = api_instance.synchronize_batch_excel_in_job(synchronization_id, send_notification=send_notification, batch_size=batch_size, simulation=simulation, save_result=save_result, file_id=file_id, file=file, file_name=file_name, delete_file=delete_file, continue_on_error=continue_on_error, sheet_name=sheet_name, sheet_index=sheet_index, header_row=header_row, template=template)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImportApi->synchronize_batch_excel_in_job: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_import.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_import.ImportApi(collibra_import.ApiClient(configuration))
synchronization_id = 'synchronization_id_example' # str | The synchronization id used to distinguish different synchronizations.
send_notification = true # bool |  (optional)
batch_size = 56 # int |  (optional)
simulation = true # bool |  (optional)
save_result = true # bool |  (optional)
file_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
file = 'file_example' # str |  (optional)
file_name = 'file_name_example' # str |  (optional)
delete_file = true # bool |  (optional)
continue_on_error = true # bool |  (optional)
relations_action = 'relations_action_example' # str |  (optional)

try:
    # Starts batch synchronization from the JSON file in job (asynchronously).
    api_response = api_instance.synchronize_batch_json_in_job(synchronization_id, send_notification=send_notification, batch_size=batch_size, simulation=simulation, save_result=save_result, file_id=file_id, file=file, file_name=file_name, delete_file=delete_file, continue_on_error=continue_on_error, relations_action=relations_action)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImportApi->synchronize_batch_json_in_job: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_import.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_import.ImportApi(collibra_import.ApiClient(configuration))
synchronization_id = 'synchronization_id_example' # str | The synchronization id used to distinguish different synchronizations.
send_notification = true # bool |  (optional)
batch_size = 56 # int |  (optional)
simulation = true # bool |  (optional)
save_result = true # bool |  (optional)
file_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
file = 'file_example' # str |  (optional)
file_name = 'file_name_example' # str |  (optional)
delete_file = true # bool |  (optional)
continue_on_error = true # bool |  (optional)
finalization_strategy = 'finalization_strategy_example' # str |  (optional)
missing_asset_status_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
separator = 'separator_example' # str |  (optional)
quote = 'quote_example' # str |  (optional)
escape = 'escape_example' # str |  (optional)
strict_quotes = true # bool |  (optional)
ignore_leading_whitespace = true # bool |  (optional)
header_row = true # bool |  (optional)
template = 'template_example' # str |  (optional)

try:
    # Starts full synchronization from the CSV file in job (asynchronously).
    api_response = api_instance.synchronize_csv_in_job(synchronization_id, send_notification=send_notification, batch_size=batch_size, simulation=simulation, save_result=save_result, file_id=file_id, file=file, file_name=file_name, delete_file=delete_file, continue_on_error=continue_on_error, finalization_strategy=finalization_strategy, missing_asset_status_id=missing_asset_status_id, separator=separator, quote=quote, escape=escape, strict_quotes=strict_quotes, ignore_leading_whitespace=ignore_leading_whitespace, header_row=header_row, template=template)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImportApi->synchronize_csv_in_job: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_import.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_import.ImportApi(collibra_import.ApiClient(configuration))
synchronization_id = 'synchronization_id_example' # str | The synchronization id used to distinguish different synchronizations.
send_notification = true # bool |  (optional)
batch_size = 56 # int |  (optional)
simulation = true # bool |  (optional)
save_result = true # bool |  (optional)
file_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
file = 'file_example' # str |  (optional)
file_name = 'file_name_example' # str |  (optional)
delete_file = true # bool |  (optional)
continue_on_error = true # bool |  (optional)
finalization_strategy = 'finalization_strategy_example' # str |  (optional)
missing_asset_status_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
sheet_name = 'sheet_name_example' # str |  (optional)
sheet_index = 56 # int |  (optional)
header_row = true # bool |  (optional)
template = 'template_example' # str |  (optional)

try:
    # Starts full synchronization from the Excel file in job (asynchronously).
    api_response = api_instance.synchronize_excel_in_job(synchronization_id, send_notification=send_notification, batch_size=batch_size, simulation=simulation, save_result=save_result, file_id=file_id, file=file, file_name=file_name, delete_file=delete_file, continue_on_error=continue_on_error, finalization_strategy=finalization_strategy, missing_asset_status_id=missing_asset_status_id, sheet_name=sheet_name, sheet_index=sheet_index, header_row=header_row, template=template)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImportApi->synchronize_excel_in_job: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_import.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_import.ImportApi(collibra_import.ApiClient(configuration))
synchronization_id = 'synchronization_id_example' # str | The synchronization ID used to distinguish different synchronizations.
send_notification = true # bool |  (optional)
batch_size = 56 # int |  (optional)
simulation = true # bool |  (optional)
save_result = true # bool |  (optional)
finalization_strategy = 'finalization_strategy_example' # str |  (optional)
missing_asset_status_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
finalization_parameters = {'key': 'finalization_parameters_example'} # dict(str, str) |  (optional)

try:
    # Starts synchronization finalization in job (asynchronously).
    api_response = api_instance.synchronize_finalize_in_job(synchronization_id, send_notification=send_notification, batch_size=batch_size, simulation=simulation, save_result=save_result, finalization_strategy=finalization_strategy, missing_asset_status_id=missing_asset_status_id, finalization_parameters=finalization_parameters)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImportApi->synchronize_finalize_in_job: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_import.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = collibra_import.ImportApi(collibra_import.ApiClient(configuration))
synchronization_id = 'synchronization_id_example' # str | The synchronization id used to distinguish different synchronizations.
send_notification = true # bool |  (optional)
batch_size = 56 # int |  (optional)
simulation = true # bool |  (optional)
save_result = true # bool |  (optional)
file_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
file = 'file_example' # str |  (optional)
file_name = 'file_name_example' # str |  (optional)
delete_file = true # bool |  (optional)
continue_on_error = true # bool |  (optional)
finalization_strategy = 'finalization_strategy_example' # str |  (optional)
missing_asset_status_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)

try:
    # Starts full synchronization from the JSON file in job (asynchronously).
    api_response = api_instance.synchronize_json_in_job(synchronization_id, send_notification=send_notification, batch_size=batch_size, simulation=simulation, save_result=save_result, file_id=file_id, file=file, file_name=file_name, delete_file=delete_file, continue_on_error=continue_on_error, finalization_strategy=finalization_strategy, missing_asset_status_id=missing_asset_status_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImportApi->synchronize_json_in_job: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /rest/2.0

Class	Method	HTTP request	Description
ImportApi	evict_synchronization_cache	DELETE /import/synchronize/{synchronizationId}/evict	Removes all cache entries corresponding to the provided synchronization id.
ImportApi	exists	GET /import/synchronize/exists/{synchronizationId}	Checks whether given synchronization id already exists.
ImportApi	find_synchronization_infos	GET /import/synchronize	Returns synchronization information matching the given search criteria.
ImportApi	import_csv_in_job	POST /import/csv-job	Starts import from the CSV file in job (asynchronously).
ImportApi	import_excel_in_job	POST /import/excel-job	Starts import from the Excel file in job (asynchronously).
ImportApi	import_json_in_job	POST /import/json-job	Starts import from the JSON file in job (asynchronously).
ImportApi	remove_synchronization	DELETE /import/synchronize/{synchronizationId}	Removes all information about synchronization process corresponding to provided synchronization id.
ImportApi	synchronize_batch_csv_in_job	POST /import/synchronize/{synchronizationId}/batch/csv-job	Starts batch synchronization from the CSV file in job (asynchronously).
ImportApi	synchronize_batch_excel_in_job	POST /import/synchronize/{synchronizationId}/batch/excel-job	Starts batch synchronization from the Excel file in job (asynchronously).
ImportApi	synchronize_batch_json_in_job	POST /import/synchronize/{synchronizationId}/batch/json-job	Starts batch synchronization from the JSON file in job (asynchronously).
ImportApi	synchronize_csv_in_job	POST /import/synchronize/{synchronizationId}/csv-job	Starts full synchronization from the CSV file in job (asynchronously).
ImportApi	synchronize_excel_in_job	POST /import/synchronize/{synchronizationId}/excel-job	Starts full synchronization from the Excel file in job (asynchronously).
ImportApi	synchronize_finalize_in_job	POST /import/synchronize/{synchronizationId}/finalize/job	Starts synchronization finalization in job (asynchronously).
ImportApi	synchronize_json_in_job	POST /import/synchronize/{synchronizationId}/json-job	Starts full synchronization from the JSON file in job (asynchronously).
ImportResultsApi	find_import_errors	GET /import/results/{jobId}/errors	List the errors of a finished import job
ImportResultsApi	get_import_job_summary	GET /import/results/{jobId}/summary	Retrieve a summary of a finished import job

Documentation For Models

• AnyOfImportJsonInJobRequest
• AssetIdentifier
• AssetImportCommand
• AssetTypeIdentifier
• AttributeValue
• BatchCsvjobBody
• BatchExceljobBody
• BatchJsonjobBody
• CategoryReference
• CommunityIdentifier
• CommunityImportCommand
• ComplexRelationIdentifier
• ComplexRelationImportCommand
• ComplexRelationTypeIdentifier
• DomainIdentifier
• DomainImportCommand
• DomainTypeIdentifier
• ExternalIdentifier
• FinalizeJobBody
• FindSynchronizationRequest
• ImportCommandReference
• ImportCounters
• ImportCsvInJobRequest
• ImportCsvjobBody
• ImportError
• ImportErrorPagedResponse
• ImportExcelInJobRequest
• ImportExceljobBody
• ImportJsonInJobRequest
• ImportJsonjobBody
• ImportSummary
• Job
• MappingIdentifier
• MappingImportCommand
• Owner
• PagedResponseImportError
• PagedResponseSynchronizationInfo
• ResourceTypeSummary
• StatusIdentifier
• SubcategorySummary
• SynchronizationBatchCsvInJobRequest
• SynchronizationBatchExcelInJobRequest
• SynchronizationBatchJsonInJobRequest
• SynchronizationCsvInJobRequest
• SynchronizationExcelInJobRequest
• SynchronizationFinalizationRequest
• SynchronizationIdCsvjobBody
• SynchronizationIdExceljobBody
• SynchronizationIdJsonjobBody
• SynchronizationInfo
• SynchronizationJsonInJobRequest
• UserGroupIdentifier
• UserIdentifier

Documentation For Authorization

basicAuth

• Type: HTTP basic authentication

Author