laserfiche_api
"1.1.0"
Diese Laserfiche-API SDK wird durch Swagger-Codegen V3 automatisch generiert.
Hier finden Sie die PYPI -Seite für dieses Projekt.
Die Laserfiche -API wurde für die Arbeit mit OpenAPI 3.0.0 gebaut. Aus diesem Grund muss Swagger-Codegen V3 verwendet werden.
Das Skript api_gen.sh unter dem Ordner API_GEN dreht einen Docker-Container swagger-codegen-cli-v3 ausführt und den laserfiche_api SDK mit demselben Namen in einen Ordner exportiert.
Wenn die resultierenden SDK -Dateien in ein eigenes PYPI -Repo geschoben werden, können sie mit:
pip install laserfiche-apiSie können auch manuell über Setuptools installieren:
python setup.py install --userDie folgende Dokumentation wird durch Swagger-Codegen automatisch generiert.
Willkommen auf dem Laserfiche API Swagger Playground. Sie können einen unserer API -Anrufe an Ihrem Live -Laserfiche -Cloud -Konto ausprobieren. Besuchen Sie das Entwicklerzentrum für weitere Informationen: <a href = "https: //developer.laserfiche.com "> https://developer.laserfiche.com
Besuchen Sie den ChangeLog für die Liste der Änderungen: <a href = "/repository/v2/changelog">/repository/v2/changelog
Build#: 41A7347C0662989661D7AB8105A70D36CB42518E_.20240124.4
Dieses Python -Paket wird automatisch vom Swagger Codegen -Projekt generiert:
Python 2.7 und 3.4+
Wenn das Python -Paket auf GitHub gehostet wird, können Sie direkt bei GitHub installieren
pip install git+https://github.com/Layer8Err/laserfiche_api.git (Möglicherweise müssen Sie pip mit Root -Berechtigung ausführen: sudo pip install git+https://github.com/Layer8Err/laserfiche_api.git )
Importieren Sie dann das Paket:
import laserfiche_api Installieren Sie über Setuptools.
python setup.py install --user (oder sudo python setup.py install , um das Paket für alle Benutzer zu installieren)
Importieren Sie dann das Paket:
import laserfiche_api Bitte befolgen Sie die Installationsverfahren und führen Sie dann Folgendes aus:
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 )Alle URIs sind relativ zu https://api.laserfiche.com/repository
| Klasse | Verfahren | HTTP -Anfrage | Beschreibung |
|---|---|---|---|
| Attribute | get_attribute | Get /v2/repositories/{repositoryId}/satrons/{attributekey}} | Gibt ein Attributobjekt zurück, das dem authentifizierten Benutzer zugeordnet ist. |
| Attribute | list_attributes | GET /V2/Repositories/{RepositoryID}/Attribute | Gibt die dem authentifizierten Benutzer zugeordneten Attributschlüsselwertpaare zurück. |
| Auditrasonsapi | list_audit_reasons | GET /V2/Repositories/{RepositoryID}/AuditReasons | Gibt die mit dem authentifizierten Benutzer verbundenen Prüfungsgründe zurück. |
| Einträge | COPY_ENTRY | Post /v2/repositories/{repositoryID}/Einträge/{Eintrags -ID}/Ordner/kopieren | Kopiert einen neuen Kindereintrag in einem Ordner. |
| Einträge | create_entry | Post /v2/repositories/{repositoryId}/Einträge/{EntryID}/Ordner/Kinder | Erstellt einen neuen Kindereintrag in einem Ordner. |
| Einträge | create_multipart_upload_urls | Post /v2/repositories/{repositoryId}/Einträge/CreateMultipartUploadurls | Fordert URLs hoch, um eine große Datei in Stücken hochzuladen. |
| Einträge | Delete_electronic_document | Delete /v2/repositories/{repositoryID}/Einträge/{Eintragsdocal}/document/edoc | Löscht die EDOC, die mit einem Eintrag verbunden ist. |
| Einträge | delete_pages | Delete /v2/Repositories/{repositoryID}/Einträge/{EntryID}/document/pages | Löscht die mit einem Eintrag verbundenen Seiten. |
| Einträge | Export_entry | Post /v2/repositories/{repositoryId}/Einträge/{Eintragung}/export | Exportiert einen Eintrag. |
| Einträge | get_entry | Get /v2/repositories/{repositoryId}/Einträge/{Eintragsdias}} | Gibt ein einzelnes Einstiegsobjekt zurück. |
| Einträge | get_entry_by_path | GET /V2/Repositories/{RepositoryID}/Einträge/ByPath | Gibt ein einzelnes Eintragsobjekt mit dem Eintragspfad zurück. |
| Einträge | Import_entry | Post /v2/repositories/{repositoryID}/Einträge/{Eintrags -ID}/Ordner/Import | Importiert eine Datei in einen Ordner (maximale Länge: 100 MB). |
| Einträge | list_dynamic_field_values | Post /v2/repositories/{repositoryId}/Einträge/{EntryID}/fields/getDynamicfieldLogicValue | Gibt die dynamischen Feldlogikwerte zurück, die einem Eintrag zugewiesen wurden. |
| Einträge | list_entries | Get /v2/Repositories/{repositoryId}/Einträge/{EntryID}/Ordner/Kinder | Gibt die Kindereinträge eines Ordners zurück. |
| Einträge | list_fields | Get /v2/Repositories/{repositoryId}/Einträge/{Eintragung}/Fields | Gibt die Felder zurück, die einem Eintrag zugewiesen wurden. |
| Einträge | list_links | Get /v2/Repositories/{repositoryID}/Einträge/{Eintragung}/Links | Gibt die Links zurück, die einem Eintrag zugewiesen sind. |
| Einträge | list_tags | Get /v2/Repositories/{repositoryId}/Einträge/{Eintragung}/Tags | Gibt die Tags zurück, die einem Eintrag zugewiesen sind. |
| Einträge | entfernen_template | Delete /v2/repositories/{repositoryID}/Einträge/{Eintragsdiid}/Vorlage | Entfernt die aktuell zugewiesene Vorlage aus einem Eintrag. |
| Einträge | set_fields | Put /v2/repositories/{repositoryId}/Einträge/{Eintrags -ID}/Fields | Aktualisiert die Feldwerte, die einem Eintrag zugewiesen wurden. |
| Einträge | set_links | Put /v2/repositories/{repositoryId}/Einträge/{Eintrags -ID}/Links | Weist Links zu einem Eintrag zu. |
| Einträge | set_tags | Put /v2/repositories/{repositoryId}/Einträge/{Eintrags -ID}/Tags | Weist einen Eintrag Tags zu. |
| Einträge | set_template | Put /v2/repositories/{repositoryId}/Einträge/{Eintrags -ID}/Vorlage | Weist einem Eintrag eine Vorlage zu. |
| Einträge | start_copy_entry | Post /v2/repositories/{repositoryID}/Einträge/{Eintrags -ID}/Ordner/CopyaSync | Startet eine asynchrone Kopieraufgabe, um einen Eintrag in einen Ordner zu kopieren. |
| Einträge | start_delete_entry | Löschen /v2/repositories/{repositoryId}/Einträge/{Eintragsdise} | Startet eine asynchrone Löschaufgabe, um einen Eintrag zu löschen. |
| Einträge | start_export_entry | Post /v2/repositories/{repositoryId}/Einträge/{Eintrags -ID}/exportasync | Startet eine asynchrone Exportaufgabe, um einen Eintrag zu exportieren. |
| Einträge | start_import_uploaded_parts | Post /v2/repositories/{repositoryID}/Einträge/{Eintrags -ID}/Ordner/ImporpotedParts | Startet eine asynchrone Importaufgabe, um ein Dokument in einen Ordner zu importieren. |
| Einträge | UPDATE_ENTRY | Patch /v2/repositories/{repositoryId}/Einträge/{Eintrags -ID} | Aktualisieren Sie einen Eintrag. (Bewegung und/oder umbenennen) |
| FieldDefinitionsapi | get_field_definition | Get /v2/repositories/{repositoryId}/fieldDefinitions/{fieldId} | Gibt ein einzelnes Felddefinitionsobjekt zurück. |
| FieldDefinitionsapi | list_field_definitions | Get /v2/Repositories/{repositoryId}/fieldDefinitions | Gibt die in einem Repository verfügbare Felddefinitionen der ausgelieferten Felddefinitionen zurück. |
| Linkdefinitionsapi | get_link_definition | Get /v2/repositories/{repositoryId}/linkDefinitions/{linkDefinitionID}} | Gibt ein einzelnes Link -Definitionsobjekt zurück. |
| Linkdefinitionsapi | list_link_definitions | Get /v2/repositories/{repositoryId}/linkDefinitions | Gibt die Link -Definitionen zurück, die einem Repository zugeordnet sind. |
| Repositoriesapi | list_repositories | Get /v2 /Repositories | Gibt die Liste der Repositories zurück, die dem Benutzer zugegriffen werden können. |
| Suche | list_search_context_hits | Get /v2/repositories/{repositoryId}/suches/{taskId}/resultation/{Rownumber}/contexThits | Gibt den Kontext -Treffern zurück, die einem Suchergebniseintrag zugeordnet sind. |
| Suche | list_search_results | Get /v2/Repositories/{repositoryId}/suchvorgänge/{taskId}/Ergebnisse | Gibt die mit einer Suchaufgabe verknüpfte Ergebnisse auf. |
| Suche | start_search_entry | Post /v2/repositories/{repositoryId}/suches/searchaSync | Startet eine asynchrone Suchaufgabe. |
| Simplesearchesapi | Search_entry | Post /v2/repositories/{repositoryId}/simplesearches | Läuft a & quot; einfach & quot; Suchoperation. |
| Tagdefinitionsapi | get_tag_definition | Get /v2/repositories/{repositoryId}/Tagdefinitions/{Tagid} | Gibt ein einzelnes Tag -Definitionsobjekt zurück. |
| Tagdefinitionsapi | list_tag_definitions | Get /v2/repositories/{repositoryId}/Tagdefinitions | Gibt die Tag -Definitionen zurück, die einem Repository zugeordnet sind. |
| Aufgaben | Cancel_tasks | Löschen /v2/Repositories/{repositoryId}/tasks | Startet die Stornierung für einen oder mehrerer Aufgaben. |
| Aufgaben | list_tasks | Get /v2/Repositories/{repositoryId}/tasks | Gibt den Status eines Satzes einer oder mehrerer Aufgaben zurück. |
| Templatedefinitionsapi | get_template_definition | Get /v2/repositories/{repositoryId}/templatedefinitions/{templateId}} | Gibt ein einzelnes Vorlagendefinitionsobjekt zurück. |
| Templatedefinitionsapi | list_template_definitions | Get /v2/Repositories/{repositoryId}/templatedefinitions | Gibt die Vorlagendefinitionen zurück, die einem Repository zugeordnet sind. |
| Templatedefinitionsapi | list_template_field_definitions_by_template_id | Get /v2/repositories/{repositoryId}/templatedefinitions/{templateId}/fieldDeFinitions | Gibt die Felddefinitionen zurück, die einer Vorlagendefinition zugewiesen wurden (nach Vorlagendefinitions -ID). |
| Templatedefinitionsapi | list_template_field_definitions_by_template_name | Get /v2/Repositories/{repositoryId}/templatedefinitions/fieldDefinitions | Gibt die Felddefinitionen zurück, die einer Vorlagendefinition zugewiesen wurden (nach Namensdefinitionsname). |
