laserfiche_api
"1.1.0"
Ce SDK API LaserFiche est généré automatiquement par Swagger-Codegen V3.
Vous pouvez trouver la page PYPI pour ce projet ici.
L'API LaserFiche a été conçue pour fonctionner avec OpenAPI 3.0.0. Pour cette raison, Swagger-Codegen V3 doit être utilisé.
Le script api_gen.sh dans le dossier API_GEN fera tourner un conteneur Docker exécutant swagger-codegen-cli-v3 et exportera le SDK laserfiche_api vers un dossier avec le même nom.
Si les fichiers SDK résultants sont poussés vers leur propre dépôt PYPI, ils peuvent être installés avec:
pip install laserfiche-apiVous pouvez également installer manuellement via setuptools:
python setup.py install --userLa documentation suivante est générée automatiquement par Swagger-Codegen.
Bienvenue sur le terrain de jeu de Swagger API Laserfiche. Vous pouvez essayer l'un de nos appels API contre votre compte cloud LaserFiche en direct. Visitez le Centre des développeurs pour plus de détails: <a href = "https: //developer.laserfiche.com "> https://developer.laserfiche.com
Visitez le Changelog pour la liste des modifications: <a href = "/ référentiel / v2 / changelog"> / référentiel / v2 / changelog
Build #: 41A7347C0662989661D7AB8105A70D36CB42518E_.20240124.4
Ce package Python est automatiquement généré par le projet Swagger Codegen:
Python 2.7 et 3.4+
Si le package Python est hébergé sur GitHub, vous pouvez installer directement à partir de GitHub
pip install git+https://github.com/Layer8Err/laserfiche_api.git (Vous devrez peut-être exécuter pip avec la permission root: sudo pip install git+https://github.com/Layer8Err/laserfiche_api.git )
Puis importez le package:
import laserfiche_api Installez via setuptools.
python setup.py install --user (ou sudo python setup.py install pour installer le package pour tous les utilisateurs)
Puis importez le package:
import laserfiche_api Veuillez suivre la procédure d'installation, puis exécuter ce qui suit:
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 )Tous les uris sont relatifs à https://api.laserfiche.com/repository
| Classe | Méthode | Demande HTTP | Description |
|---|---|---|---|
| Attributsapi | get_attribut | Get / v2 / repositories / {RepositoryId} / attributs / {attributKey} | Renvoie un objet d'attribut associé à l'utilisateur authentifié. |
| Attributsapi | list_attributes | GET / V2 / REPOSITORIES / {RepositoryID} / Attributs | Renvoie les paires de valeurs de clé d'attribut associées à l'utilisateur authentifié. |
| AuditreaSonsapi | list_audit_reasons | Get / V2 / Repositories / {RepositoryId} / AuditereAsons | Renvoie les raisons d'audit associées à l'utilisateur authentifié. |
| Entrées | copie_entry | POST / V2 / REPOSITORIES / {RepositoryID} / Entrées / {EntryID} / Folder / Copie | Copie une nouvelle entrée pour enfants dans un dossier. |
| Entrées | create_entry | Post / V2 / Repositories / {RepositoryID} / Entrées / {EntryID} / Folder / Enfants | Crée une nouvelle entrée pour enfants dans un dossier. |
| Entrées | CREATE_MULTIPART_UPLOAD_URLS | Post / V2 / Repositories / {RepositoryID} / Entrées / CreateMultupartuploadurls | Demandes de téléchargement URL pour télécharger un grand fichier en morceaux. |
| Entrées | delete_electronic_document | Delete / v2 / repositories / {repositoryId} / entrées / {entréeid} / document / edoc | Supprime l'EDOC associé à une entrée. |
| Entrées | delete_pages | DELETE / V2 / Repositories / {RepositoryID} / Entrées / {EntryID} / Document / Pages | Supprime les pages associées à une entrée. |
| Entrées | export_entry | POST / V2 / REPOSITORIES / {RepositoryID} / Entrées / {EntryID} / Exportation | Exporte une entrée. |
| Entrées | get_entry | Get / v2 / repositories / {RepositoryId} / entrées / {entrée} | Renvoie un seul objet d'entrée. |
| Entrées | get_entry_by_path | Get / v2 / repositories / {RepositoryId} / Entrées / contourner | Renvoie un seul objet d'entrée à l'aide du chemin d'entrée. |
| Entrées | import_entry | POST / V2 / REPOSITORIES / {RepositoryID} / Entrées / {EntryID} / Folder / Importation | Importe un fichier dans un dossier (longueur maximale: 100 Mo). |
| Entrées | list_dynamic_field_values | Post / V2 / Repositories / {RepositoryID} / Entrées / {EntryID} / Fields / GetDynamicFieldLogicValue | Renvoie les valeurs de logique de champ dynamique attribuées à une entrée. |
| Entrées | list_entries | Get / v2 / repositories / {RepositoryId} / entrées / {entrée} / dossier / enfants | Renvoie les entrées des enfants d'un dossier. |
| Entrées | list_fields | Get / v2 / repositories / {RepositoryId} / entrées / {entryID} / champs | Renvoie les champs attribués à une entrée. |
| Entrées | list_links | Get / v2 / repositories / {RepositoryId} / entrées / {entryID} / liens | Renvoie les liens attribués à une entrée. |
| Entrées | list_tags | Get / v2 / repositories / {RepositoryId} / entrées / {entrée} / tags | Renvoie les balises attribuées à une entrée. |
| Entrées | retire_template | Delete / v2 / repositories / {RepositoryID} / entrées / {entrée} / modèle | Supprime le modèle actuellement attribué d'une entrée. |
| Entrées | set_fields | Put / v2 / repositories / {RepositoryId} / entrées / {entryID} / champs | Met à jour les valeurs de champ attribuées à une entrée. |
| Entrées | set_links | Put / v2 / repositories / {RepositoryId} / entrées / {entrée} / liens | Attribue des liens vers une entrée. |
| Entrées | set_tags | Put / v2 / repositories / {repositoryId} / entrées / {entryID} / tags | Attribue des balises à une entrée. |
| Entrées | set_template | Put / v2 / repositories / {repositoryId} / entrées / {entryID} / modèle | Attribue un modèle à une entrée. |
| Entrées | start_copy_entry | POST / V2 / REPOSITORIES / {RepositoryID} / Entrées / {EntryID} / Folder / CopyAsync | Démarre une tâche de copie asynchrone pour copier une entrée dans un dossier. |
| Entrées | start_delete_entry | Delete / v2 / repositories / {RepositoryId} / Entrées / {EntryID} | Commence une tâche de suppression asynchrone pour supprimer une entrée. |
| Entrées | start_export_entry | Post / V2 / Repositories / {RepositoryId} / Entrées / {EntryID} / Exportasync | Commence une tâche d'exportation asynchrone pour exporter une entrée. |
| Entrées | start_import_uploaded_parts | POST / V2 / REPOSITORIES / {RepositoryID} / Entrées / {EntryID} / Folder / ImportUploadParts | Commence une tâche d'importation asynchrone pour importer un document dans un dossier. |
| Entrées | update_entry | Patch / V2 / Repositories / {RepositoryID} / Entrées / {EntryID} | Mettez à jour une entrée. (Bouger et / ou renommer) |
| FieldDefinitionsAPI | get_field_definition | Get / v2 / repositories / {RepositoryId} / fieldDefinitions / {field} | Renvoie un seul objet de définition de champ. |
| FieldDefinitionsAPI | list_field_definitions | Get / v2 / repositories / {RepositoryId} / fieldDefinitions | Renvoie la liste Paged des définitions de champ disponibles dans un référentiel. |
| Linkdefinitionsapi | get_link_definition | Get / v2 / repositories / {RepositoryId} / linkdefinitions / {linkdefinitionId} | Renvoie un seul objet de définition de lien. |
| Linkdefinitionsapi | list_link_definitions | Get / v2 / repositories / {RepositoryId} / linkdefinitions | Renvoie les définitions de liens associées à un référentiel. |
| Repositoriesapi | list_repositoires | Get / V2 / Référentiels | Renvoie la liste des référentiels accessibles à l'utilisateur. |
| Searchesapi | list_search_context_hits | Get / v2 / repositories / {RepositoryId} / Searches / {taskID} / Results / {Rownumber} / ContexThits | Renvoie le contexte Hits associé à une entrée de résultat de recherche. |
| Searchesapi | list_search_results | Get / v2 / repositories / {RepositoryId} / searches / {taskID} / Résultats | Renvoie la liste des résultats associée à une tâche de recherche. |
| Searchesapi | start_search_entry | Post / V2 / Repositories / {RepositoryId} / Searches / Searchasync | Commence une tâche de recherche asynchrone. |
| SimpleSearchesapi | search_entry | Post / V2 / Repositories / {RepositoryID} / SimpleSearches | Exécute A & quot; Simple & quot; Fonctionnement de recherche. |
| TagDefinitionsapi | get_tag_definition | Get / v2 / repositories / {RepositoryId} / tagDefinitions / {tagid} | Renvoie un seul objet de définition de balise. |
| TagDefinitionsapi | list_tag_definitions | Get / v2 / repositories / {RepositoryId} / tagDefinitions | Renvoie les définitions de balises associées à un référentiel. |
| Tâches | Cancel_tasks | DELETE / V2 / REPOSITORIES / {RepositoryId} / Tâches | Commence l'annulation pour un ensemble d'une ou plusieurs tâches. |
| Tâches | list_tasks | Get / v2 / Repositories / {RepositoryId} / tâches | Renvoie l'état d'un ensemble d'une ou plusieurs tâches. |
| TemplatedEfinitionsapi | get_template_definition | Get / v2 / repositories / {RepositoryId} / templadefinitions / {templateID} | Renvoie un objet de définition de modèle unique. |
| TemplatedEfinitionsapi | list_template_definitions | Get / v2 / repositories / {RepositoryId} / TemplatedEfinitions | Renvoie les définitions de modèle associées à un référentiel. |
| TemplatedEfinitionsapi | list_template_field_definitions_by_template_id | Get / v2 / repositories / {RepositoryId} / TemplatedEfinitions / {templateId} / fieldDefinitions | Renvoie les définitions de champ attribuées à une définition de modèle (par modèle de définition de modèle). |
| TemplatedEfinitionsapi | list_template_field_definitions_by_template_name | Get / v2 / repositories / {RepositoryId} / TemplatedEfinitions / FieldDefinitions | Renvoie les définitions de champ attribuées à une définition de modèle (par nom de définition de modèle). |
