laserfiche_api
"1.1.0"
Este Laserfiche API SDK é gerado automaticamente pelo Swagger-Codegen V3.
Você pode encontrar a página Pypi para este projeto aqui.
A API do laserfiche foi construída para trabalhar com o OpenAPI 3.0.0. Por esse motivo, o swagger-codegen v3 deve ser usado.
O script api_gen.sh na pasta API_GEN girará um contêiner do Docker executando swagger-codegen-cli-v3 e exportará o laserfiche_api SDK para uma pasta com o mesmo nome.
Se os arquivos SDK resultantes forem empurrados para o seu próprio repo Pypi, eles poderão ser instalados com:
pip install laserfiche-apiVocê também pode se instalar manualmente via setuptools:
python setup.py install --userA documentação a seguir é gerada automaticamente pelo Swagger-CodeGen.
Bem -vindo ao playground da Laserfiche API Swagger. Você pode experimentar qualquer uma das nossas chamadas de API contra sua conta Live Laserfiche Cloud. Visite o Centro de Desenvolvedores para obter mais detalhes: <a href = "https: //developer.laserfiche.com "> https://developer.laserfiche.com
Visite o Changelog para obter a lista de alterações: <a href = "/repositório/v2/changelog">/repositório/v2/changelog
Build#: 41A7347C0662989661D7AB8105A70D36CB42518E_.20240124.4
Este pacote Python é gerado automaticamente pelo Projeto Swagger CodeGen:
Python 2.7 e 3.4+
Se o pacote Python estiver hospedado no Github, você poderá instalar diretamente no GitHub
pip install git+https://github.com/Layer8Err/laserfiche_api.git (Você pode precisar executar pip com permissão de raiz: sudo pip install git+https://github.com/Layer8Err/laserfiche_api.git )
Em seguida, importe o pacote:
import laserfiche_api Instale via setuptOols.
python setup.py install --user (ou sudo python setup.py install para instalar o pacote para todos os usuários)
Em seguida, importe o pacote:
import laserfiche_api Siga o procedimento de instalação e execute o seguinte:
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 os Uris são relativos a https://api.laserfiche.com/repository
| Aula | Método | Solicitação http | Descrição |
|---|---|---|---|
| Atributospi | get_attribute | Get /v2/repositórios/{repositoryId}/atributes/{attributeKey} | Retorna um objeto de atributo associado ao usuário autenticado. |
| Atributospi | list_attributes | Get /v2/repositórios/{repositoryId}/atributos | Retorna os pares do valor da chave do atributo associados ao usuário autenticado. |
| AuditReAsonsApi | list_audit_reasons | Get /v2/repositórios/{repositoryId}/auditresons | Retorna os motivos de auditoria associados ao usuário autenticado. |
| Entradaspi | copy_entry | Post /v2/repositórios/{repositoryId}/entres/{EntryId}/pasta/cópia | Copia uma nova entrada infantil em uma pasta. |
| Entradaspi | create_entry | Post /v2/repositórios/{repositoryId}/entres/{EntryId}/pasta/filhos | Cria uma nova entrada infantil em uma pasta. |
| Entradaspi | create_multipart_upload_urls | Post /v2/repositórios/{repositoryId}/entres/createMultipartUploadurls | Solicita que o upload de URLs para fazer upload de um arquivo grande em pedaços. |
| Entradaspi | delete_electronic_document | Excluir /v2/repositórios/{repositoryId}/entres/{entradas}/document/edoc | Exclui o EDOC associado a uma entrada. |
| Entradaspi | Delete_Pages | Excluir /v2/repositórios/{repositoryId}/entres/{entradas}/document/páginas | Exclui as páginas associadas a uma entrada. |
| Entradaspi | export_entry | Post /v2/repositórios/{repositoryId}/entres/{EntryId}/export | Exporta uma entrada. |
| Entradaspi | get_entry | Get /v2/repositórios/{repositoryId}/entres/{Entrada} | Retorna um único objeto de entrada. |
| Entradaspi | get_entry_by_path | Get /v2/repositórios/{repositoryId}/entradas/bypath | Retorna um único objeto de entrada usando o caminho de entrada. |
| Entradaspi | import_entry | Post /v2/repositórios/{repositoryId}/entres/{EntryId}/pasta/import | Importa um arquivo em uma pasta (comprimento máximo: 100 MB). |
| Entradaspi | list_dynamic_field_values | Post /v2/repositórios/{repositoryId}/entres/{EntryId}/fields/getDynamicFieldLogicValue | Retorna os valores da lógica dinâmica do campo atribuídos a uma entrada. |
| Entradaspi | list_entries | Get /v2/repositórios/{repositoryId}/entres/{EntryId}/pasta/filhos | Retorna as entradas das crianças de uma pasta. |
| Entradaspi | list_fields | Get /v2/repositórios/{repositoryId}/entres/{EntryId}/campos | Retorna os campos atribuídos a uma entrada. |
| Entradaspi | list_links | Get /v2/repositórios/{repositoryId}/entres/{EntryId}/links | Retorna os links atribuídos a uma entrada. |
| Entradaspi | list_tags | Get /v2/repositórios/{repositoryId}/entres/{EntryId}/tags | Retorna as tags atribuídas a uma entrada. |
| Entradaspi | remove_template | Excluir /v2/repositórios/{repositoryId}/entres/{EntryId}/modelo | Remove o modelo atualmente atribuído de uma entrada. |
| Entradaspi | set_fields | Put /v2/repositórios/{repositoryId}/entres/{EntryId}/campos | Atualiza os valores do campo atribuídos a uma entrada. |
| Entradaspi | set_links | Put /v2/repositórios/{repositoryId}/entres/{EntryId}/links | Atribui links a uma entrada. |
| Entradaspi | set_tags | Put /v2/repositórios/{repositoryId}/entres/{EntryId}/tags | Atribui tags a uma entrada. |
| Entradaspi | set_template | Put /v2/repositórios/{repositoryId}/entres/{EntryId}/modelo | Atribui um modelo a uma entrada. |
| Entradaspi | start_copy_entry | Post /v2/repositórios/{repositoryId}/entres/{EntryId}/pasta/copyasync | Inicia uma tarefa de cópia assíncrona para copiar uma entrada em uma pasta. |
| Entradaspi | start_delete_entry | Delete /v2/repositórios/{repositoryId}/entres/{Entrada} | Inicia uma tarefa de exclusão assíncrona para excluir uma entrada. |
| Entradaspi | start_export_entry | Post /v2/repositórios/{repositoryId}/entres/{EntryId}/exportAsync | Inicia uma tarefa de exportação assíncrona para exportar uma entrada. |
| Entradaspi | START_IMPORT_UPLOADED_PARTS | Post /v2/repositórios/{repositoryId}/entres/{EntryId}/pasta/importPploadEdParts | Inicia uma tarefa de importação assíncrona para importar um documento para uma pasta. |
| Entradaspi | update_entry | Patch /v2/repositórios/{repositoryId}/entres/{Entrada} | Atualize uma entrada. (Mover e/ou renomear) |
| FieldDefinitionSapi | get_field_definition | Get /v2/repositórios/{repositoryId}/fieldDefinitions/{fieldId} | Retorna um objeto de definição de campo único. |
| FieldDefinitionSapi | list_field_definitions | Get /v2/repositórios/{repositoryId}/fieldDefinitions | Retorna a listagem paginada das definições de campo disponíveis em um repositório. |
| LinkDefinitionSapi | get_link_definition | Get /v2/repositórios/{repositoryId}/linkDefinitions/{linkDefinitionId} | Retorna um único objeto de definição de link. |
| LinkDefinitionSapi | list_link_definitions | Get /v2/repositórios/{repositoryId}/linkDefinitions | Retorna as definições de link associadas a um repositório. |
| Repositorespi | list_repositórios | Get /V2 /Repositórios | Retorna a lista de repositórios acessíveis ao usuário. |
| Searchesapi | list_search_context_hits | Get /v2/repositórios/{repositoryId}/searches/{taskId}/resulta/{rownumber}/contexthits | Retorna os acertos de contexto associados a uma entrada de resultado de pesquisa. |
| Searchesapi | list_search_results | Get /v2/repositórios/{repositoryId}/searches/{taskId}/resultados | Retorna a lista de resultados associados a uma tarefa de pesquisa. |
| Searchesapi | start_search_entry | Post /v2/repositórios/{repositoryId}/searches/SearchAsync | Inicia uma tarefa de pesquisa assíncrona. |
| Simpleearchesapi | Search_entry | Post /v2/repositórios/{repositoryId}/simpleearches | Executa um "simples" operação de pesquisa. |
| TagDefinitionSapi | get_tag_definition | Get /v2/repositórios/{repositoryId}/tagdefinitions/{tagid} | Retorna um objeto de definição de tag único. |
| TagDefinitionSapi | list_tag_definitions | Get /v2/repositórios/{repositoryId}/tagdefinitions | Retorna as definições de tag associadas a um repositório. |
| TaskSapi | cancel_tasks | Exclua /v2/repositórios/{repositoryId}/tarefas | Inicia o cancelamento para um conjunto de uma ou mais tarefas. |
| TaskSapi | list_tasks | Get /v2/repositórios/{repositoryId}/tarefas | Retorna o status de um conjunto de uma ou mais tarefas. |
| ModificadofinitionSapi | get_template_definition | Get /v2/repositórios/{repositoryId}/modatefinitions/{templateId} | Retorna um único objeto de definição de modelo. |
| ModificadofinitionSapi | list_template_definitions | Get /v2/repositórios/{repositoryId}/modatefinitions | Retorna as definições de modelo associadas a um repositório. |
| ModificadofinitionSapi | list_template_field_definition_by_template_id | Get /v2/repositórios/{repositoryId}/modatefinitions/{templateId}/fieldDefinitions | Retorna as definições de campo atribuídas a uma definição de modelo (por ID de definição de modelo). |
| ModificadofinitionSapi | list_template_field_definition_by_template_name | Get /v2/repositórios/{repositoryId}/modatefinitions/FieldDefinitions | Retorna as definições de campo atribuídas a uma definição de modelo (por nome da definição de modelo). |
