laserfiche_api
"1.1.0"
該Laserfiche API SDK由Swagger-Codegen V3自動生成。
您可以在此處找到此項目的PYPI頁面。
Laserfiche API已構建可與OpenAPI 3.0.0合作。因此，必須使用Swagger-Codegen V3。
API_GEN文件夾下的api_gen.sh腳本將旋轉運行swagger-codegen-cli-v3 Docker容器，並將laserfiche_api SDK導出到具有相同名稱的文件夾。
如果將所得的SDK文件推到自己的PYPI存儲庫中，則可以安裝：
pip install laserfiche-api您也可以通過setuptools手動安裝：
python setup.py install --user以下文檔是由Swagger-Codegen自動生成的。
歡迎來到Laserfiche API Swagger遊樂場。您可以嘗試針對您的Live Laserfiche Cloud帳戶的任何API調用。請訪問開發者中心以獲取更多詳細信息：<a href =“ https：//developer.laserfiche.com ”> https://developer.laserfiche.com
訪問更改列表的變更列表：<a href =“/repository/v2/changelog”>/repository/v2/changelog
構建＃： 41A7347C0662989661D7AB8105A70D36CB42518E_.20240124.4
此Python軟件包將由Swagger Codegen Project自動生成：
Python 2.7和3.4+
如果Python軟件包是在GitHub上託管的，則可以直接從GitHub安裝
pip install git+https://github.com/Layer8Err/laserfiche_api.git （您可能需要使用root權限運行pip ： sudo pip install git+https://github.com/Layer8Err/laserfiche_api.git ）
然後導入包：
import laserfiche_api 通過setuptools安裝。
python setup.py install --user （或sudo python setup.py install以安裝所有用戶的軟件包）
然後導入包：
import laserfiche_api 請遵循安裝步驟，然後運行以下內容：
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 . AttributesApi ( laserfiche_api . ApiClient ( configuration ))
repository_id = 'repository_id_example' # str | The requested repository ID.
attribute_key = 'attribute_key_example' # str | The requested attribute key.
everyone = false # bool | Indicates if attributes associated with the "Everyone" group or the currently authenticated user is returned. The default value is false. (optional) (default to false)
try :
# Returns an attribute object associated with the authenticated user.
api_response = api_instance . get_attribute ( repository_id , attribute_key , everyone = everyone )
pprint ( api_response )
except ApiException as e :
print ( "Exception when calling AttributesApi->get_attribute: %s n " % e )
# 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 . AttributesApi ( laserfiche_api . ApiClient ( configuration ))
repository_id = 'repository_id_example' # str | The requested repository ID.
everyone = false # bool | Indicates if attributes associated with the "Everyone" group or the currently authenticated user is returned. The default value is false. (optional) (default to false)
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 attribute key value pairs associated with the authenticated user.
api_response = api_instance . list_attributes ( repository_id , everyone = everyone , prefer = prefer , select = select , orderby = orderby , top = top , skip = skip , count = count )
pprint ( api_response )
except ApiException as e :
print ( "Exception when calling AttributesApi->list_attributes: %s n " % e )所有URI都相對於https://api.laserfiche.com/repository
| 班級 | 方法 | HTTP請求 | 描述 |
|---|---|---|---|
| 屬性 | get_attribute | get /v2/repositories/{repositoryId}/attributes/{attributekey} | 返回與身份驗證的用戶關聯的屬性對象。 |
| 屬性 | list_attributes | get /v2/repositories/{repositoryId}/屬性 | 返回與身份驗證的用戶關聯的屬性鍵值對。 |
| Auditreaconapi | list_audit_reasons | get /v2/repositories/{repositoryId}/審核季節 | 返回與身份驗證的用戶相關的審計原因。 |
| Entriesapi | copy_entry | post /v2/repositories/{repositorityId}/entries/{entryid}/folder/copy | 在文件夾中復制新的孩子條目。 |
| Entriesapi | create_entry | post /v2/repositories/{repositoryId}/entries/{entryid}/folder/children | 在文件夾中創建一個新的孩子條目。 |
| Entriesapi | create_multipart_upload_urls | post /v2/repositories/{repositoryId}/entries/createmultipartuploadurls | 請求上傳URL以將大文件上傳到塊中。 |
| Entriesapi | delete_electronic_document | delete /v2/repositories/{repositoryId}/entries/{entryId}/document/edoc | 刪除與條目關聯的EDOC。 |
| Entriesapi | delete_pages | delete /v2/repositories/{repositoryId}/entries/{entryId}/document/peg | 刪除與條目關聯的頁面。 |
| Entriesapi | export_entry | post /v2/repositories/{repositorityId}/entries/{entryid}/export | 導出條目。 |
| Entriesapi | get_entry | get /v2/repositories/{repositoryId}/entries/{entryid} | 返回單個入口對象。 |
| Entriesapi | get_entry_by_path | get /v2/repositories/{repositoryId}/entries/bypath | 使用條目路徑返回單個入口對象。 |
| Entriesapi | import_entry | post /v2/repositories/{repositoryId}/entries/{entryid}/folder/import | 將文件導入文件夾（最大長度：100 MB）。 |
| Entriesapi | list_dynamic_field_values | post /v2/repositories/{repositoryId}/entries/{entriD}/fields/getdynamicfieldlogicvalue | 返回分配給條目的動態字段邏輯值。 |
| Entriesapi | List_entries | get /v2/repositories/{repositorityId}/entries/{entryid}/folder/children | 返回文件夾的兒童條目。 |
| Entriesapi | List_fields | get /v2/repositories/{repositoryId}/entries/{entryId}/fields | 返回分配給條目的字段。 |
| Entriesapi | list_links | get /v2/repositories/{repositoryId}/entries/{entryId}/鏈接 | 返回分配給條目的鏈接。 |
| Entriesapi | list_tags | get /v2/repositories/{repositoryId}/entries/{entryId}/tags | 返回分配給條目的標籤。 |
| Entriesapi | remove_template | delete /v2/repositories/{repositoryId}/entries/{entryId}/template | 從條目中刪除當前分配的模板。 |
| Entriesapi | set_fields | put /v2/repositories/{repositorityId}/entries/{entryId}/fields | 更新分配給條目的字段值。 |
| Entriesapi | set_links | put /v2/repositories/{repositoryId}/entries/{entryId}/鏈接 | 分配鏈接到條目。 |
| Entriesapi | set_tags | put /v2/repositories/{repositoryId}/entries/{entryId}/tags | 將標籤分配給條目。 |
| Entriesapi | set_template | put /v2/repositories/{repositoryId}/entries/{entryId}/template | 將模板分配給條目。 |
| Entriesapi | start_copy_entry | post /v2/repositories/{repositorityId}/entries/{entryId}/folder/copyAsync | 啟動異步複製任務，將條目複製到文件夾中。 |
| Entriesapi | start_delete_entry | delete /v2/repositories/{repositoryId}/entries/{entryid} | 啟動異步刪除任務以刪除條目。 |
| Entriesapi | start_export_entry | post /v2/repositories/{repositoryId}/entries/{entryId}/exportAsync | 啟動異步導出任務以導出條目。 |
| Entriesapi | start_import_uploaded_parts | post /v2/repositories/{repositorityId}/entries/{entryId}/folder/importUploadedParts | 啟動異步導入任務，將文檔導入文件夾。 |
| Entriesapi | update_entry | patch /v2/repositories/{repositoryId}/entries/{entryid} | 更新條目。 （移動和/或重命名） |
| fieldDefinitionSAPI | get_field_definition | get /v2/repositories/{repositoryId}/fieldDefinitions/{fieldID} | 返回單個字段定義對象。 |
| fieldDefinitionSAPI | List_field_definitions | get /v2/repositories/{repositoryId}/fieldDefinitions | 返回存儲庫中可用的字段定義的分頁列表。 |
| LinkDefinitionSAPI | get_link_definition | get /v2/repositories/{repositoryId}/linkdefinitions/{linkDefinitionId} | 返回一個鏈接定義對象。 |
| LinkDefinitionSAPI | list_link_definitions | get /v2/repositories/{repositoryId}/linkDefinitions | 返回與存儲庫關聯的鏈接定義。 |
| 存儲庫 | list_repositories | 獲取/V2 /存儲庫 | 返回用戶可訪問的存儲庫列表。 |
| searchesapi | list_search_context_hits | get /v2/repositories/{repositoryId}/searches/{taskId}/resuct/{rownumber}/contexthits | 返回與搜索結果條目關聯的上下文命中。 |
| searchesapi | list_search_results | get /v2/repositories/{repositoryId}/searches/{taskID}/結果 | 返回與搜索任務關聯的結果列表。 |
| searchesapi | start_search_entry | post /v2/repositories/{repositoryId}/searches/searchAsync | 啟動異步搜索任務。 |
| Simplesearchesapi | search_entry | post /v2/repositories/{repositoryId}/simplesearch | 運行a'搜索操作。 |
| tagdefinitionsapi | get_tag_definition | get /v2/repositories/{repositoryId}/tagdefinitions/{tagid} | 返回單個標籤定義對象。 |
| tagdefinitionsapi | list_tag_definitions | get /v2/repositories/{repositoryId}/tagdefinitions | 返回與存儲庫關聯的標籤定義。 |
| Tasksapi | cancel_tasks | delete /v2/repositories/{repositoryId}/任務 | 啟動一組或多項任務的取消。 |
| Tasksapi | list_tasks | get /v2/repositories/{repositorityId}/任務 | 返回一組或多項任務的狀態。 |
| TemplatedEfinitionSAPI | get_template_definition | get /v2/repositories/{repositoryId}/templatedFinitions/{templateID} | 返回單個模板定義對象。 |
| TemplatedEfinitionSAPI | list_template_definitions | get /v2/repositories/{repositoryId}/templatedFinitions | 返回與存儲庫關聯的模板定義。 |
| TemplatedEfinitionSAPI | list_template_field_definitions_by_template_id | get /v2/repositories/{repositoryId}/templatedFinitions/{templateID}/fieldDefinitions | 返回分配給模板定義的字段定義（通過模板定義ID）。 |
| TemplatedEfinitionSAPI | list_template_field_definitions_by_template_name | get /v2/repositories/{repositorityId}/templatedFinitions/fieldDefinitions | 返回分配給模板定義的字段定義（通過模板定義名稱）。 |
