All URIs are relative to http://localhost/rest/2.0
Method | HTTP request | Description |
---|---|---|
add_relation | POST /relations | Adds a new relation. |
add_relations | POST /relations/bulk | Adds multiple relations in one go. |
change_relation | PATCH /relations/{relationId} | Changes the relation with the information that is present in the request. |
change_relations | PATCH /relations/bulk | Changes multiple relations. |
find_relations | GET /relations | Returns relations matching the given search criteria. |
get_relation | GET /relations/{relationId} | Returns a relation identified by given id. |
remove_relation | DELETE /relations/{relationId} | Removes a relation identified by given id. |
remove_relation1 | DELETE /relations/bulk | Removes multiple relations. |
RelationImpl add_relation(add_relation_request=add_relation_request)
Adds a new relation.
Adds a new relation.
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
host = "http://localhost/rest/2.0"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure HTTP basic authorization: basicAuth
configuration = collibra_core.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = collibra_core.RelationsApi(api_client)
add_relation_request = collibra_core.AddRelationRequest() # AddRelationRequest | The properties of the relation to be added (optional)
try:
# Adds a new relation.
api_response = api_instance.add_relation(add_relation_request=add_relation_request)
pprint(api_response)
except ApiException as e:
print("Exception when calling RelationsApi->add_relation: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
add_relation_request | AddRelationRequest | The properties of the relation to be added | [optional] |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | Relation successfully added. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[RelationImpl] add_relations(add_relation_request=add_relation_request)
Adds multiple relations in one go.
Adds multiple relations in one gos.
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
host = "http://localhost/rest/2.0"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure HTTP basic authorization: basicAuth
configuration = collibra_core.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = collibra_core.RelationsApi(api_client)
add_relation_request = [collibra_core.AddRelationRequest()] # list[AddRelationRequest] | List of the properties of the relations to be added. (optional)
try:
# Adds multiple relations in one go.
api_response = api_instance.add_relations(add_relation_request=add_relation_request)
pprint(api_response)
except ApiException as e:
print("Exception when calling RelationsApi->add_relations: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
add_relation_request | list[AddRelationRequest] | List of the properties of the relations to be added. | [optional] |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | Relations successfully added. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RelationImpl change_relation(relation_id, change_relation_request=change_relation_request)
Changes the relation with the information that is present in the request.
Changes the relation with the information that is present in the request. Only properties that are specified in this request and have not null
values are updated. All other properties are ignored.
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
host = "http://localhost/rest/2.0"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure HTTP basic authorization: basicAuth
configuration = collibra_core.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = collibra_core.RelationsApi(api_client)
relation_id = 'relation_id_example' # str | The ID of the relation to be changed.
change_relation_request = collibra_core.ChangeRelationRequest() # ChangeRelationRequest | The properties of the relation to be changed. (optional)
try:
# Changes the relation with the information that is present in the request.
api_response = api_instance.change_relation(relation_id, change_relation_request=change_relation_request)
pprint(api_response)
except ApiException as e:
print("Exception when calling RelationsApi->change_relation: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
relation_id | str | The ID of the relation to be changed. | |
change_relation_request | ChangeRelationRequest | The properties of the relation to be changed. | [optional] |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | The changed relation. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[RelationImpl] change_relations(change_relation_request=change_relation_request)
Changes multiple relations.
Changes multiple relations.
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
host = "http://localhost/rest/2.0"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure HTTP basic authorization: basicAuth
configuration = collibra_core.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = collibra_core.RelationsApi(api_client)
change_relation_request = [collibra_core.ChangeRelationRequest()] # list[ChangeRelationRequest] | The list of properties of the relations to be changed. (optional)
try:
# Changes multiple relations.
api_response = api_instance.change_relations(change_relation_request=change_relation_request)
pprint(api_response)
except ApiException as e:
print("Exception when calling RelationsApi->change_relations: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
change_relation_request | list[ChangeRelationRequest] | The list of properties of the relations to be changed. | [optional] |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | The relations have been changed successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RelationPagedResponse find_relations(offset=offset, limit=limit, relation_type_id=relation_type_id, source_id=source_id, target_id=target_id, source_target_logical_operator=source_target_logical_operator)
Returns relations matching the given search criteria.
Returns relations matching the given search criteria. Only parameters that are specified in this request and have not null
values are used for filtering. All other parameters are ignored. The returned relations satisfy all constraints that are specified in this search criteria. By default a result containing 1000 relations is returned.
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
host = "http://localhost/rest/2.0"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure HTTP basic authorization: basicAuth
configuration = collibra_core.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = collibra_core.RelationsApi(api_client)
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. (optional) (default to 0)
relation_type_id = 'relation_type_id_example' # str | The ID of the type of relations to search for. (optional)
source_id = 'source_id_example' # str | The ID of the source of relations to search for. (optional)
target_id = 'target_id_example' # str | The ID of the target of relations to search for. (optional)
source_target_logical_operator = 'AND' # str | The logical operator determining how to combine the source and target criteria: AND or OR. (optional) (default to 'AND')
try:
# Returns relations matching the given search criteria.
api_response = api_instance.find_relations(offset=offset, limit=limit, relation_type_id=relation_type_id, source_id=source_id, target_id=target_id, source_target_logical_operator=source_target_logical_operator)
pprint(api_response)
except ApiException as e:
print("Exception when calling RelationsApi->find_relations: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
offset | 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 | int | The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used. | [optional] [default to 0] |
relation_type_id | str | The ID of the type of relations to search for. | [optional] |
source_id | str | The ID of the source of relations to search for. | [optional] |
target_id | str | The ID of the target of relations to search for. | [optional] |
source_target_logical_operator | str | The logical operator determining how to combine the source and target criteria: AND or OR. | [optional] [default to 'AND'] |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | The paged response with found relations. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RelationImpl get_relation(relation_id)
Returns a relation identified by given id.
Returns a relation identified by given id.
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
host = "http://localhost/rest/2.0"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure HTTP basic authorization: basicAuth
configuration = collibra_core.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = collibra_core.RelationsApi(api_client)
relation_id = 'relation_id_example' # str | the ID of the relation
try:
# Returns a relation identified by given id.
api_response = api_instance.get_relation(relation_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling RelationsApi->get_relation: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
relation_id | str | the ID of the relation |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | The found relation. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
remove_relation(relation_id)
Removes a relation identified by given id.
Removes a relation identified by given id.
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
host = "http://localhost/rest/2.0"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure HTTP basic authorization: basicAuth
configuration = collibra_core.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = collibra_core.RelationsApi(api_client)
relation_id = 'relation_id_example' # str | the ID of the relation to remove
try:
# Removes a relation identified by given id.
api_instance.remove_relation(relation_id)
except ApiException as e:
print("Exception when calling RelationsApi->remove_relation: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
relation_id | str | the ID of the relation to remove |
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
Status code | Description | Response headers |
---|---|---|
204 | The relation has been removed successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
remove_relation1(request_body=request_body)
Removes multiple relations.
Removes multiple relations.
- Basic Authentication (basicAuth):
from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
host = "http://localhost/rest/2.0"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure HTTP basic authorization: basicAuth
configuration = collibra_core.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = collibra_core.RelationsApi(api_client)
request_body = ['request_body_example'] # list[str] | the IDs of the relations to be removed (optional)
try:
# Removes multiple relations.
api_instance.remove_relation1(request_body=request_body)
except ApiException as e:
print("Exception when calling RelationsApi->remove_relation1: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
request_body | list[str] | the IDs of the relations to be removed | [optional] |
void (empty response body)
- Content-Type: application/json
- Accept: Not defined
Status code | Description | Response headers |
---|---|---|
204 | The relations have been removed successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]