laserfiche_api
"1.1.0"
Laserfiche API SDK ini dihasilkan secara otomatis oleh Swagger-Codegen V3.
Anda dapat menemukan halaman PYPI untuk proyek ini di sini.
API Laserfiche telah dibangun untuk bekerja dengan OpenAPI 3.0.0. Karena itu, Swagger-Codegen V3 harus digunakan.
Skrip api_gen.sh di bawah folder API_GEN akan memutar wadah Docker yang menjalankan swagger-codegen-cli-v3 dan mengekspor laserfiche_api SDK ke folder dengan nama yang sama.
Jika file SDK yang dihasilkan didorong ke repo PYPI mereka sendiri, mereka dapat diinstal dengan:
pip install laserfiche-apiAnda juga dapat menginstal secara manual melalui setuptools:
python setup.py install --userDokumentasi berikut dihasilkan secara otomatis oleh Swagger-Codegen.
Selamat datang di taman bermain Laserfiche API Swagger. Anda dapat mencoba salah satu panggilan API kami terhadap akun Cloud Laserfiche langsung Anda. Kunjungi Pusat Pengembang untuk detail lebih lanjut: <a href = "https: //developer.laserfiche.com "> https://developer.laserfiche.com
Kunjungi Changelog untuk daftar perubahan: <a href = "/repositori/v2/changelog">/repositori/v2/changelog
Build#: 41A7347C0662989661D7AB8105A70D36CB42518E_.20240124.4
Paket Python ini secara otomatis dihasilkan oleh proyek Codegen Swagger:
Python 2.7 dan 3.4+
Jika paket Python di -host di GitHub, Anda dapat menginstal langsung dari GitHub
pip install git+https://github.com/Layer8Err/laserfiche_api.git (Anda mungkin perlu menjalankan pip dengan izin root: sudo pip install git+https://github.com/Layer8Err/laserfiche_api.git )
Kemudian impor paket:
import laserfiche_api Instal melalui setuptools.
python setup.py install --user (atau sudo python setup.py install untuk menginstal paket untuk semua pengguna)
Kemudian impor paket:
import laserfiche_api Harap ikuti prosedur instalasi dan kemudian jalankan yang berikut:
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 )Semua URI relatif terhadap https://api.laserfiche.com/repository
| Kelas | Metode | Permintaan HTTP | Keterangan |
|---|---|---|---|
| AtributePi | get_attribute | Get /v2/repositories/{repositoryId}/attributes/{attributeKey} | Mengembalikan objek atribut yang terkait dengan pengguna yang diautentikasi. |
| AtributePi | List_attributes | Get /v2/repositories/{repositoryId}/atribut | Mengembalikan pasangan nilai kunci atribut yang terkait dengan pengguna yang diautentikasi. |
| Auditreasonsapi | Daftar_Audit_Reasons | Get /v2/repositories/{repositoryId}/auditreasons | Mengembalikan alasan audit yang terkait dengan pengguna yang diautentikasi. |
| Entriesapi | copy_entry | POST /V2/repositori/{repositoryId}/entri/{entryid}/folder/salin | Menyalin entri anak baru di folder. |
| Entriesapi | create_entry | POST /V2/repositori/{repositoryId}/entri/{entryid}/folder/anak -anak | Membuat entri anak baru di folder. |
| Entriesapi | create_multipart_upload_urls | POST /V2/repositori/{repositoryId}/entri/createMultipartuploadurls | Permintaan mengunggah URL untuk mengunggah file besar dalam potongan. |
| Entriesapi | delete_electronic_document | Hapus /v2/repositori/{repositoryId}/entri/{entryid}/document/edoc | Menghapus edoc yang terkait dengan entri. |
| Entriesapi | delete_pages | Hapus /v2/repositori/{repositoryId}/entri/{entryid}/dokumen/halaman | Menghapus halaman yang terkait dengan entri. |
| Entriesapi | Export_entry | POST /V2/repositori/{repositoryId}/entri/{entryid}/ekspor | Mengekspor entri. |
| Entriesapi | get_entry | Get /v2/repositories/{repositoryId}/entri/{entryid} | Mengembalikan satu objek entri tunggal. |
| Entriesapi | get_entry_by_path | Get /v2/repositories/{repositoryId}/entri/bypath | Mengembalikan objek entri tunggal menggunakan jalur entri. |
| Entriesapi | import_entry | POST /V2/repositori/{repositoryId}/entri/{entryid}/folder/impor | Impor file ke folder (panjang maks: 100 MB). |
| Entriesapi | List_dynamic_field_values | POST /V2/repositori/{repositoryId}/entri/{entryid}/fields/getDynamicFieldLogicValue | Mengembalikan nilai logika bidang dinamis yang ditetapkan untuk entri. |
| Entriesapi | List_entries | Get /v2/repositories/{repositoryId}/entri/{entryid}/folder/anak -anak | Mengembalikan entri anak -anak dari folder. |
| Entriesapi | List_fields | Get /v2/repositories/{repositoryId}/entri/{entryid}/bidang | Mengembalikan bidang yang ditugaskan ke entri. |
| Entriesapi | List_links | Get /v2/repositories/{repositoryId}/entri/{entryid}/tautan | Mengembalikan tautan yang ditetapkan ke entri. |
| Entriesapi | List_tags | Get /v2/repositories/{repositoryId}/entri/{entryid}/tags | Mengembalikan tag yang ditetapkan ke entri. |
| Entriesapi | lepaskan_template | Hapus /v2/repositori/{repositoryId}/entri/{entryid}/template | Menghapus template yang saat ini ditugaskan dari entri. |
| Entriesapi | set_fields | Put /v2/repositori/{repositoryId}/entri/{entryid}/bidang | Memperbarui nilai bidang yang ditetapkan untuk entri. |
| Entriesapi | set_links | Put /v2/repositori/{repositoryId}/entri/{entryid}/tautan | Menetapkan tautan ke entri. |
| Entriesapi | set_tags | Put /v2/repositories/{repositoryId}/entri/{entryid}/tags | Menetapkan tag ke entri. |
| Entriesapi | set_template | Put /v2/repositori/{repositoryId}/entri/{entryid}/template | Menetapkan template ke entri. |
| Entriesapi | start_copy_entry | POST /V2/repositori/{repositoryId}/entri/{entryid}/folder/copyAsync | Mulai tugas salinan asinkron untuk menyalin entri ke folder. |
| Entriesapi | start_delete_entry | Hapus /v2/repositori/{repositoryId}/entri/{entryid} | Mulai tugas hapus asinkron untuk menghapus entri. |
| Entriesapi | start_export_entry | POST /V2/repositori/{repositoryId}/entri/{entryid}/exportAsync | Memulai tugas ekspor asinkron untuk mengekspor entri. |
| Entriesapi | start_import_uploaded_parts | POST /V2/REPOSITORIES/{RepositoryId}/Entries/{EntryId}/Folder/ImportuploadedParts | Mulai tugas impor asinkron untuk mengimpor dokumen ke folder. |
| Entriesapi | update_entry | Patch /V2/Repositori/{RepositoryId}/Entries/{EntryId} | Perbarui entri. (Pindah dan/atau ganti nama) |
| FieldDefinitionsapi | get_field_definition | Get /v2/repositories/{repositoryId}/fieldDefinitions/{fieldId} | Mengembalikan objek definisi bidang tunggal. |
| FieldDefinitionsapi | list_field_definitions | Get /v2/repositories/{repositoryId}/fieldDefinitions | Mengembalikan daftar paged dari definisi bidang yang tersedia dalam repositori. |
| LinkDefinitionsapi | get_link_definition | Get /v2/repositories/{repositoryId}/linkDefinitions/{linkDefinitionId} | Mengembalikan objek definisi tautan tunggal. |
| LinkDefinitionsapi | list_link_definitions | Get /v2/repositories/{repositoryId}/linkDefinitions | Mengembalikan definisi tautan yang terkait dengan repositori. |
| Repositoriesapi | List_repositories | Get /V2 /Repositori | Mengembalikan daftar repositori yang dapat diakses oleh pengguna. |
| Searchesapi | list_search_context_hits | Get /v2/repositories/{repositoryId}/searches/{TaskId}/hasil/{rownumber}/contexthits | Mengembalikan hit konteks yang terkait dengan entri hasil pencarian. |
| Searchesapi | list_search_results | Get /v2/repositories/{repositoryId}/searches/{TaskId}/hasil | Mengembalikan daftar hasil yang terkait dengan tugas pencarian. |
| Searchesapi | start_search_entry | POST /V2/repositori/{repositoryId}/pencarian/searchAsync | Memulai tugas pencarian asinkron. |
| SimpleSearchesapi | search_entry | POST /V2/repositori/{repositoryId}/SimpleSearches | Menjalankan & quot; sederhana & quot; operasi pencarian. |
| TagDefinitionsapi | get_tag_definition | Get /v2/repositories/{repositoryId}/tagDefinitions/{tagid} | Mengembalikan satu objek definisi tag. |
| TagDefinitionsapi | list_tag_definitions | Get /v2/repositories/{repositoryId}/tagDefinitions | Mengembalikan definisi tag yang terkait dengan repositori. |
| Tasksapi | cancel_tasks | Hapus /v2/repositori/{repositoryId}/tugas | Mulai pembatalan untuk satu set satu atau lebih tugas. |
| Tasksapi | List_Tasks | Get /v2/repositories/{repositoryId}/tugas | Mengembalikan status satu set satu atau lebih tugas. |
| Templatedefinitionsapi | get_template_definition | Get /v2/repositories/{repositoryId}/templateDefinitions/{templateid} | Mengembalikan objek definisi template tunggal. |
| Templatedefinitionsapi | list_template_definitions | Get /v2/repositories/{repositoryId}/templateDefinitions | Mengembalikan definisi template yang terkait dengan repositori. |
| Templatedefinitionsapi | list_template_field_definitions_by_template_id | Get /v2/repositories/{repositoryId}/templateDefinitions/{templateid}/fieldDefinitions | Mengembalikan definisi bidang yang ditetapkan ke definisi templat (dengan ID definisi templat). |
| Templatedefinitionsapi | list_template_field_definitions_by_template_name | Get /v2/repositories/{repositoryId}/templateDefinitions/fieldDefinitions | Mengembalikan definisi bidang yang ditetapkan ke definisi templat (dengan nama definisi templat). |
