laserfiche_api
"1.1.0"
Laserfiche API SDK นี้สร้างขึ้นโดยอัตโนมัติโดย Swagger-Codegen V3
คุณสามารถค้นหาหน้า PYPI สำหรับโครงการนี้ได้ที่นี่
Laserfiche API ถูกสร้างขึ้นเพื่อทำงานกับ OpenAPI 3.0.0 ด้วยเหตุนี้จึงต้องใช้ Swagger-Codegen V3
สคริปต์ api_gen.sh ภายใต้โฟลเดอร์ API_GEN จะหมุนคอนเทนเนอร์ Docker ที่ใช้ swagger-codegen-cli-v3 และส่งออก laserfiche_api SDK ไปยังโฟลเดอร์ที่มีชื่อเดียวกัน
หากไฟล์ SDK ที่ได้ถูกส่งไปยัง PYPI repo ของตัวเองพวกเขาสามารถติดตั้งได้ด้วย:
pip install laserfiche-apiนอกจากนี้คุณยังสามารถติดตั้งด้วยตนเองผ่าน setuptools:
python setup.py install --userเอกสารต่อไปนี้ถูกสร้างขึ้นโดยอัตโนมัติโดย Swagger-Codegen
ยินดีต้อนรับสู่สนามเด็กเล่น Laserfiche API Swagger คุณสามารถลองใช้ API ใด ๆ ของเรากับบัญชี Laserfiche Cloud ของคุณ เยี่ยมชมศูนย์นักพัฒนาซอฟต์แวร์สำหรับรายละเอียดเพิ่มเติม: <a href = "https: //developer.laserfiche.com "> https://developer.laserfiche.com
เยี่ยมชมการเปลี่ยนแปลงสำหรับรายการการเปลี่ยนแปลง: <a href = "/repository/v2/changelog">/repository/v2/changelog
สร้าง#: 41A7347C06629896661D7AB8105A70D36CB42518E_.20240124.4
แพ็คเกจ Python นี้สร้างขึ้นโดยอัตโนมัติโดยโครงการ Swagger Codegen:
Python 2.7 และ 3.4+
หากแพ็คเกจ Python โฮสต์บน GitHub คุณสามารถติดตั้งได้โดยตรงจาก GitHub
pip install git+https://github.com/Layer8Err/laserfiche_api.git (คุณอาจต้องเรียกใช้ 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 )uris ทั้งหมดมีความสัมพันธ์กับ https://api.laserfiche.com/repository
| ระดับ | วิธี | คำขอ http | คำอธิบาย |
|---|---|---|---|
| แอตทริบิวต์ | get_attribute | รับ /v2/repositories/{repositoryId}/attributes/{attributeKey} | ส่งคืนวัตถุแอตทริบิวต์ที่เกี่ยวข้องกับผู้ใช้ที่ได้รับการรับรองความถูกต้อง |
| แอตทริบิวต์ | list_attributes | รับ /v2/repositories/{repositoryId}/แอตทริบิวต์ | ส่งคืนคู่ของคีย์แอตทริบิวต์ที่เกี่ยวข้องกับผู้ใช้ที่ได้รับการรับรองความถูกต้อง |
| Auditreasonsapi | list_audit_reasons | รับ /v2/repositories/{repositoryId}/AuditReasons | ส่งคืนเหตุผลการตรวจสอบที่เกี่ยวข้องกับผู้ใช้ที่ได้รับการรับรองความถูกต้อง |
| รายการ | copy_entry | โพสต์ /v2/repositories/{repositoryId}/entries/{entryId}/โฟลเดอร์/คัดลอก | คัดลอกรายการเด็กใหม่ในโฟลเดอร์ |
| รายการ | create_entry | โพสต์ /v2/repositories/{repositoryId}/entries/{entryId}/โฟลเดอร์/เด็ก | สร้างรายการเด็กใหม่ในโฟลเดอร์ |
| รายการ | create_multipart_upload_urls | โพสต์ /v2/repositories/{repositoryId}/รายการ/createMultipartuploadurls | คำขออัปโหลด URL เพื่ออัปโหลดไฟล์ขนาดใหญ่ในชิ้น |
| รายการ | delete_electronic_document | ลบ /v2/repositories/{repositoryId}/entries/{entryId}/document/edoc | ลบ EDOC ที่เกี่ยวข้องกับรายการ |
| รายการ | delete_pages | ลบ /v2/repositories/{repositoryId}/entries/{entryId}/เอกสาร/หน้า | ลบหน้าเว็บที่เกี่ยวข้องกับรายการ |
| รายการ | Export_entry | โพสต์ /v2/repositories/{repositoryId}/entries/{entryId}/ส่งออก | ส่งออกรายการ |
| รายการ | get_entry | รับ /v2/repositories/{repositoryId}/entries/{entryId} | ส่งคืนวัตถุรายการเดียว |
| รายการ | get_entry_by_path | รับ /v2/repositories/{repositoryId}/รายการ/bypath | ส่งคืนวัตถุรายการเดียวโดยใช้เส้นทางรายการ |
| รายการ | import_entry | โพสต์ /v2/repositories/{repositoryId}/entries/{entryId}/โฟลเดอร์/นำเข้า | นำเข้าไฟล์ลงในโฟลเดอร์ (ความยาวสูงสุด: 100 MB) |
| รายการ | list_dynamic_field_values | โพสต์ /v2/repositories/{repositoryId}/entries/{entryId}/ฟิลด์/getDynamicfieldLogicValue | ส่งคืนค่าตรรกะฟิลด์แบบไดนามิกที่กำหนดให้กับรายการ |
| รายการ | list_entries | รับ /v2/repositories/{repositoryId}/entries/{entryId}/โฟลเดอร์/เด็ก | ส่งคืนรายการเด็กของโฟลเดอร์ |
| รายการ | list_fields | รับ /v2/repositories/{repositoryId}/entries/{entryId}/ฟิลด์ | ส่งคืนฟิลด์ที่กำหนดให้กับรายการ |
| รายการ | list_links | รับ /v2/repositories/{repositoryId}/entries/{entryId}/ลิงก์ | ส่งคืนลิงก์ที่กำหนดให้กับรายการ |
| รายการ | list_tags | รับ /v2/repositories/{repositoryId}/entries/{entryId}/แท็ก | ส่งคืนแท็กที่กำหนดให้กับรายการ |
| รายการ | remove_template | ลบ /v2/repositories/{repositoryId}/entries/{entryId}/เทมเพลต | ลบเทมเพลตที่กำหนดในปัจจุบันออกจากรายการ |
| รายการ | set_fields | put /v2/repositories/{repositoryId}/entries/{entryId}/ฟิลด์ | อัปเดตค่าฟิลด์ที่กำหนดให้กับรายการ |
| รายการ | set_links | put /v2/repositories/{repositoryId}/entries/{entryId}/ลิงก์ | กำหนดลิงก์ไปยังรายการ |
| รายการ | set_tags | put /v2/repositories/{repositoryId}/entries/{entryId}/แท็ก | กำหนดแท็กให้กับรายการ |
| รายการ | set_template | put /v2/repositories/{repositoryId}/entries/{entryId}/เทมเพลต | กำหนดแม่แบบให้กับรายการ |
| รายการ | start_copy_entry | โพสต์ /v2/repositories/{repositoryId}/entries/{entryId}/โฟลเดอร์/copyasync | เริ่มงานคัดลอกแบบอะซิงโครนัสเพื่อคัดลอกรายการลงในโฟลเดอร์ |
| รายการ | start_delete_entry | ลบ /v2/repositories/{repositoryId}/entries/{entryId} | เริ่มงานลบแบบอะซิงโครนัสเพื่อลบรายการ |
| รายการ | start_export_entry | โพสต์ /v2/repositories/{repositoryId}/entries/{entryId}/exportasync | เริ่มงานส่งออกแบบอะซิงโครนัสเพื่อส่งออกรายการ |
| รายการ | start_import_uploaded_parts | โพสต์ /v2/repositories/{repositoryId}/entries/{entryId}/โฟลเดอร์/importuploadedParts | เริ่มงานนำเข้าแบบอะซิงโครนัสเพื่อนำเข้าเอกสารลงในโฟลเดอร์ |
| รายการ | update_entry | patch /v2/repositories/{repositoryId}/entries/{entryId} | อัปเดตรายการ (ย้ายและ/หรือเปลี่ยนชื่อ) |
| FieldDefinitionsapi | get_field_definition | รับ /v2/repositories/{repositoryId}/fieldDefinitions/{fieldId} | ส่งคืนวัตถุนิยามฟิลด์เดียว |
| FieldDefinitionsapi | list_field_definitions | รับ /v2/repositories/{repositoryId}/fieldDefinitions | ส่งคืนรายชื่อเพจของคำจำกัดความของฟิลด์ที่มีอยู่ในที่เก็บ |
| linkdefinitionsapi | get_link_definition | รับ /v2/repositories/{repositoryId}/linkdefinitions/{linkdefinitionId} | ส่งคืนวัตถุนิยามลิงค์เดียว |
| linkdefinitionsapi | list_link_definitions | รับ /v2/repositories/{repositoryId}/linkdefinitions | ส่งคืนคำจำกัดความของลิงก์ที่เกี่ยวข้องกับที่เก็บ |
| ที่เก็บ | list_repositories | รับ /v2 /ที่เก็บ | ส่งคืนรายชื่อที่เก็บข้อมูลที่ผู้ใช้เข้าถึงได้ |
| Searchesapi | list_search_context_hits | รับ /v2/repositories/{repositoryId}/searches/{taskId}/ผลลัพธ์/{rownumber}/contexthits | ส่งคืนบริบทที่เกี่ยวข้องกับรายการผลการค้นหา |
| Searchesapi | list_search_results | รับ /v2/repositories/{repositoryId}/searches/{taskId}/ผลลัพธ์ | ส่งคืนรายชื่อผลลัพธ์ที่เกี่ยวข้องกับงานค้นหา |
| Searchesapi | start_search_entry | โพสต์ /v2/repositories/{repositoryId}/searches/searchasync | เริ่มงานการค้นหาแบบอะซิงโครนัส |
| simpleSearchesapi | search_entry | โพสต์ /v2/repositories/{repositoryId}/simpleSearches | รัน A & quot; ง่าย & quot; การดำเนินการค้นหา |
| tagdefinitionsapi | get_tag_definition | รับ /v2/repositories/{repositoryId}/tagdefinitions/{tagid} | ส่งคืนวัตถุแท็กนิยามเดียว |
| tagdefinitionsapi | list_tag_definitions | รับ /v2/repositories/{repositoryId}/tagdefinitions | ส่งคืนคำจำกัดความของแท็กที่เกี่ยวข้องกับที่เก็บ |
| Tasksapi | cancel_tasks | ลบ /v2/repositories/{repositoryId}/งาน | เริ่มการยกเลิกสำหรับชุดหนึ่งหรือมากกว่า |
| Tasksapi | list_tasks | รับ /v2/repositories/{repositoryId}/งาน | ส่งคืนสถานะของชุดของหนึ่งหรือมากกว่า |
| Templatedefinitionsapi | get_template_definition | รับ /v2/repositories/{repositoryId}/templatedefinitions/{templateId} | ส่งคืนวัตถุคำจำกัดความเทมเพลตเดียว |
| Templatedefinitionsapi | list_template_definitions | รับ /v2/repositories/{repositoryId}/templatedefinitions | ส่งคืนคำจำกัดความเทมเพลตที่เกี่ยวข้องกับที่เก็บ |
| Templatedefinitionsapi | list_template_field_definitions_by_template_id | รับ /v2/repositories/{repositoryId}/templatedefinitions/{templateId}/fieldDefinitions | ส่งคืนคำจำกัดความของฟิลด์ที่กำหนดให้กับคำจำกัดความเทมเพลต (โดย ID คำจำกัดความเทมเพลต) |
| Templatedefinitionsapi | list_template_field_definitions_by_template_name | รับ /v2/repositories/{repositoryId}/templatedefinitions/fieldDefinitions | ส่งคืนคำจำกัดความของฟิลด์ที่กำหนดให้กับคำจำกัดความเทมเพลต (โดยชื่อคำจำกัดความเทมเพลต) |
