Skip to content

Latest commit

 

History

History
102 lines (76 loc) · 5.52 KB

ActivitiesApi.md

File metadata and controls

102 lines (76 loc) · 5.52 KB
Raw

alfresco_core_api_client.ActivitiesApi

All URIs are relative to http://localhost/alfresco/api/-default-/public/alfresco/versions/1

Method HTTP request Description
list_activities_for_person GET /people/{personId}/activities List activities

list_activities_for_person

ActivityPaging list_activities_for_person(person_id, skip_count=skip_count, max_items=max_items, who=who, site_id=site_id, fields=fields)

List activities

Gets a list of activities for person personId. You can use the -me- string in place of <personId> to specify the currently authenticated user.

Example

  • Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.activity_paging import ActivityPaging
from alfresco_core_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost/alfresco/api/-default-/public/alfresco/versions/1
# See configuration.py for a list of all supported configuration parameters.
configuration = alfresco_core_api_client.Configuration(
    host = "http://localhost/alfresco/api/-default-/public/alfresco/versions/1"
)

# 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 = alfresco_core_api_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with alfresco_core_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = alfresco_core_api_client.ActivitiesApi(api_client)
    person_id = 'person_id_example' # str | The identifier of a person.
    skip_count = 0 # int | The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0.  (optional) (default to 0)
    max_items = 100 # int | The maximum number of items to return in the list. If not supplied then the default value is 100.  (optional) (default to 100)
    who = 'who_example' # str | A filter to include the user's activities only `me`, other user's activities only `others`'  (optional)
    site_id = 'site_id_example' # str | Include only activity feed entries relating to this site. (optional)
    fields = ['fields_example'] # List[str] | A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.  (optional)

    try:
        # List activities
        api_response = api_instance.list_activities_for_person(person_id, skip_count=skip_count, max_items=max_items, who=who, site_id=site_id, fields=fields)
        print("The response of ActivitiesApi->list_activities_for_person:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ActivitiesApi->list_activities_for_person: %s\n" % e)

Parameters

Name Type Description Notes
person_id str The identifier of a person.
skip_count int The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0. [optional] [default to 0]
max_items int The maximum number of items to return in the list. If not supplied then the default value is 100. [optional] [default to 100]
who str A filter to include the user's activities only `me`, other user's activities only `others`' [optional]
site_id str Include only activity feed entries relating to this site. [optional]
fields List[str] A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter. [optional]

Return type

ActivityPaging

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -
400 Invalid parameter: value of maxItems, skipCount, or who is invalid -
401 Authentication failed -
403 Current user does not have access to the activities for personId -
404 personId or siteId does not exist -
0 Unexpected error -

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