laserfiche_api
"1.1.0"
يتم إنشاء API Laserfiche API SDK هذا بواسطة Swagger-Codegen V3.
يمكنك العثور على صفحة PYPI لهذا المشروع هنا.
تم بناء واجهة برمجة تطبيقات Laserfiche للعمل مع 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. يمكنك تجربة أي من مكالمات واجهة برمجة التطبيقات الخاصة بنا مقابل حساب Live Laserfiche Cloud. تفضل بزيارة مركز المطورين لمزيد من التفاصيل: <a href = "https: //developer.laserfiche.com "> https://developer.laserfiche.com
تفضل بزيارة changelog للحصول على قائمة التغييرات: <a href = "/ropository/v2/changelog">/ropository/v2/changelog
Build#: 41A7347C0662989661D7AB8105A70D36CB42518E_.20240124.4
يتم إنشاء حزمة Python هذه تلقائيًا بواسطة مشروع Swagger Codegen:
بيثون 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 | وصف |
|---|---|---|---|
| attributesapi | get_attribute | الحصول على /v2/repositories/{stripositoryId}/entributes/{attributeKey} | إرجاع كائن السمة المرتبط بالمستخدم المصادق عليه. |
| attributesapi | list_attributes | GET /V2/repositories/{ropositoryID}/سمات | إرجاع أزواج قيمة مفتاح السمة المرتبطة بالمستخدم المصادق. |
| Auditreasonsapi | list_audit_reasons | GET /V2/repositories/{RESTORYID}/Auditreasons | إرجاع أسباب التدقيق المرتبطة بالمستخدم المصادق. |
| إدخالات | copy_entry | post /v2/repositories/{respositoryId}/interries/{internid}/folder/copy | نسخ دخول طفل جديد في مجلد. |
| إدخالات | create_entry | post /v2/repositories/{respositoryId}/interries/{entryId}/folder/children | يخلق دخول طفل جديد في مجلد. |
| إدخالات | create_multipart_upload_urls | post /v2/repositories/{ropositoryid}/incles/createMultipartuploadurls | طلبات تحميل عناوين URL لتحميل ملف كبير في قطع. |
| إدخالات | delete_electronic_document | حذف /v2/repositories/{ropositoryid}/interries/{entryId}/document/edoc | يحذف EDOC المرتبط بالإدخال. |
| إدخالات | delete_pages | حذف /v2/repositories/{repositoryid}/interries/{entryId}/document/pages | يحذف الصفحات المرتبطة بالإدخال. |
| إدخالات | export_entry | post /v2/repositories/{respositoryId}/interries/{entryId}/export | تصدير دخول. |
| إدخالات | get_entry | الحصول على /v2/repositories/{ropositoryId}/interries/{entryId} | إرجاع كائن إدخال واحد. |
| إدخالات | get_entry_by_path | GET /V2/repositories/{RESPOSITORYID}/intries/bypath | إرجاع كائن إدخال واحد باستخدام مسار الإدخال. |
| إدخالات | import_entry | post /v2/repositories/{respositoryId}/interries/{entryId}/folder/import | يستورد ملفًا إلى مجلد (الحد الأقصى طول: 100 ميغابايت). |
| إدخالات | list_dynamic_field_values | post /v2/repositories/{respositoryId}/interries/{entryId}/fields/getDynamicfieldLogicValue | إرجاع قيم منطق الحقل الديناميكي المعين إلى إدخال. |
| إدخالات | list_entries | GET /V2/repositories/{RESTORYID}/interries/{entryId}/folder/children | يعيد إدخالات الأطفال في المجلد. |
| إدخالات | list_fields | GET /V2/repositories/{RESPOSITORYID}/interries/{internid}/fields | إرجاع الحقول المعينة إلى إدخال. |
| إدخالات | list_links | GET /V2/repositories/{RESPOSITORYID}/interries/{internID}/links | إرجاع الروابط المخصصة للإدخال. |
| إدخالات | list_tags | GET /V2/repositories/{RESPOSITORYID}/interries/{entryId}/tags | إرجاع العلامات المخصصة إلى إدخال. |
| إدخالات | remove_template | حذف /v2/repositories/{ropositoryid}/interries/{entryId}/template | يزيل القالب المعين حاليًا من إدخال. |
| إدخالات | set_fields | put /v2/repositories/{respositoryId}/interries/{entryId}/fields | يقوم بتحديث قيم الحقل المخصصة لإدخال. |
| إدخالات | set_links | PUT /V2/repositories/{ropositoryID}/interries/{entryId}/links | يعين روابط إلى إدخال. |
| إدخالات | set_tags | put /v2/repositories/{stospositoryId}/intries/{entryId}/tags | يعين العلامات إلى إدخال. |
| إدخالات | set_template | put /v2/repositories/{respositoryId}/interries/{internid}/template | يعين قالب للدخول. |
| إدخالات | start_copy_entry | post /v2/repositories/{respositoryId}/interries/{internid}/folder/copyasync | تبدأ مهمة نسخة غير متزامنة لنسخ إدخال في مجلد. |
| إدخالات | start_delete_entry | حذف /v2/repositories/{repositoryID}/interries/{internid} | تبدأ مهمة حذف غير متزامنة لحذف إدخال. |
| إدخالات | start_export_entry | post /v2/repositories/{ropositoryId}/interries/{entryId}/esportAsync | تبدأ مهمة تصدير غير متزامنة لتصدير إدخال. |
| إدخالات | start_import_uploaded_parts | post /v2/repositories/{respositoryId}/interries/{entryId}/folder/importuploadedparts | تبدأ مهمة استيراد غير متزامنة لاستيراد مستند إلى مجلد. |
| إدخالات | update_entry | التصحيح /V2/مستودعات/{stopositoryID}/interristes/{entryId} | تحديث إدخال. (تحرك و/أو إعادة تسمية) |
| FieldDefinitionsapi | get_field_definition | GET /V2/repositories/{RESTORYID}/fielddefinitions/{fieldID} | إرجاع كائن تعريف حقل واحد. |
| FieldDefinitionsapi | list_field_definitions | GET /V2/repositories/{RESTORYID}/fielddefinitions | إرجاع القائمة المليئة بالتعريفات الميدانية المتاحة في مستودع. |
| LinkDefinitionsapi | get_link_definition | الحصول على /v2/repositories/{ropositoryid}/linkDefinitions/{linkDefinitionId} | إرجاع كائن تعريف ارتباط واحد. |
| LinkDefinitionsapi | list_link_definitions | GET /V2/repositories/{ropositoryID}/linkDefinitions | إرجاع تعريفات الارتباط المرتبطة بمستودع. |
| مستودعات | list_repositories | الحصول على /v2 /المستودعات | إرجاع قائمة المستودعات المتاحة للمستخدم. |
| البحث | list_search_context_hits | GET /V2/repositories/{RESTORYID}/searches/{taskid}/results/{rownumber}/contexthits | إرجاع زيارات السياق المرتبطة بإدخال نتيجة البحث. |
| البحث | list_search_results | GET /V2/repositories/{RESTORYID}/searches/{taskid}/results | إرجاع قائمة النتائج المرتبطة بمهمة البحث. |
| البحث | start_search_entry | post /v2/repositories/{ropositoryid}/searches/searchAsync | تبدأ مهمة بحث غير متزامنة. |
| Simplesearchesapi | Search_entry | post /v2/repositories/{ropositoryid}/simplesearches | يدير A & quot ؛ بسيط & quot ؛ عملية البحث. |
| tagDefinitionsapi | get_tag_definition | الحصول على /v2/repositories/{stopositoryId}/tagDefinitions/{tagid} | إرجاع كائن تعريف علامة واحدة. |
| tagDefinitionsapi | list_tag_definitions | GET /V2/repositories/{RESTORYID}/tagDefinitions | إرجاع تعريفات العلامات المرتبطة بمستودع. |
| المهام | Cancel_tasks | حذف /v2/repositories/{ropositoryid}/ass | يبدأ الإلغاء لمجموعة من المهام أو أكثر. |
| المهام | list_tasks | GET /V2/repositories/{ropositoryID}/casks | إرجاع حالة مجموعة من المهام أو أكثر. |
| templatedefinitionsapi | get_template_definition | GET /V2/repositories/{RESPOSITORYID}/TEMPLATEDEFINITIONS/{templateid} | إرجاع كائن تعريف قالب واحد. |
| templatedefinitionsapi | list_template_definitions | GET /V2/repositories/{RESTORYID}/TEMPLATEDEFINITIONS | إرجاع تعريفات القالب المرتبطة بمستودع. |
| templatedefinitionsapi | list_template_field_definitions_by_template_id | GET /V2/repositories/{RESTORYID}/TEMPLATEDEFINITIONS/{templateid}/fieldDefinitions | إرجاع تعريفات الحقل المخصصة لتعريف القالب (حسب معرف تعريف القالب). |
| templatedefinitionsapi | list_template_field_definitions_by_template_name | GET /V2/repositories/{RESTORYID}/TEMPLATEDEFINITIONS/FieldDefinitions | إرجاع تعريفات الحقل المخصصة لتعريف القالب (حسب اسم تعريف القالب). |
