Skip to content

Latest commit

 

History

History
110 lines (87 loc) · 8.08 KB

ActivitiesApi.md

File metadata and controls

110 lines (87 loc) · 8.08 KB

collibra_core.ActivitiesApi

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

Method HTTP request Description
get_activities GET /activities Returns activities matching the given search criteria.

get_activities

ActivityPagedResponse get_activities(offset=offset, limit=limit, task_id=task_id, context_id=context_id, involved_people_ids=involved_people_ids, involved_role_ids=involved_role_ids, performed_by_user_id=performed_by_user_id, performed_by_role_ids=performed_by_role_ids, activity_type=activity_type, call_id=call_id, categories=categories, resource_types=resource_types, start_date=start_date, end_date=end_date, call_count_enabled=call_count_enabled)

Returns activities matching the given search criteria.

Returns activities 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 activities satisfy all constraints that are specified in this search criteria.By default a result containing 100 activities is returned.

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.ActivitiesApi(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)
task_id = 'task_id_example' # str | The ID of the task which contains the basic find activities request. (optional)
context_id = 'context_id_example' # str | The ID of the context which the activities should be searched for. (optional)
involved_people_ids = ['involved_people_ids_example'] # list[str] | The list of IDs of the people that should be involved in searched activities. (optional)
involved_role_ids = ['involved_role_ids_example'] # list[str] | The list of IDs of the roles that should be involved in searched activities. (optional)
performed_by_user_id = 'performed_by_user_id_example' # str | The ID of the user who performed searched activities. (optional)
performed_by_role_ids = ['performed_by_role_ids_example'] # list[str] | The list of IDs of the roles assigned to users who performed searched activities. (optional)
activity_type = 'activity_type_example' # str | The type of the activity. (optional)
call_id = 'call_id_example' # str | The ID of the call. (optional)
categories = ['categories_example'] # list[str] | The set of the categories of activities that should be searched. One of [ATTRIBUTE, ATTACHMENT, RELATION, COMMENT,<br/>STATUS, WORKFLOW, RESPONSIBILITY, USER, USER_GROUP, ROLE, TAGS, OTHERS]. (optional)
resource_types = ['resource_types_example'] # list[str] | The set of the resource types that searched activities refer to, i.e. [Community, Asset, Domain, Attribute,<br/>Relation, WorkflowInstance]. (optional)
start_date = 56 # int | TThe start date of the searched activities. It is the timestamp (in UTC time standard). (optional)
end_date = 56 # int | The end date of the searched activities. It is the timestamp (in UTC time standard). (optional)
call_count_enabled = False # bool | Flag to indicate if the number of calls standing behind the activity should be returned or not.<br/>Note that by default that count will be not calculated as it brings an important performance penalty. (optional) (default to False)

    try:
        # Returns activities matching the given search criteria.
        api_response = api_instance.get_activities(offset=offset, limit=limit, task_id=task_id, context_id=context_id, involved_people_ids=involved_people_ids, involved_role_ids=involved_role_ids, performed_by_user_id=performed_by_user_id, performed_by_role_ids=performed_by_role_ids, activity_type=activity_type, call_id=call_id, categories=categories, resource_types=resource_types, start_date=start_date, end_date=end_date, call_count_enabled=call_count_enabled)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ActivitiesApi->get_activities: %s\n" % e)

Parameters

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]
task_id str The ID of the task which contains the basic find activities request. [optional]
context_id str The ID of the context which the activities should be searched for. [optional]
involved_people_ids list[str] The list of IDs of the people that should be involved in searched activities. [optional]
involved_role_ids list[str] The list of IDs of the roles that should be involved in searched activities. [optional]
performed_by_user_id str The ID of the user who performed searched activities. [optional]
performed_by_role_ids list[str] The list of IDs of the roles assigned to users who performed searched activities. [optional]
activity_type str The type of the activity. [optional]
call_id str The ID of the call. [optional]
categories list[str] The set of the categories of activities that should be searched. One of [ATTRIBUTE, ATTACHMENT, RELATION, COMMENT,<br/>STATUS, WORKFLOW, RESPONSIBILITY, USER, USER_GROUP, ROLE, TAGS, OTHERS]. [optional]
resource_types list[str] The set of the resource types that searched activities refer to, i.e. [Community, Asset, Domain, Attribute,<br/>Relation, WorkflowInstance]. [optional]
start_date int TThe start date of the searched activities. It is the timestamp (in UTC time standard). [optional]
end_date int The end date of the searched activities. It is the timestamp (in UTC time standard). [optional]
call_count_enabled bool Flag to indicate if the number of calls standing behind the activity should be returned or not.<br/>Note that by default that count will be not calculated as it brings an important performance penalty. [optional] [default to False]

Return type

ActivityPagedResponse

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 The paged response with found Activity information. The total number of results is not calculated and should be ignored -

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