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-apiSetUptoolsを介して手動でインストールすることもできます。
python setup.py install --user次のドキュメントは、Swaggerコデーゲンによって自動生成されます。
Laserfiche API Swagger Playgroundへようこそ。ライブLaserfiche Cloudアカウントに対してAPI通話を試すことができます。詳細については、開発者センターをご覧ください
変更のリストについては、changelogにアクセスしてください：<a href = "/repository/v2/changelog">/repository/v2/changelog
ビルド＃： 41A7347C0662989661D7AB8105A70D36CB42518E_.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 )すべてのURIはhttps://api.laserfiche.com/repositoryに関連しています
| クラス | 方法 | HTTPリクエスト | 説明 |
|---|---|---|---|
| Attributesapi | get_attribute | get /v2/repositories/{repositoryid}/attributes/{aTtributeKey} | 認証されたユーザーに関連付けられた属性オブジェクトを返します。 |
| Attributesapi | list_attributes | get /v2/repositories/{repositoryid}/属性 | 認証されたユーザーに関連付けられた属性キー値ペアを返します。 |
| auditreasonsapi | list_audit_reasons | get /v2/repositories/{repositoryid}/auditreasons | 認証されたユーザーに関連付けられた監査上の理由を返します。 |
| entriesapi | copy_entry | POST /V2/REPOSITRIES/{repositoryId}/entries/{entryId}/copy/copy | フォルダーに新しい子エントリをコピーします。 |
| entriesapi | create_entry | POST /V2/REPOSITRIES/{repositoryId}/entries/{entryId}/folder/Children | フォルダーに新しい子エントリを作成します。 |
| entriesapi | create_multipart_upload_urls | POST /V2/REPOSITRIES/{repositoryId}/entries/createmultipartuploadurs | URLをアップロードして、大きなファイルをチャンクにアップロードします。 |
| entriesapi | delete_electronic_document | delete /v2/repositories/{repositoryid}/entries/{entryId}/document/edoc | エントリに関連付けられたEDOCを削除します。 |
| entriesapi | delete_pages | delete /v2/repositories/{repositoryid}/entries/{entryId}/document/ページ | エントリに関連付けられたページを削除します。 |
| entriesapi | export_entry | post /v2/repositories/{repositoryid}/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/REPOSITRIES/{repositoryId}/entries/{entryId}/inport/import | ファイルをフォルダーにインポートします（最大長：100 MB）。 |
| entriesapi | list_dynamic_field_values | post /v2/repositories/{repositoryid}/entries/{entryId}/fields/getDynamicFieldLogicValue | エントリに割り当てられた動的フィールドロジック値を返します。 |
| entriesapi | list_entries | get /v2/repositories/{repositoryid}/entries/{entryId}/folder/children | フォルダーの子供のエントリを返します。 |
| entriesapi | list_fields | get /v2/repositories/{repositoryid}/entries/{entryId}/fields | エントリに割り当てられたフィールドを返します。 |
| entriesapi | list_links | get /v2/repositories/{repositoryid}/entries/{entryId}/links | エントリに割り当てられたリンクを返します。 |
| 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/{repositoryid}/entries/{entryId}/fields | エントリに割り当てられたフィールド値を更新します。 |
| entriesapi | set_links | put /v2/repositories/{repositoryid}/entries/{entryId}/links | リンクをエントリに割り当てます。 |
| entriesapi | set_tags | put /v2/repositories/{repositoryid}/entries/{entryId}/tags | タグをエントリに割り当てます。 |
| entriesapi | set_template | put /v2/repositories/{repositoryid}/entries/{entryId}/テンプレート | エントリにテンプレートを割り当てます。 |
| entriesapi | start_copy_entry | POST /V2/REPOSITRIES/{repositoryId}/entries/{entryId}/folder/copyasync | 非同期コピータスクを起動して、エントリをフォルダーにコピーします。 |
| entriesapi | start_delete_entry | delete /v2/repositories/{repositoryid}/entries/{entryId} | 非同期削除タスクを起動して、エントリを削除します。 |
| entriesapi | start_export_entry | POST /V2/REPOSITRIES/{repositoryId}/entries/{entryId}/exportasync | エントリをエクスポートするために、非同期エクスポートタスクを開始します。 |
| entriesapi | start_import_uploaded_parts | POST /V2/REPOSITRIES/{repositoryId}/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 | リポジトリに関連付けられたリンク定義を返します。 |
| repositriesapi | list_repositories | 取得/v2 /リポジトリ | ユーザーがアクセスできるリポジトリのリストを返します。 |
| Searchesapi | list_search_context_hits | get /v2/repositories/{repositoryid}/searches/{taskId}/results/{rownumber}/contexthits | 検索結果エントリに関連付けられたコンテキストヒットを返します。 |
| Searchesapi | list_search_results | get /v2/repositories/{repositoryid}/searches/{taskId}/results | 検索タスクに関連付けられた結果リストを返します。 |
| Searchesapi | start_search_entry | POST /V2/REPOSITRIES/{repositoryId}/searches/searchAsync | 非同期検索タスクを開始します。 |
| SimpleSearchESAPI | search_entry | POST /V2/REPOSITRIES/{repositoryId}/simpleSearches | ＆quot; simple＆quot;を実行します検索操作。 |
| tagdefinitionsapi | get_tag_definition | get /v2/repositories/{repositoryid}/tagdefinitions/{tagid} | 単一のタグ定義オブジェクトを返します。 |
| tagdefinitionsapi | list_tag_definitions | get /v2/repositories/{repositoryid}/tagdefinitions | リポジトリに関連付けられたタグ定義を返します。 |
| Tasksapi | cancel_tasks | 削除/v2/repositories/{repositoryid}/タスク | 1つ以上のタスクのセットのキャンセルを開始します。 |
| Tasksapi | list_tasks | get /v2/repositories/{repositoryid}/タスク | 1つ以上のタスクのセットのステータスを返します。 |
| TemplatedEfinitionSapi | get_template_definition | get /v2/repositories/{repositoryid}/templatedefinitions/{templateId} | 単一のテンプレート定義オブジェクトを返します。 |
| TemplatedEfinitionSapi | list_template_definitions | get /v2/repositories/{repositoryid}/templatedefinitions | リポジトリに関連付けられたテンプレート定義を返します。 |
| 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/{repositoryid}/templated -finitions/fielddefinitions | テンプレート定義に割り当てられたフィールド定義を（テンプレート定義名で）返します。 |
