Skip to content

Latest commit

 

History

History
72 lines (53 loc) · 3.88 KB

AuditReasonsApi.md

File metadata and controls

72 lines (53 loc) · 3.88 KB

laserfiche_api.AuditReasonsApi

All URIs are relative to https://api.laserfiche.com/repository

Method HTTP request Description
list_audit_reasons GET /v2/Repositories/{repositoryId}/AuditReasons Returns the audit reasons associated with the authenticated user.

list_audit_reasons

AuditReasonCollectionResponse list_audit_reasons(repository_id, prefer=prefer, select=select, orderby=orderby, top=top, skip=skip, count=count)

Returns the audit reasons associated with the authenticated user.

  • Returns the audit reasons associated with the authenticated user. Inherited audit reasons are included. - Only includes audit reasons associated with available API functionalities, like delete entry and export document. - If the authenticated user does not have the appropriate Laserfiche feature right, the audit reasons associated with that feature right will not be included. - Required OAuth scope: repository.Read

Example

from __future__ import print_function
import time
import laserfiche_api
from laserfiche_api.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2 Authorization Code Flow
configuration = laserfiche_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = laserfiche_api.AuditReasonsApi(laserfiche_api.ApiClient(configuration))
repository_id = 'repository_id_example' # str | The requested repository ID.
prefer = 'prefer_example' # str | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. (optional)
select = 'select_example' # str | Limits the properties returned in the result. (optional)
orderby = 'orderby_example' # str | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
top = 56 # int | Limits the number of items returned from a collection. (optional)
skip = 56 # int | Excludes the specified number of items of the queried collection from the result. (optional)
count = true # bool | Indicates whether the total count of items within a collection are returned in the result. (optional)

try:
    # Returns the audit reasons associated with the authenticated user.
    api_response = api_instance.list_audit_reasons(repository_id, prefer=prefer, select=select, orderby=orderby, top=top, skip=skip, count=count)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuditReasonsApi->list_audit_reasons: %s\n" % e)

Parameters

Name Type Description Notes
repository_id str The requested repository ID.
prefer str An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. [optional]
select str Limits the properties returned in the result. [optional]
orderby str Specifies the order in which items are returned. The maximum number of expressions is 5. [optional]
top int Limits the number of items returned from a collection. [optional]
skip int Excludes the specified number of items of the queried collection from the result. [optional]
count bool Indicates whether the total count of items within a collection are returned in the result. [optional]

Return type

AuditReasonCollectionResponse

Authorization

Authorization, [OAuth2 Authorization Code Flow](../README.md#OAuth2 Authorization Code Flow)

HTTP request headers

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

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