# collibra-catalog_classification_200
Version 2 of the Catalog Classification API offers functionality related to the classification process and facilitates searching for and managing the associations between a data class and a data category. Use version 1 of the API for managing classifications and legacy data classes.
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: 2.0.0-unstable
- 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
```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.ClassificationDataCategoryApi(collibra_catalog_classification.ApiClient(configuration))
data_class_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the data class to which the data category will be associated.
body = 'body_example' # str | The ID of the data category to be associated with the data class. (optional)
try:
# Associate data class with data category
api_response = api_instance.connect_data_category_data_class(data_class_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ClassificationDataCategoryApi->connect_data_category_data_class: %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.ClassificationDataCategoryApi(collibra_catalog_classification.ApiClient(configuration))
data_class_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the data class from which the data category will be removed.
data_category_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the data category to be removed.
try:
# Remove existing association between a data class and a data category
api_instance.disconnect_data_category_data_class(data_class_id, data_category_id)
except ApiException as e:
print("Exception when calling ClassificationDataCategoryApi->disconnect_data_category_data_class: %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.ClassificationDataCategoryApi(collibra_catalog_classification.ApiClient(configuration))
data_category_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the data category for which you want to see the associated data classes. (optional)
data_class_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the data class for which you want to see the associated data categories. (optional)
offset = 0 # int | The index of the first result to retrieve. If not set (offset = <code>0</code>), results are retrieved starting from row <code>0</code>. (optional) (default to 0)
limit = 0 # int | The maximum number of results to retrieve. If not set, the default limit (limit = <code>0</code>) is used. The maximum value for this parameter is <code>1000<code>. (optional) (default to 0)
try:
# Retrieve the association with a data category and a data class.
api_response = api_instance.get_association_data_class_data_category(data_category_id=data_category_id, data_class_id=data_class_id, offset=offset, limit=limit)
pprint(api_response)
except ApiException as e:
print("Exception when calling ClassificationDataCategoryApi->get_association_data_class_data_category: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to */rest/catalogClassification/v2*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ClassificationDataCategoryApi* | [**connect_data_category_data_class**](docs/ClassificationDataCategoryApi.md#connect_data_category_data_class) | **POST** /dataClasses/{dataClassId}/dataCategories | Associate data class with data category
*ClassificationDataCategoryApi* | [**disconnect_data_category_data_class**](docs/ClassificationDataCategoryApi.md#disconnect_data_category_data_class) | **DELETE** /dataClasses/{dataClassId}/dataCategories/{dataCategoryId} | Remove existing association between a data class and a data category
*ClassificationDataCategoryApi* | [**get_association_data_class_data_category**](docs/ClassificationDataCategoryApi.md#get_association_data_class_data_category) | **GET** /dataClasses/dataCategories | Retrieve the association with a data category and a data class.
*ClassificationProcessApi* | [**start_classification_process**](docs/ClassificationProcessApi.md#start_classification_process) | **POST** /classify | Starts a process that classifies requested assets.
## Documentation For Models
- [Classification](docs/Classification.md)
- [ClassificationProcessRequest](docs/ClassificationProcessRequest.md)
- [ClassificationProcessResponse](docs/ClassificationProcessResponse.md)
- [DataClassDataCategoryConnection](docs/DataClassDataCategoryConnection.md)
- [DataClassDataCategoryConnectionsPagedResponse](docs/DataClassDataCategoryConnectionsPagedResponse.md)
- [NamedResourceReferenceImpl](docs/NamedResourceReferenceImpl.md)
- [ResourceType](docs/ResourceType.md)
- [StandardErrorResponse](docs/StandardErrorResponse.md)
## Documentation For Authorization
## basicAuth
- **Type**: HTTP basic authentication
## Author
Raw data
{
"_id": null,
"home_page": null,
"name": "collibra-catalog-classification-200",
"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/fc/48/10cdbad60b8f130e19f68d73979b4e68fc8d0f708539d23e923c16f1bc12/collibra-catalog_classification_200-2.0.0.tar.gz",
"platform": null,
"description": "# collibra-catalog_classification_200\nVersion 2 of the Catalog Classification API offers functionality related to the classification process and facilitates searching for and managing the associations between a data class and a data category. Use version 1 of the API for managing classifications and legacy data classes. \n\nThis Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: 2.0.0-unstable\n- Package version: 2.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.ClassificationDataCategoryApi(collibra_catalog_classification.ApiClient(configuration))\ndata_class_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the data class to which the data category will be associated.\nbody = 'body_example' # str | The ID of the data category to be associated with the data class. (optional)\n\ntry:\n # Associate data class with data category\n api_response = api_instance.connect_data_category_data_class(data_class_id, body=body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling ClassificationDataCategoryApi->connect_data_category_data_class: %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.ClassificationDataCategoryApi(collibra_catalog_classification.ApiClient(configuration))\ndata_class_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the data class from which the data category will be removed.\ndata_category_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the data category to be removed.\n\ntry:\n # Remove existing association between a data class and a data category\n api_instance.disconnect_data_category_data_class(data_class_id, data_category_id)\nexcept ApiException as e:\n print(\"Exception when calling ClassificationDataCategoryApi->disconnect_data_category_data_class: %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.ClassificationDataCategoryApi(collibra_catalog_classification.ApiClient(configuration))\ndata_category_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the data category for which you want to see the associated data classes. (optional)\ndata_class_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the data class for which you want to see the associated data categories. (optional)\noffset = 0 # int | The index of the first result to retrieve. If not set (offset = <code>0</code>), results are retrieved starting from row <code>0</code>. (optional) (default to 0)\nlimit = 0 # int | The maximum number of results to retrieve. If not set, the default limit (limit = <code>0</code>) is used. The maximum value for this parameter is <code>1000<code>. (optional) (default to 0)\n\ntry:\n # Retrieve the association with a data category and a data class.\n api_response = api_instance.get_association_data_class_data_category(data_category_id=data_category_id, data_class_id=data_class_id, offset=offset, limit=limit)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling ClassificationDataCategoryApi->get_association_data_class_data_category: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to */rest/catalogClassification/v2*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ClassificationDataCategoryApi* | [**connect_data_category_data_class**](docs/ClassificationDataCategoryApi.md#connect_data_category_data_class) | **POST** /dataClasses/{dataClassId}/dataCategories | Associate data class with data category\n*ClassificationDataCategoryApi* | [**disconnect_data_category_data_class**](docs/ClassificationDataCategoryApi.md#disconnect_data_category_data_class) | **DELETE** /dataClasses/{dataClassId}/dataCategories/{dataCategoryId} | Remove existing association between a data class and a data category\n*ClassificationDataCategoryApi* | [**get_association_data_class_data_category**](docs/ClassificationDataCategoryApi.md#get_association_data_class_data_category) | **GET** /dataClasses/dataCategories | Retrieve the association with a data category and a data class.\n*ClassificationProcessApi* | [**start_classification_process**](docs/ClassificationProcessApi.md#start_classification_process) | **POST** /classify | Starts a process that classifies requested assets.\n\n## Documentation For Models\n\n - [Classification](docs/Classification.md)\n - [ClassificationProcessRequest](docs/ClassificationProcessRequest.md)\n - [ClassificationProcessResponse](docs/ClassificationProcessResponse.md)\n - [DataClassDataCategoryConnection](docs/DataClassDataCategoryConnection.md)\n - [DataClassDataCategoryConnectionsPagedResponse](docs/DataClassDataCategoryConnectionsPagedResponse.md)\n - [NamedResourceReferenceImpl](docs/NamedResourceReferenceImpl.md)\n - [ResourceType](docs/ResourceType.md)\n - [StandardErrorResponse](docs/StandardErrorResponse.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": "2.0.0",
"project_urls": null,
"split_keywords": [
"swagger",
" collibra catalog classification api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5a1c316ab2d16a76aa24919e54377ee613bbfc7ae517e5fe7c1e1f3673b0a36d",
"md5": "b1306636e0c0dbf110c79b70ea42c919",
"sha256": "b9ac2bcab19bde389bba39e1c8b9911aed93a15efbc8a5d42cf8989a7a42a9b0"
},
"downloads": -1,
"filename": "collibra_catalog_classification_200-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b1306636e0c0dbf110c79b70ea42c919",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 42422,
"upload_time": "2024-06-24T17:53:49",
"upload_time_iso_8601": "2024-06-24T17:53:49.270771Z",
"url": "https://files.pythonhosted.org/packages/5a/1c/316ab2d16a76aa24919e54377ee613bbfc7ae517e5fe7c1e1f3673b0a36d/collibra_catalog_classification_200-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fc4810cdbad60b8f130e19f68d73979b4e68fc8d0f708539d23e923c16f1bc12",
"md5": "099dbee92a13b92817813654b93f168a",
"sha256": "d092451d6dfd02c0c61f6e65ff444233987c0933e6b625a41c8c47afc857898f"
},
"downloads": -1,
"filename": "collibra-catalog_classification_200-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "099dbee92a13b92817813654b93f168a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 22555,
"upload_time": "2024-06-24T17:53:51",
"upload_time_iso_8601": "2024-06-24T17:53:51.010310Z",
"url": "https://files.pythonhosted.org/packages/fc/48/10cdbad60b8f130e19f68d73979b4e68fc8d0f708539d23e923c16f1bc12/collibra-catalog_classification_200-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-24 17:53:51",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "collibra-catalog-classification-200"
}
JSON