Collibra Search API
Project description
collibra-search_200
The Search API allows you to create your own integration with the Collibra Search Engine.
Find your 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_search
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_search
Getting Started
Please follow the installation procedure and then run the following:
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 | GET /search/views | Lists search views. |
SearchApi | get_view | GET /search/views/{viewId} | Returns the details of an existing search view. |
SearchApi | search | POST /search | Search. |
Documentation For Models
- FindSearchViewsRequest
- PagedResponseSearchView
- SearchAggregation
- SearchAssetResultResource
- SearchCommunityResultResource
- SearchDomainResultResource
- SearchFilter
- SearchHighlight
- SearchInFields
- SearchRequest
- SearchResponse
- SearchResponseAggregation
- SearchResponseAggregationValue
- SearchResult
- SearchResultHighlight
- SearchResultResource
- SearchResultStatus
- SearchResultType
- SearchUserGroupResultResource
- SearchUserResultResource
- SearchView
- SearchViewPagedResponse
Documentation For Authorization
basicAuth
- Type: HTTP basic authentication
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for collibra-search_200-2.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a7dad435d1fed3037fdbd355124d75aab80fefda4d7786fa7c5bfebbf15ec8f |
|
MD5 | 2d89ec2e33c2110b70575563584ae6b0 |
|
BLAKE2b-256 | 36e3e241bf97f400e3600b5e1552992e6f80c8a282dd096af0ea18bfc4bedd33 |
Hashes for collibra_search_200-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae07c29a98f4c4cdceea7828501380b16e2684f6c7273befe9b9e0e378b52491 |
|
MD5 | 6a81e57b0884ec6b590a056c95eceb4b |
|
BLAKE2b-256 | 3238dfe759155dae9b6d7b9d01f7926efcc994cdc4eca869039a4610c9bfd10e |