UserActivitiesApi.md

formkiq_client.UserActivitiesApi

All URIs are relative to http://localhost

Method	HTTP request	Description
get_document_user_activities	GET /documents/{documentId}/userActivities	Get user activities for a document
get_user_activities	GET /userActivities	Get user activities

get_document_user_activities

GetUserActivitesResponse get_document_user_activities(document_id, site_id=site_id, next=next, limit=limit)

Get user activities for a document

Retrieve a user's activities for a document

Example

import formkiq_client
from formkiq_client.models.get_user_activites_response import GetUserActivitesResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.UserActivitiesApi(api_client)
    document_id = 'document_id_example' # str | Document Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)
    next = 'next_example' # str | Next page of results token (optional)
    limit = '10' # str | Limit Results (optional) (default to '10')

    try:
        # Get user activities for a document
        api_response = api_instance.get_document_user_activities(document_id, site_id=site_id, next=next, limit=limit)
        print("The response of UserActivitiesApi->get_document_user_activities:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserActivitiesApi->get_document_user_activities: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	Document Identifier
site_id	str	Site Identifier	[optional]
next	str	Next page of results token	[optional]
limit	str	Limit Results	[optional] [default to '10']

Return type

GetUserActivitesResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_user_activities

GetUserActivitesResponse get_user_activities(site_id=site_id, next=next, limit=limit, user_id=user_id)

Get user activities

Retrieve a user's activities

Example

import formkiq_client
from formkiq_client.models.get_user_activites_response import GetUserActivitesResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.UserActivitiesApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier (optional)
    next = 'next_example' # str | Next page of results token (optional)
    limit = '10' # str | Limit Results (optional) (default to '10')
    user_id = 'user_id_example' # str | Fetch specific user activities (optional)

    try:
        # Get user activities
        api_response = api_instance.get_user_activities(site_id=site_id, next=next, limit=limit, user_id=user_id)
        print("The response of UserActivitiesApi->get_user_activities:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserActivitiesApi->get_user_activities: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier	[optional]
next	str	Next page of results token	[optional]
limit	str	Limit Results	[optional] [default to '10']
user_id	str	Fetch specific user activities	[optional]

Return type

GetUserActivitesResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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