# collibra-catalog_classification_100
<p>The Catalog API offers functionality related to the catalog product.<br/> It is mainly focused on facilitating the ingestion of information into Catalog. The API enables users to more easily connect Catalog to sources that are not necessarily natively supported in the product. </p>
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: 1.0
- Package version: 1.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
```sh
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:
```python
import collibra_catalog_classification
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import collibra_catalog_classification
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import collibra_catalog_classification
from collibra_catalog_classification.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_classification.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))
body = collibra_catalog_classification.AddClassificationRequest() # AddClassificationRequest | The request with data needed for creation of new classification. (optional)
try:
# Adds new Classification
api_response = api_instance.add_classification(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataClassificationApi->add_classification: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_classification.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))
body = collibra_catalog_classification.AddClassificationMatchRequest() # AddClassificationMatchRequest | The request with data needed for creation of new classification match. (optional)
try:
# Adds new Classification Match
api_response = api_instance.add_classification_match(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataClassificationApi->add_classification_match: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_classification.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))
body = collibra_catalog_classification.AddClassificationMatchesRequest() # AddClassificationMatchesRequest | The request with data needed for creation of new classification matches. (optional)
try:
# Adds new Classification Matches
api_response = api_instance.add_classification_matches(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataClassificationApi->add_classification_matches: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_classification.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))
classification_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The id of the Classification to be changed
body = collibra_catalog_classification.ChangeClassificationRequest() # ChangeClassificationRequest | The properties of the Classification to be changed. (optional)
try:
# Changes existing Classification
api_response = api_instance.change_classification(classification_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataClassificationApi->change_classification: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_classification.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))
classification_match_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The id of the Classification Match to be changed
body = collibra_catalog_classification.ChangeClassificationMatchRequest() # ChangeClassificationMatchRequest | The properties of the Classification Match to be changed. (optional)
try:
# Changes a Classification Match
api_response = api_instance.change_classification_match(classification_match_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataClassificationApi->change_classification_match: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_classification.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))
body = [collibra_catalog_classification.ChangeClassificationMatchRequest()] # list[ChangeClassificationMatchRequest] | The list of properties of the Classification Matches to be changed. (optional)
try:
# Changes multiple Classification Matches
api_response = api_instance.change_classification_matches(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataClassificationApi->change_classification_matches: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_classification.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))
body = collibra_catalog_classification.ClassifyRequest() # ClassifyRequest | The request with data needed for running classification job. (optional)
try:
# Starts a job that classifies datasets, databases, schemas, tables or columns by external service based on sample data.
api_instance.classify(body=body)
except ApiException as e:
print("Exception when calling DataClassificationApi->classify: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_classification.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))
body = collibra_catalog_classification.FindClassificationMatchesRequest() # FindClassificationMatchesRequest | The search criteria of the Classification Matches to be found. (optional)
try:
# Finds Classification Matches
api_response = api_instance.find_classification_matches(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataClassificationApi->find_classification_matches: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_classification.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.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)
asset_ids = ['asset_ids_example'] # list[str] | The <code>id</code>s of the assets (with Column types) to filter by the search results (optional)
statuses = ['statuses_example'] # list[str] | The list of classification match statuses to filter by the search results. (optional)
classification_ids = ['classification_ids_example'] # list[str] | The list of classification ids to filter by the search results. (optional)
asset_type_ids = ['asset_type_ids_example'] # list[str] | The list of asset type ids to filter by the search results. (optional)
try:
# Finds Classification Matches
api_response = api_instance.find_classification_matches_with_params(offset=offset, limit=limit, count_limit=count_limit, asset_ids=asset_ids, statuses=statuses, classification_ids=classification_ids, asset_type_ids=asset_type_ids)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataClassificationApi->find_classification_matches_with_params: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_classification.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))
body = collibra_catalog_classification.FindClassificationsRequest() # FindClassificationsRequest | The search criteria of the Classifications to be found. (optional)
try:
# Finds Classifications
api_response = api_instance.find_classifications(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataClassificationApi->find_classifications: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_classification.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.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)
name = 'name_example' # str | The exact name of classification to filter by the search results. (optional)
try:
# Finds Classifications
api_response = api_instance.find_classifications_bulk(offset=offset, limit=limit, count_limit=count_limit, name=name)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataClassificationApi->find_classifications_bulk: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_classification.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))
classification_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |
try:
# Gets existing Classification by id.
api_instance.get_classification(classification_id)
except ApiException as e:
print("Exception when calling DataClassificationApi->get_classification: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_classification.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))
classification_match_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The id of the Classification Match to be fetched
try:
# Gets existing Classification Match by id.
api_instance.get_classification_match(classification_match_id)
except ApiException as e:
print("Exception when calling DataClassificationApi->get_classification_match: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_classification.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))
classification_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |
try:
# Removes existing Classification. WARNING: This will also remove all ClassificationMatches that are joined with this Classification!
api_instance.remove_classification(classification_id)
except ApiException as e:
print("Exception when calling DataClassificationApi->remove_classification: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_classification.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))
classification_match_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The id of the Classification Match to be deleted
try:
# Removes existing Classification Match.
api_instance.remove_classification_match(classification_match_id)
except ApiException as e:
print("Exception when calling DataClassificationApi->remove_classification_match: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_classification.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))
body = collibra_catalog_classification.DeleteClassificationMatchesRequest() # DeleteClassificationMatchesRequest | The list of Classification Match IDs to be deleted. (optional)
try:
# Removes multiple Classification Matches
api_instance.remove_classification_matches(body=body)
except ApiException as e:
print("Exception when calling DataClassificationApi->remove_classification_matches: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to */rest/catalog/1.0*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DataClassificationApi* | [**add_classification**](docs/DataClassificationApi.md#add_classification) | **POST** /dataClassification/classifications | Adds new Classification
*DataClassificationApi* | [**add_classification_match**](docs/DataClassificationApi.md#add_classification_match) | **POST** /dataClassification/classificationMatches | Adds new Classification Match
*DataClassificationApi* | [**add_classification_matches**](docs/DataClassificationApi.md#add_classification_matches) | **POST** /dataClassification/classificationMatches/bulk | Adds new Classification Matches
*DataClassificationApi* | [**change_classification**](docs/DataClassificationApi.md#change_classification) | **PATCH** /dataClassification/classifications/{classificationId} | Changes existing Classification
*DataClassificationApi* | [**change_classification_match**](docs/DataClassificationApi.md#change_classification_match) | **PATCH** /dataClassification/classificationMatches/{classificationMatchId} | Changes a Classification Match
*DataClassificationApi* | [**change_classification_matches**](docs/DataClassificationApi.md#change_classification_matches) | **PATCH** /dataClassification/classificationMatches/bulk | Changes multiple Classification Matches
*DataClassificationApi* | [**classify**](docs/DataClassificationApi.md#classify) | **POST** /dataClassification/classifications/classify | Starts a job that classifies datasets, databases, schemas, tables or columns by external service based on sample data.
*DataClassificationApi* | [**find_classification_matches**](docs/DataClassificationApi.md#find_classification_matches) | **GET** /dataClassification/classificationMatches | Finds Classification Matches
*DataClassificationApi* | [**find_classification_matches_with_params**](docs/DataClassificationApi.md#find_classification_matches_with_params) | **GET** /dataClassification/classificationMatches/bulk | Finds Classification Matches
*DataClassificationApi* | [**find_classifications**](docs/DataClassificationApi.md#find_classifications) | **GET** /dataClassification/classifications | Finds Classifications
*DataClassificationApi* | [**find_classifications_bulk**](docs/DataClassificationApi.md#find_classifications_bulk) | **GET** /dataClassification/classifications/bulk | Finds Classifications
*DataClassificationApi* | [**get_classification**](docs/DataClassificationApi.md#get_classification) | **GET** /dataClassification/classifications/{classificationId} | Gets existing Classification by id.
*DataClassificationApi* | [**get_classification_match**](docs/DataClassificationApi.md#get_classification_match) | **GET** /dataClassification/classificationMatches/{classificationMatchId} | Gets existing Classification Match by id.
*DataClassificationApi* | [**remove_classification**](docs/DataClassificationApi.md#remove_classification) | **DELETE** /dataClassification/classifications/{classificationId} | Removes existing Classification. WARNING: This will also remove all ClassificationMatches that are joined with this Classification!
*DataClassificationApi* | [**remove_classification_match**](docs/DataClassificationApi.md#remove_classification_match) | **DELETE** /dataClassification/classificationMatches/{classificationMatchId} | Removes existing Classification Match.
*DataClassificationApi* | [**remove_classification_matches**](docs/DataClassificationApi.md#remove_classification_matches) | **DELETE** /dataClassification/classificationMatches/bulk | Removes multiple Classification Matches
## Documentation For Models
- [AddClassificationMatchRequest](docs/AddClassificationMatchRequest.md)
- [AddClassificationMatchesRequest](docs/AddClassificationMatchesRequest.md)
- [AddClassificationRequest](docs/AddClassificationRequest.md)
- [ChangeClassificationMatchRequest](docs/ChangeClassificationMatchRequest.md)
- [ChangeClassificationRequest](docs/ChangeClassificationRequest.md)
- [Classification](docs/Classification.md)
- [ClassificationMatch](docs/ClassificationMatch.md)
- [ClassifyRequest](docs/ClassifyRequest.md)
- [DeleteClassificationMatchesRequest](docs/DeleteClassificationMatchesRequest.md)
- [FindClassificationMatchesRequest](docs/FindClassificationMatchesRequest.md)
- [FindClassificationsRequest](docs/FindClassificationsRequest.md)
- [Job](docs/Job.md)
- [NamedResourceReferenceImpl](docs/NamedResourceReferenceImpl.md)
- [PagedResponseClassification](docs/PagedResponseClassification.md)
- [PagedResponseClassificationMatch](docs/PagedResponseClassificationMatch.md)
## Documentation For Authorization
## basicAuth
- **Type**: HTTP basic authentication
## Author
Raw data
{
"_id": null,
"home_page": null,
"name": "collibra-catalog-classification-100",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Swagger, Collibra Catalog Classification API",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/51/3f/cb87e3244a21884338de67875615f5af6c3863cb64ee4f1fe964e4ded37a/collibra-catalog_classification_100-1.0.0.tar.gz",
"platform": null,
"description": "# collibra-catalog_classification_100\n<p>The Catalog API offers functionality related to the catalog product.<br/> It is mainly focused on facilitating the ingestion of information into Catalog. The API enables users to more easily connect Catalog to sources that are not necessarily natively supported in the product. </p>\n\nThis Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: 1.0\n- Package version: 1.0.0\n- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on Github, you can install directly from Github\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport collibra_catalog_classification \n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport collibra_catalog_classification\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\nimport time\nimport collibra_catalog_classification\nfrom collibra_catalog_classification.rest import ApiException\nfrom pprint import pprint\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_classification.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))\nbody = collibra_catalog_classification.AddClassificationRequest() # AddClassificationRequest | The request with data needed for creation of new classification. (optional)\n\ntry:\n # Adds new Classification\n api_response = api_instance.add_classification(body=body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling DataClassificationApi->add_classification: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_classification.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))\nbody = collibra_catalog_classification.AddClassificationMatchRequest() # AddClassificationMatchRequest | The request with data needed for creation of new classification match. (optional)\n\ntry:\n # Adds new Classification Match\n api_response = api_instance.add_classification_match(body=body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling DataClassificationApi->add_classification_match: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_classification.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))\nbody = collibra_catalog_classification.AddClassificationMatchesRequest() # AddClassificationMatchesRequest | The request with data needed for creation of new classification matches. (optional)\n\ntry:\n # Adds new Classification Matches\n api_response = api_instance.add_classification_matches(body=body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling DataClassificationApi->add_classification_matches: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_classification.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))\nclassification_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The id of the Classification to be changed\nbody = collibra_catalog_classification.ChangeClassificationRequest() # ChangeClassificationRequest | The properties of the Classification to be changed. (optional)\n\ntry:\n # Changes existing Classification\n api_response = api_instance.change_classification(classification_id, body=body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling DataClassificationApi->change_classification: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_classification.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))\nclassification_match_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The id of the Classification Match to be changed\nbody = collibra_catalog_classification.ChangeClassificationMatchRequest() # ChangeClassificationMatchRequest | The properties of the Classification Match to be changed. (optional)\n\ntry:\n # Changes a Classification Match\n api_response = api_instance.change_classification_match(classification_match_id, body=body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling DataClassificationApi->change_classification_match: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_classification.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))\nbody = [collibra_catalog_classification.ChangeClassificationMatchRequest()] # list[ChangeClassificationMatchRequest] | The list of properties of the Classification Matches to be changed. (optional)\n\ntry:\n # Changes multiple Classification Matches\n api_response = api_instance.change_classification_matches(body=body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling DataClassificationApi->change_classification_matches: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_classification.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))\nbody = collibra_catalog_classification.ClassifyRequest() # ClassifyRequest | The request with data needed for running classification job. (optional)\n\ntry:\n # Starts a job that classifies datasets, databases, schemas, tables or columns by external service based on sample data.\n api_instance.classify(body=body)\nexcept ApiException as e:\n print(\"Exception when calling DataClassificationApi->classify: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_classification.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))\nbody = collibra_catalog_classification.FindClassificationMatchesRequest() # FindClassificationMatchesRequest | The search criteria of the Classification Matches to be found. (optional)\n\ntry:\n # Finds Classification Matches\n api_response = api_instance.find_classification_matches(body=body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling DataClassificationApi->find_classification_matches: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_classification.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))\noffset = 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)\nlimit = 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)\ncount_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)\nasset_ids = ['asset_ids_example'] # list[str] | The <code>id</code>s of the assets (with Column types) to filter by the search results (optional)\nstatuses = ['statuses_example'] # list[str] | The list of classification match statuses to filter by the search results. (optional)\nclassification_ids = ['classification_ids_example'] # list[str] | The list of classification ids to filter by the search results. (optional)\nasset_type_ids = ['asset_type_ids_example'] # list[str] | The list of asset type ids to filter by the search results. (optional)\n\ntry:\n # Finds Classification Matches\n api_response = api_instance.find_classification_matches_with_params(offset=offset, limit=limit, count_limit=count_limit, asset_ids=asset_ids, statuses=statuses, classification_ids=classification_ids, asset_type_ids=asset_type_ids)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling DataClassificationApi->find_classification_matches_with_params: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_classification.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))\nbody = collibra_catalog_classification.FindClassificationsRequest() # FindClassificationsRequest | The search criteria of the Classifications to be found. (optional)\n\ntry:\n # Finds Classifications\n api_response = api_instance.find_classifications(body=body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling DataClassificationApi->find_classifications: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_classification.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))\noffset = 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)\nlimit = 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)\ncount_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)\nname = 'name_example' # str | The exact name of classification to filter by the search results. (optional)\n\ntry:\n # Finds Classifications\n api_response = api_instance.find_classifications_bulk(offset=offset, limit=limit, count_limit=count_limit, name=name)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling DataClassificationApi->find_classifications_bulk: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_classification.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))\nclassification_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | \n\ntry:\n # Gets existing Classification by id.\n api_instance.get_classification(classification_id)\nexcept ApiException as e:\n print(\"Exception when calling DataClassificationApi->get_classification: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_classification.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))\nclassification_match_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The id of the Classification Match to be fetched\n\ntry:\n # Gets existing Classification Match by id.\n api_instance.get_classification_match(classification_match_id)\nexcept ApiException as e:\n print(\"Exception when calling DataClassificationApi->get_classification_match: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_classification.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))\nclassification_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | \n\ntry:\n # Removes existing Classification. WARNING: This will also remove all ClassificationMatches that are joined with this Classification!\n api_instance.remove_classification(classification_id)\nexcept ApiException as e:\n print(\"Exception when calling DataClassificationApi->remove_classification: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_classification.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))\nclassification_match_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The id of the Classification Match to be deleted\n\ntry:\n # Removes existing Classification Match.\n api_instance.remove_classification_match(classification_match_id)\nexcept ApiException as e:\n print(\"Exception when calling DataClassificationApi->remove_classification_match: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_classification.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_classification.DataClassificationApi(collibra_catalog_classification.ApiClient(configuration))\nbody = collibra_catalog_classification.DeleteClassificationMatchesRequest() # DeleteClassificationMatchesRequest | The list of Classification Match IDs to be deleted. (optional)\n\ntry:\n # Removes multiple Classification Matches\n api_instance.remove_classification_matches(body=body)\nexcept ApiException as e:\n print(\"Exception when calling DataClassificationApi->remove_classification_matches: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to */rest/catalog/1.0*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DataClassificationApi* | [**add_classification**](docs/DataClassificationApi.md#add_classification) | **POST** /dataClassification/classifications | Adds new Classification\n*DataClassificationApi* | [**add_classification_match**](docs/DataClassificationApi.md#add_classification_match) | **POST** /dataClassification/classificationMatches | Adds new Classification Match\n*DataClassificationApi* | [**add_classification_matches**](docs/DataClassificationApi.md#add_classification_matches) | **POST** /dataClassification/classificationMatches/bulk | Adds new Classification Matches\n*DataClassificationApi* | [**change_classification**](docs/DataClassificationApi.md#change_classification) | **PATCH** /dataClassification/classifications/{classificationId} | Changes existing Classification\n*DataClassificationApi* | [**change_classification_match**](docs/DataClassificationApi.md#change_classification_match) | **PATCH** /dataClassification/classificationMatches/{classificationMatchId} | Changes a Classification Match\n*DataClassificationApi* | [**change_classification_matches**](docs/DataClassificationApi.md#change_classification_matches) | **PATCH** /dataClassification/classificationMatches/bulk | Changes multiple Classification Matches\n*DataClassificationApi* | [**classify**](docs/DataClassificationApi.md#classify) | **POST** /dataClassification/classifications/classify | Starts a job that classifies datasets, databases, schemas, tables or columns by external service based on sample data.\n*DataClassificationApi* | [**find_classification_matches**](docs/DataClassificationApi.md#find_classification_matches) | **GET** /dataClassification/classificationMatches | Finds Classification Matches\n*DataClassificationApi* | [**find_classification_matches_with_params**](docs/DataClassificationApi.md#find_classification_matches_with_params) | **GET** /dataClassification/classificationMatches/bulk | Finds Classification Matches\n*DataClassificationApi* | [**find_classifications**](docs/DataClassificationApi.md#find_classifications) | **GET** /dataClassification/classifications | Finds Classifications\n*DataClassificationApi* | [**find_classifications_bulk**](docs/DataClassificationApi.md#find_classifications_bulk) | **GET** /dataClassification/classifications/bulk | Finds Classifications\n*DataClassificationApi* | [**get_classification**](docs/DataClassificationApi.md#get_classification) | **GET** /dataClassification/classifications/{classificationId} | Gets existing Classification by id.\n*DataClassificationApi* | [**get_classification_match**](docs/DataClassificationApi.md#get_classification_match) | **GET** /dataClassification/classificationMatches/{classificationMatchId} | Gets existing Classification Match by id.\n*DataClassificationApi* | [**remove_classification**](docs/DataClassificationApi.md#remove_classification) | **DELETE** /dataClassification/classifications/{classificationId} | Removes existing Classification. WARNING: This will also remove all ClassificationMatches that are joined with this Classification!\n*DataClassificationApi* | [**remove_classification_match**](docs/DataClassificationApi.md#remove_classification_match) | **DELETE** /dataClassification/classificationMatches/{classificationMatchId} | Removes existing Classification Match.\n*DataClassificationApi* | [**remove_classification_matches**](docs/DataClassificationApi.md#remove_classification_matches) | **DELETE** /dataClassification/classificationMatches/bulk | Removes multiple Classification Matches\n\n## Documentation For Models\n\n - [AddClassificationMatchRequest](docs/AddClassificationMatchRequest.md)\n - [AddClassificationMatchesRequest](docs/AddClassificationMatchesRequest.md)\n - [AddClassificationRequest](docs/AddClassificationRequest.md)\n - [ChangeClassificationMatchRequest](docs/ChangeClassificationMatchRequest.md)\n - [ChangeClassificationRequest](docs/ChangeClassificationRequest.md)\n - [Classification](docs/Classification.md)\n - [ClassificationMatch](docs/ClassificationMatch.md)\n - [ClassifyRequest](docs/ClassifyRequest.md)\n - [DeleteClassificationMatchesRequest](docs/DeleteClassificationMatchesRequest.md)\n - [FindClassificationMatchesRequest](docs/FindClassificationMatchesRequest.md)\n - [FindClassificationsRequest](docs/FindClassificationsRequest.md)\n - [Job](docs/Job.md)\n - [NamedResourceReferenceImpl](docs/NamedResourceReferenceImpl.md)\n - [PagedResponseClassification](docs/PagedResponseClassification.md)\n - [PagedResponseClassificationMatch](docs/PagedResponseClassificationMatch.md)\n\n## Documentation For Authorization\n\n\n## basicAuth\n\n- **Type**: HTTP basic authentication\n\n\n## Author\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Collibra Catalog Classification API",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [
"swagger",
" collibra catalog classification api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b2f7a64ec6163a1fd05076084f6da8d686a440e9a8d728b928125d609d744ea3",
"md5": "f28d41f0f2e419e13edda589cd10e994",
"sha256": "4232e53eb5343ee6c4d78993fdb885e402d2a2468bd71561d037259447ba5279"
},
"downloads": -1,
"filename": "collibra_catalog_classification_100-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f28d41f0f2e419e13edda589cd10e994",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 64373,
"upload_time": "2024-06-24T17:53:35",
"upload_time_iso_8601": "2024-06-24T17:53:35.943972Z",
"url": "https://files.pythonhosted.org/packages/b2/f7/a64ec6163a1fd05076084f6da8d686a440e9a8d728b928125d609d744ea3/collibra_catalog_classification_100-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "513fcb87e3244a21884338de67875615f5af6c3863cb64ee4f1fe964e4ded37a",
"md5": "76b2b1afb0b972bb940b8b9d1c134afd",
"sha256": "08fe72f5cacecefe8c66916fcf5d0ea72cd1608e9dfe2bebfa563f4abb5adce6"
},
"downloads": -1,
"filename": "collibra-catalog_classification_100-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "76b2b1afb0b972bb940b8b9d1c134afd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 32446,
"upload_time": "2024-06-24T17:53:37",
"upload_time_iso_8601": "2024-06-24T17:53:37.659709Z",
"url": "https://files.pythonhosted.org/packages/51/3f/cb87e3244a21884338de67875615f5af6c3863cb64ee4f1fe964e4ded37a/collibra-catalog_classification_100-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-24 17:53:37",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "collibra-catalog-classification-100"
}
JSON