laserfiche_api
"1.1.0"
Este SDK de la API LaserFiche se genera automáticamente por Swagger-Codegen V3.
Puede encontrar la página PYPI para este proyecto aquí.
La API LaserFiche ha sido construida para trabajar con Openapi 3.0.0. Debido a esto, se debe usar Swagger-Codegen V3.
El script api_gen.sh en la carpeta API_GEN hará girar un contenedor Docker que ejecuta swagger-codegen-cli-v3 y exportará el SDK laserfiche_api a una carpeta con el mismo nombre.
Si los archivos SDK resultantes se empujan a su propio repositorio PYPI, se pueden instalar con:
pip install laserfiche-apiTambién puede instalar manualmente a través de SetupTools:
python setup.py install --userLa siguiente documentación se genera automáticamente por Swagger-Codegen.
Bienvenido al patio de swagger de la API LaserFiche. Puede probar cualquiera de nuestras llamadas de API contra su cuenta de Live LaserFiche Cloud. Visite el Centro de desarrolladores para obtener más detalles: <a href = "https: //developer.laserfiche.com "> https://developer.laserfiche.com
Visite el CangeLog para la lista de cambios: <a href = "/Repository/v2/Changelog">/Repository/v2/ChangeLog
Build#: 41A7347C0662989661D7AB8105A70D36CB42518E_.20240124.4
Este paquete Python es generado automáticamente por el proyecto Swagger Codegen:
Python 2.7 y 3.4+
Si el paquete Python está alojado en GitHub, puede instalar directamente desde Github
pip install git+https://github.com/Layer8Err/laserfiche_api.git (Es posible que deba ejecutar pip con permiso raíz: sudo pip install git+https://github.com/Layer8Err/laserfiche_api.git )
Luego importe el paquete:
import laserfiche_api Instalar a través de SetupTools.
python setup.py install --user (o sudo python setup.py install para instalar el paquete para todos los usuarios)
Luego importe el paquete:
import laserfiche_api Siga el procedimiento de instalación y luego ejecute lo siguiente:
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 )Todos los URI son relativos a https://api.laserfiche.com/repository
| Clase | Método | Solicitud HTTP | Descripción |
|---|---|---|---|
| Attributesapi | get_attribute | Get /v2/repositories/{RepositoryId}/atributes/{attributeKey} | Devuelve un objeto de atributo asociado con el usuario autenticado. |
| Attributesapi | list_attributes | Get /v2/repositories/{RepositoryId}/atributos | Devuelve los pares de valor de clave de atributo asociados con el usuario autenticado. |
| Auditrasonsonsapi | list_audit_reasons | Get /v2/repositories/{RepositoryId}/Auditrasons | Devuelve las razones de auditoría asociadas con el usuario autenticado. |
| Entradas | copy_entry | Post /v2/repositories/{RepositoryId}/entries/{entryID}/carpeta/copia | Copia una nueva entrada para niños en una carpeta. |
| Entradas | create_entry | Post /v2/repositories/{RepositoryId}/Entries/{EntryID}/carpeta/niños | Crea una nueva entrada de niño en una carpeta. |
| Entradas | create_multipart_upload_urls | Post /v2/repositories/{RepositoryId}/Entries/CreateMultipartUploadurls | Solicita la carga de URL para cargar un archivo grande en fragmentos. |
| Entradas | delete_electronic_document | Eliminar /v2/repositories/{RepositoryId}/Entries/{entryID}/document/edoc | Elimina el EDOC asociado con una entrada. |
| Entradas | eliminar_pages | Eliminar /v2/repositories/{RepositoryId}/Entries/{EntryID}/document/Pages | Elimina las páginas asociadas con una entrada. |
| Entradas | export_entry | Post /v2/repositories/{RepositoryId}/Entries/{EntryID}/Export | Exporta una entrada. |
| Entradas | get_entry | Get /v2/repositories/{RepositoryId}/Entries/{EntryID} | Devuelve un objeto de entrada único. |
| Entradas | get_entry_by_path | Get /v2/repositories/{RepositoryId}/Entries/bypath | Devuelve un objeto de entrada único usando la ruta de entrada. |
| Entradas | import_entry | Post /v2/repositories/{RepositoryId}/entries/{entryID}/carpeta/importación | Importa un archivo en una carpeta (longitud máxima: 100 MB). |
| Entradas | list_dynamic_field_values | Post /v2/repositories/{RepositoryId}/Entries/{EntryID}/Fields/GetDynamicfieldLogicValue | Devuelve los valores lógicos de campo dinámico asignados a una entrada. |
| Entradas | list_entries | Get /v2/repositories/{RepositoryId}/Entries/{entryID}/carpeta/niños | Devuelve las entradas para niños de una carpeta. |
| Entradas | list_fields | Get /v2/repositories/{RepositoryId}/Entries/{EntryID}/Fields | Devuelve los campos asignados a una entrada. |
| Entradas | list_links | Get /v2/repositories/{RepositoryId}/Entries/{EntryID}/Links | Devuelve los enlaces asignados a una entrada. |
| Entradas | list_tags | Get /v2/repositories/{RepositoryId}/Entries/{EntryID}/etiquetas | Devuelve las etiquetas asignadas a una entrada. |
| Entradas | remover_template | Eliminar /v2/repositories/{RepositoryId}/Entries/{EntryID}/plantilla | Elimina la plantilla asignada actualmente de una entrada. |
| Entradas | set_fields | Put /v2/repositories/{RepositoryId}/Entries/{EntryID}/Fields | Actualiza los valores de campo asignados a una entrada. |
| Entradas | set_links | Put /v2/repositories/{RepositoryId}/Entries/{EntryID}/Links | Asigna enlaces a una entrada. |
| Entradas | set_tags | Put /v2/repositories/{RepositoryId}/Entries/{EntryID}/etiquetas | Asigna etiquetas a una entrada. |
| Entradas | set_template | Put /v2/repositories/{RepositoryId}/Entries/{EntryID}/Template | Asigna una plantilla a una entrada. |
| Entradas | start_copy_entry | Post /v2/repositories/{RepositoryId}/Entries/{EntryID}/carpeta/copyAsync | Inicia una tarea de copia asíncrona para copiar una entrada en una carpeta. |
| Entradas | start_delete_entry | Eliminar /v2/repositories/{RepositoryId}/Entries/{EntryID} | Inicia una tarea de eliminación asíncrona para eliminar una entrada. |
| Entradas | start_export_entry | Post /v2/repositories/{RepositoryId}/Entries/{EntryID}/ExportAsync | Inicia una tarea de exportación asincrónica para exportar una entrada. |
| Entradas | start_import_uploaded_parts | Post /v2/repositories/{RepositoryId}/Entries/{EntryID}/carpeta/importuploadedParts | Inicia una tarea de importación asincrónica para importar un documento en una carpeta. |
| Entradas | update_entry | Patch /V2/Repositories/{RepositoryId}/Entries/{EntryID} | Actualizar una entrada. (Moverse y/o cambiar el nombre) |
| FieldDefinitionsapi | get_field_definition | Get /v2/repositories/{RepositoryId}/FieldDefinitions/{FieldID} | Devuelve un objeto de definición de campo único. |
| FieldDefinitionsapi | list_field_definitions | Get /v2/repositories/{RepositoryId}/FieldDefinitions | Devuelve la lista pagada de las definiciones de campo disponibles en un repositorio. |
| LinkDefinitionsapi | get_link_definition | Get /v2/repositories/{RepositoryId}/LinkDefinitions/{LinkDefinitionId} | Devuelve un objeto de definición de enlace único. |
| LinkDefinitionsapi | list_link_definitions | Get /v2/repositories/{RepositoryId}/LinkDefinitions | Devuelve las definiciones de enlace asociadas con un repositorio. |
| Repositoriesapi | list_repositories | Get /v2 /repositorios | Devuelve la lista de repositorios accesibles para el usuario. |
| Searchesapi | list_search_context_hits | Get /v2/repositories/{RepositoryId}/búsqueda/{taskID}/resultados/{Rownumber}/ContexThits | Devuelve los golpes de contexto asociados con una entrada de resultado de búsqueda. |
| Searchesapi | list_search_results | Get /v2/repositories/{RepositoryId}/búsqueda/{tareas}/resultados | Devuelve el listado de resultados asociado con una tarea de búsqueda. |
| Searchesapi | start_search_entry | Post /v2/repositories/{RepositoryId}/Searches/SearchAsync | Inicia una tarea de búsqueda asíncrona. |
| SimpleSearchesApi | Search_Entry | Post /v2/repositories/{RepositoryID}/SimplePleSearches | Ejecuta a & quot; simple & quot; Operación de búsqueda. |
| Tagdefinitionsapi | get_tag_definition | Get /v2/repositories/{RepositoryId}/tagdefinitions/{tagid} | Devuelve un objeto de definición de etiqueta único. |
| Tagdefinitionsapi | list_tag_definitions | Get /v2/repositories/{RepositoryID}/tagdefinitions | Devuelve las definiciones de etiqueta asociadas con un repositorio. |
| Tasksapi | cancel_tasks | Eliminar /v2/repositories/{RepositoryID}/tareas | Inicia la cancelación de un conjunto de una o más tareas. |
| Tasksapi | list_tasks | Get /v2/repositories/{RepositoryID}/tareas | Devuelve el estado de un conjunto de una o más tareas. |
| Templatedefinitionsapi | get_template_definition | Get /v2/repositories/{RepositoryId}/TemplateFinitions/{TemplateId} | Devuelve un objeto de definición de plantilla única. |
| Templatedefinitionsapi | list_template_definitions | Get /v2/repositories/{RepositoryId}/TemplatedFinitions | Devuelve las definiciones de plantilla asociadas con un repositorio. |
| Templatedefinitionsapi | list_template_field_definitions_by_template_id | Get /v2/repositories/{RepositoryId}/TemplateFinitions/{TemplateId}/FieldDefinitions | Devuelve las definiciones de campo asignadas a una definición de plantilla (por ID de definición de plantilla). |
| Templatedefinitionsapi | list_template_field_definitions_by_template_name | Get /v2/repositories/{RepositoryId}/TemplatedFinitions/FieldDefinitions | Devuelve las definiciones de campo asignadas a una definición de plantilla (por nombre de definición de plantilla). |
