# collibra-search_200
<p>The Search API allows you to create your own integration with the Collibra Search Engine.<br /> Find your data!</p>
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/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
```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_search
```
### 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_search
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import collibra_search
from collibra_search.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = collibra_search.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_search.SearchApi(collibra_search.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 search term for a search view to retrieve.<br /> The query is case sensitive and does not support wildcards.<br /> Use in conjunction with `nameMatchMode`. (optional)
name_match_mode = 'ANYWHERE' # str | The match requirements for `name` queries.<br /> Works in conjunction with `name`. The search is case-sensitive. (optional) (default to ANYWHERE)
sort_field = 'NAME' # str | The reference field for sorting the results. (optional) (default to NAME)
sort_order = 'ASC' # str | The order in which the results are sorted. (optional) (default to ASC)
try:
# Lists search views.
api_response = api_instance.find_views(offset=offset, limit=limit, count_limit=count_limit, name=name, name_match_mode=name_match_mode, sort_field=sort_field, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->find_views: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_search.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_search.SearchApi(collibra_search.ApiClient(configuration))
view_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the search view to be queried.
try:
# Returns the details of an existing search view.
api_response = api_instance.get_view(view_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->get_view: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_search.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_search.SearchApi(collibra_search.ApiClient(configuration))
body = collibra_search.SearchRequest() # SearchRequest | The search criteria. (optional)
try:
# Search.
api_response = api_instance.search(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->search: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to */rest/2.0*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*SearchApi* | [**find_views**](docs/SearchApi.md#find_views) | **GET** /search/views | Lists search views.
*SearchApi* | [**get_view**](docs/SearchApi.md#get_view) | **GET** /search/views/{viewId} | Returns the details of an existing search view.
*SearchApi* | [**search**](docs/SearchApi.md#search) | **POST** /search | Search.
## Documentation For Models
- [FindSearchViewsRequest](docs/FindSearchViewsRequest.md)
- [PagedResponseSearchView](docs/PagedResponseSearchView.md)
- [SearchAggregation](docs/SearchAggregation.md)
- [SearchAssetResultResource](docs/SearchAssetResultResource.md)
- [SearchCommunityResultResource](docs/SearchCommunityResultResource.md)
- [SearchDomainResultResource](docs/SearchDomainResultResource.md)
- [SearchFilter](docs/SearchFilter.md)
- [SearchHighlight](docs/SearchHighlight.md)
- [SearchInFields](docs/SearchInFields.md)
- [SearchRequest](docs/SearchRequest.md)
- [SearchResponse](docs/SearchResponse.md)
- [SearchResponseAggregation](docs/SearchResponseAggregation.md)
- [SearchResponseAggregationValue](docs/SearchResponseAggregationValue.md)
- [SearchResult](docs/SearchResult.md)
- [SearchResultHighlight](docs/SearchResultHighlight.md)
- [SearchResultResource](docs/SearchResultResource.md)
- [SearchResultStatus](docs/SearchResultStatus.md)
- [SearchResultType](docs/SearchResultType.md)
- [SearchUserGroupResultResource](docs/SearchUserGroupResultResource.md)
- [SearchUserResultResource](docs/SearchUserResultResource.md)
- [SearchView](docs/SearchView.md)
- [SearchViewPagedResponse](docs/SearchViewPagedResponse.md)
## Documentation For Authorization
## basicAuth
- **Type**: HTTP basic authentication
## Author
Raw data
{
"_id": null,
"home_page": null,
"name": "collibra-search-200",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Swagger, Collibra Search API",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/36/e3/e241bf97f400e3600b5e1552992e6f80c8a282dd096af0ea18bfc4bedd33/collibra-search_200-2.0.0.tar.gz",
"platform": null,
"description": "# collibra-search_200\n<p>The Search API allows you to create your own integration with the Collibra Search Engine.<br /> Find your data!</p>\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\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_search \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_search\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_search\nfrom collibra_search.rest import ApiException\nfrom pprint import pprint\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_search.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_search.SearchApi(collibra_search.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 search term for a search view to retrieve.<br /> The query is case sensitive and does not support wildcards.<br /> Use in conjunction with `nameMatchMode`. (optional)\nname_match_mode = 'ANYWHERE' # str | The match requirements for `name` queries.<br /> Works in conjunction with `name`. The search is case-sensitive. (optional) (default to ANYWHERE)\nsort_field = 'NAME' # str | The reference field for sorting the results. (optional) (default to NAME)\nsort_order = 'ASC' # str | The order in which the results are sorted. (optional) (default to ASC)\n\ntry:\n # Lists search views.\n api_response = api_instance.find_views(offset=offset, limit=limit, count_limit=count_limit, name=name, name_match_mode=name_match_mode, sort_field=sort_field, sort_order=sort_order)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling SearchApi->find_views: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_search.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_search.SearchApi(collibra_search.ApiClient(configuration))\nview_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the search view to be queried.\n\ntry:\n # Returns the details of an existing search view.\n api_response = api_instance.get_view(view_id)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling SearchApi->get_view: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_search.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_search.SearchApi(collibra_search.ApiClient(configuration))\nbody = collibra_search.SearchRequest() # SearchRequest | The search criteria. (optional)\n\ntry:\n # Search.\n api_response = api_instance.search(body=body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling SearchApi->search: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to */rest/2.0*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*SearchApi* | [**find_views**](docs/SearchApi.md#find_views) | **GET** /search/views | Lists search views.\n*SearchApi* | [**get_view**](docs/SearchApi.md#get_view) | **GET** /search/views/{viewId} | Returns the details of an existing search view.\n*SearchApi* | [**search**](docs/SearchApi.md#search) | **POST** /search | Search.\n\n## Documentation For Models\n\n - [FindSearchViewsRequest](docs/FindSearchViewsRequest.md)\n - [PagedResponseSearchView](docs/PagedResponseSearchView.md)\n - [SearchAggregation](docs/SearchAggregation.md)\n - [SearchAssetResultResource](docs/SearchAssetResultResource.md)\n - [SearchCommunityResultResource](docs/SearchCommunityResultResource.md)\n - [SearchDomainResultResource](docs/SearchDomainResultResource.md)\n - [SearchFilter](docs/SearchFilter.md)\n - [SearchHighlight](docs/SearchHighlight.md)\n - [SearchInFields](docs/SearchInFields.md)\n - [SearchRequest](docs/SearchRequest.md)\n - [SearchResponse](docs/SearchResponse.md)\n - [SearchResponseAggregation](docs/SearchResponseAggregation.md)\n - [SearchResponseAggregationValue](docs/SearchResponseAggregationValue.md)\n - [SearchResult](docs/SearchResult.md)\n - [SearchResultHighlight](docs/SearchResultHighlight.md)\n - [SearchResultResource](docs/SearchResultResource.md)\n - [SearchResultStatus](docs/SearchResultStatus.md)\n - [SearchResultType](docs/SearchResultType.md)\n - [SearchUserGroupResultResource](docs/SearchUserGroupResultResource.md)\n - [SearchUserResultResource](docs/SearchUserResultResource.md)\n - [SearchView](docs/SearchView.md)\n - [SearchViewPagedResponse](docs/SearchViewPagedResponse.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 Search API",
"version": "2.0.0",
"project_urls": null,
"split_keywords": [
"swagger",
" collibra search api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3238dfe759155dae9b6d7b9d01f7926efcc994cdc4eca869039a4610c9bfd10e",
"md5": "6a81e57b0884ec6b590a056c95eceb4b",
"sha256": "ae07c29a98f4c4cdceea7828501380b16e2684f6c7273befe9b9e0e378b52491"
},
"downloads": -1,
"filename": "collibra_search_200-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6a81e57b0884ec6b590a056c95eceb4b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 68199,
"upload_time": "2024-06-24T18:00:18",
"upload_time_iso_8601": "2024-06-24T18:00:18.090949Z",
"url": "https://files.pythonhosted.org/packages/32/38/dfe759155dae9b6d7b9d01f7926efcc994cdc4eca869039a4610c9bfd10e/collibra_search_200-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "36e3e241bf97f400e3600b5e1552992e6f80c8a282dd096af0ea18bfc4bedd33",
"md5": "2d89ec2e33c2110b70575563584ae6b0",
"sha256": "9a7dad435d1fed3037fdbd355124d75aab80fefda4d7786fa7c5bfebbf15ec8f"
},
"downloads": -1,
"filename": "collibra-search_200-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "2d89ec2e33c2110b70575563584ae6b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29299,
"upload_time": "2024-06-24T18:00:19",
"upload_time_iso_8601": "2024-06-24T18:00:19.795440Z",
"url": "https://files.pythonhosted.org/packages/36/e3/e241bf97f400e3600b5e1552992e6f80c8a282dd096af0ea18bfc4bedd33/collibra-search_200-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-24 18:00:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "collibra-search-200"
}
JSON