collibra_core.AssignmentsApi

All URIs are relative to http://localhost/rest/2.0

Method	HTTP request	Description
add_assignment	POST /assignments	Adds a new Assignment.
change_assignment	PATCH /assignments/{assignmentId}	Changes the assignment with the information that is provided in the request.
find_assignments_for_resource	GET /assignments/forResource	Find the assignments where a given resource is assigned.
get_assignments_for_asset	GET /assignments/asset/{assetId}	Returns the Assignment identified by the given Asset.
get_assignments_for_asset_type	GET /assignments/assetType/{assetTypeId}	Returns Assignments for given asset type id.
get_available_asset_types_for_domain	GET /assignments/domain/{domainId}/assetTypes	Returns available asset types for domain identified by given id.
get_available_attribute_types_for_asset	GET /assignments/asset/{assetId}/attributeTypes	Returns available attribute types for asset identified by given id.
get_available_complex_relation_types_for_asset	GET /assignments/asset/{assetId}/complexRelationTypes	Returns the available ComplexRelationTypes for the Asset identified by the given id.
get_available_relation_types_for_asset	GET /assignments/asset/{assetId}/relationTypes	Returns the available RelationTypes for the Asset identified by the given id.
remove_assignment	DELETE /assignments/{assignmentId}	Removes the Assignment identified by the given id.

add_assignment

AssignmentImpl add_assignment(add_assignment_request=add_assignment_request)

Adds a new Assignment.

Adds a new Assignment. This endpoint will be removed in the next major release. This feature will be dropped, so no replacement will be available.

Example

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.AssignmentsApi(api_client)
    add_assignment_request = collibra_core.AddAssignmentRequest() # AddAssignmentRequest |  (optional)

    try:
        # Adds a new Assignment.
        api_response = api_instance.add_assignment(add_assignment_request=add_assignment_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AssignmentsApi->add_assignment: %s\n" % e)

Parameters

Name	Type	Description	Notes
add_assignment_request	AddAssignmentRequest		[optional]

Return type

AssignmentImpl

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Assignment successfully added.	-
400	An assignment with the given ID already exists	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

change_assignment

AssignmentImpl change_assignment(assignment_id, change_assignment_request=change_assignment_request)

Changes the assignment with the information that is provided in the request.

Changes the assignment with the information that is provided in the request. Only properties that are specified in the request and are not NULL are updated. All other properties are ignored.

Example

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.AssignmentsApi(api_client)
    assignment_id = 'assignment_id_example' # str | The unique identifier of the Assignment.
change_assignment_request = collibra_core.ChangeAssignmentRequest() # ChangeAssignmentRequest |  (optional)

    try:
        # Changes the assignment with the information that is provided in the request.
        api_response = api_instance.change_assignment(assignment_id, change_assignment_request=change_assignment_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AssignmentsApi->change_assignment: %s\n" % e)

Parameters

Name	Type	Description	Notes
assignment_id	str	The unique identifier of the Assignment.
change_assignment_request	ChangeAssignmentRequest		[optional]

Return type

AssignmentImpl

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Assignment successfully changed.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

find_assignments_for_resource

list[AssignmentImpl] find_assignments_for_resource(resource_id=resource_id, resource_type=resource_type)

Find the assignments where a given resource is assigned.

Example

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.AssignmentsApi(api_client)
    resource_id = 'resource_id_example' # str | The ID of the resource on which the assignment applies. (optional)
resource_type = 'resource_type_example' # str | The type of resource that is assigned. (optional)

    try:
        # Find the assignments where a given resource is assigned.
        api_response = api_instance.find_assignments_for_resource(resource_id=resource_id, resource_type=resource_type)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AssignmentsApi->find_assignments_for_resource: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	str	The ID of the resource on which the assignment applies.	[optional]
resource_type	str	The type of resource that is assigned.	[optional]

Return type

list[AssignmentImpl]

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Assignments found	-
400	The parameter is invalid	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_assignments_for_asset

AssignmentImpl get_assignments_for_asset(asset_id)

Returns the Assignment identified by the given Asset.

Example

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.AssignmentsApi(api_client)
    asset_id = 'asset_id_example' # str | The unique identifier of the Asset.

    try:
        # Returns the Assignment identified by the given Asset.
        api_response = api_instance.get_assignments_for_asset(asset_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AssignmentsApi->get_assignments_for_asset: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_id	str	The unique identifier of the Asset.

Return type

AssignmentImpl

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Assignment found.	-
404	Assignment not found.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_assignments_for_asset_type

list[AssignmentImpl] get_assignments_for_asset_type(asset_type_id)

Returns Assignments for given asset type id.

Example

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.AssignmentsApi(api_client)
    asset_type_id = 'asset_type_id_example' # str | The unique identifier of the AssetType.

    try:
        # Returns Assignments for given asset type id.
        api_response = api_instance.get_assignments_for_asset_type(asset_type_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AssignmentsApi->get_assignments_for_asset_type: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_type_id	str	The unique identifier of the AssetType.

Return type

list[AssignmentImpl]

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Assignments found.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_available_asset_types_for_domain

list[AssetTypeImpl] get_available_asset_types_for_domain(domain_id)

Returns available asset types for domain identified by given id.

Example

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.AssignmentsApi(api_client)
    domain_id = 'domain_id_example' # str | The unique identifier of the Domain.

    try:
        # Returns available asset types for domain identified by given id.
        api_response = api_instance.get_available_asset_types_for_domain(domain_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AssignmentsApi->get_available_asset_types_for_domain: %s\n" % e)

Parameters

Name	Type	Description	Notes
domain_id	str	The unique identifier of the Domain.

Return type

list[AssetTypeImpl]

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	AssetTypes found.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_available_attribute_types_for_asset

list[AttributeType] get_available_attribute_types_for_asset(asset_id)

Returns available attribute types for asset identified by given id.

Example

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.AssignmentsApi(api_client)
    asset_id = 'asset_id_example' # str | The unique identifier of the Asset.

    try:
        # Returns available attribute types for asset identified by given id.
        api_response = api_instance.get_available_attribute_types_for_asset(asset_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AssignmentsApi->get_available_attribute_types_for_asset: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_id	str	The unique identifier of the Asset.

Return type

list[AttributeType]

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	AttributeTypes found.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_available_complex_relation_types_for_asset

list[ComplexRelationTypeImpl] get_available_complex_relation_types_for_asset(asset_id)

Returns the available ComplexRelationTypes for the Asset identified by the given id.

Example

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.AssignmentsApi(api_client)
    asset_id = 'asset_id_example' # str | The unique identifier of the Asset.

    try:
        # Returns the available ComplexRelationTypes for the Asset identified by the given id.
        api_response = api_instance.get_available_complex_relation_types_for_asset(asset_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AssignmentsApi->get_available_complex_relation_types_for_asset: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_id	str	The unique identifier of the Asset.

Return type

list[ComplexRelationTypeImpl]

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	ComplexRelationTypes found.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_available_relation_types_for_asset

list[RelationTypeImpl] get_available_relation_types_for_asset(asset_id)

Returns the available RelationTypes for the Asset identified by the given id.

Example

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.AssignmentsApi(api_client)
    asset_id = 'asset_id_example' # str | The unique identifier of the Asset.

    try:
        # Returns the available RelationTypes for the Asset identified by the given id.
        api_response = api_instance.get_available_relation_types_for_asset(asset_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AssignmentsApi->get_available_relation_types_for_asset: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_id	str	The unique identifier of the Asset.

Return type

list[RelationTypeImpl]

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	RelationTypes found.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_assignment

remove_assignment(assignment_id)

Removes the Assignment identified by the given id.

Removes the Assignment identified by the given id. This endpoint will be removed in the next major release. This feature will be dropped, so no replacement will be available.

Example

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.AssignmentsApi(api_client)
    assignment_id = 'assignment_id_example' # str | The unique identifier of the Assignment.

    try:
        # Removes the Assignment identified by the given id.
        api_instance.remove_assignment(assignment_id)
    except ApiException as e:
        print("Exception when calling AssignmentsApi->remove_assignment: %s\n" % e)

Parameters

Name	Type	Description	Notes
assignment_id	str	The unique identifier of the Assignment.

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Assignment removed.	-
404	Assignment not found.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

AssignmentsApi.md

Latest commit

History

AssignmentsApi.md

File metadata and controls

collibra_core.AssignmentsApi

add_assignment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

change_assignment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_assignments_for_resource

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_assignments_for_asset

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_assignments_for_asset_type

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_available_asset_types_for_domain

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_available_attribute_types_for_asset

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_available_complex_relation_types_for_asset

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_available_relation_types_for_asset

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_assignment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details