laserfiche_api
"1.1.0"
Этот лазерный API SDK автоматически генерируется Swagger-Codegen V3.
Вы можете найти страницу PYPI для этого проекта здесь.
API Laserfiche был построен для работы с OpenAPI 3.0.0. Из-за этого необходимо использовать Swagger-Codegen V3.
Сценарий api_gen.sh под папкой API_GEN будет раскручивать контейнер Docker, работающий swagger-codegen-cli-v3 и экспортирует SDK laserfiche_api в папку с тем же именем.
Если полученные файлы SDK перенесены на их собственное репо -репо, они могут быть установлены с:
pip install laserfiche-apiВы также можете вручную установить через Setuptools:
python setup.py install --userСледующая документация создается автоматически с помощью Swagger-Codegen.
Добро пожаловать на детскую площадку API Swagger Laserfiche. Вы можете попробовать любой из наших вызовов API против вашей живой облачной учетной записи Laserfiche. Посетите Центр разработчиков для получения более подробной информации: <a href = "https: //developer.laserfiche.com "> https://developer.laserfiche.com
Посетите изменение изменений для списка изменений: <a href = "/Repository/V2/ChangeLog">/Repository/V2/Changelog
Build#: 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 -запрос | Описание |
|---|---|---|---|
| Атрибутапи | get_attribute | Get /v2/repositories/{RepositoryId}/attributes/{attributeKey} | Возвращает объект атрибута, связанный с аутентифицированным пользователем. |
| Атрибутапи | list_attributes | Get /v2/repositories/{repositoryId}/атрибуты | Возвращает пары значения ключа атрибута, связанные с аутентифицированным пользователем. |
| Auditreasonsapi | list_audit_reasons | Get /v2/repositories/{repositoryId}/auditreasons | Возвращает причины аудита, связанные с аутентифицированным пользователем. |
| Записи | copy_entry | Post /v2/repositories/{repositoryId}/intries/{intrintId}/folder/copy | Копирует новую запись ребенка в папке. |
| Записи | create_entry | Post /v2/repositories/{repositoryId}/intries/{intrintId}/folder/дети | Создает новую запись ребенка в папке. |
| Записи | create_multipart_upload_urls | Post /v2/repositories/{repositoryId}/записи/createMultIpartUploadUrls | Запрашивает загрузку URL -адреса для загрузки большого файла в куски. |
| Записи | delete_electronic_document | Delete /v2/Repositories/{RepositoryId}/intries/{entryId}/document/edoc | Удаляет EDOC, связанный с записью. |
| Записи | delete_pages | Delete /v2/repositories/{RepositoryId}/intries/{entryId}/document/pages | Удаляет страницы, связанные с записью. |
| Записи | Export_Entry | Post /v2/repositories/{RepositoryId}/intries/{entryId}/export | Экспортирует запись. |
| Записи | get_entry | Get /v2/repositories/{repositoryId}/intries/{intrintId} | Возвращает один объект входа. |
| Записи | get_entry_by_path | Get /v2/repositories/{repositoryId}/записи/bypath | Возвращает один объект входа, используя путь входа. |
| Записи | Import_Entry | Post /v2/repositories/{repositoryId}/intries/{intrintId}/folder/import | Импорт файл в папку (максимальная длина: 100 МБ). |
| Записи | list_dynamic_field_values | Post /v2/repositories/{repositoryId}/intries/{intryId}/fields/getDynamicfieldLogicValue | Возвращает значения логики динамического поля, назначенные записи. |
| Записи | list_entries | Get /v2/repositories/{repositoryId}/intries/{intrintId}/folder/children | Возвращает детей в папку. |
| Записи | list_fields | Get /v2/repositories/{repositoryId}/intries/{intrintId}/fields | Возвращает поля, назначенные записи. |
| Записи | list_links | Get /v2/repositories/{RepositoryId}/intries/{intrintId}/links | Возвращает ссылки, назначенные записи. |
| Записи | list_tags | Get /v2/repositories/{repositoryId}/intries/{intrintId}/теги | Возвращает теги, назначенные записи. |
| Записи | удалить_template | Delete /v2/Repositories/{RepositoryId}/intries/{entryId}/шаблон | Удаляет назначенный в настоящее время шаблон из записи. |
| Записи | set_fields | Put /v2/repositories/{repositoryId}/intries/{intryId}/fields | Обновляет значения поля, назначенные записи. |
| Записи | set_links | Put /v2/repositories/{repositoryId}/intries/{intrintId}/links | Назначает ссылки на запись. |
| Записи | set_tags | Put /v2/repositories/{repositoryId}/intries/{entryId}/теги | Назначает теги на запись. |
| Записи | set_template | Put /v2/repositories/{repositoryId}/intries/{entryId}/шаблон | Назначает шаблон записи. |
| Записи | start_copy_entry | Post /v2/repositories/{repositoryId}/intries/{intrintId}/folder/copyAsync | Запускает задачу асинхронной копии, чтобы скопировать запись в папку. |
| Записи | start_delete_entry | DELETE /V2/Repositories/{RepositoryId}/intries/{intrintId} | Запускает асинхронную задачу удаления, чтобы удалить запись. |
| Записи | start_export_entry | Post /v2/repositories/{repositoryId}/intries/{entryId}/exportAsync | Запускает асинхронную экспортную задачу для экспорта записи. |
| Записи | start_import_uploaded_parts | Post /v2/repositories/{repositoryId}/intries/{intrintId}/folder/importUploadedParts | Запускает асинхронную задачу импорта, чтобы импортировать документ в папку. |
| Записи | Update_Entry | Patch /v2/repositories/{RepositoryId}/intries/{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 | Возвращает определения ссылок, связанные с репозиторием. |
| Repositoriesapi | List_repositories | Получить /v2 /репозитории | Возвращает список репозиториев, доступных для пользователя. |
| SearchSapi | list_search_context_hits | Get /v2/repositories/{repositoryId}/searches/{taskId}/results/{rownumber}/contexthits | Возвращает контекст, связанные с записью результатов поиска. |
| SearchSapi | list_search_results | Get /v2/repositories/{RepositoryId}/searches/{taskId}/результаты | Возвращает список результатов, связанный с задачей поиска. |
| SearchSapi | start_search_entry | Post /v2/repositories/{repositoryId}/searches/searchAsync | Запускает асинхронную задачу поиска. |
| Simplesearchesapi | search_entry | Post /v2/repositories/{RepositoryId}/simplesearches | Запускает "простой" Поиск операции. |
| Tagdefinitionsapi | get_tag_definition | Get /v2/repositories/{RepositoryId}/TagDefinitions/{Tagid} | Возвращает один объект определения тега. |
| Tagdefinitionsapi | list_tag_definitions | Get /v2/repositories/{RepositoryId}/TagDefinitions | Возвращает определения тегов, связанные с репозиторием. |
| Tasksapi | cancel_tasks | DELETE /V2/Repositories/{RepositoryId}/Задачи | Запускает отмену для набора из одной или нескольких задач. |
| Tasksapi | list_tasks | Get /v2/repositories/{RepositoryId}/Задачи | Возвращает статус набора из одной или нескольких задач. |
| TemplatedFinitionsapi | get_template_definition | Get /v2/repositories/{RepositoryId}/TemplatedEfinitions/{TemplateId} | Возвращает один объект определения шаблона. |
| TemplatedFinitionsapi | list_template_definitions | Get /v2/repositories/{RepositoryId}/TemplatedFinitions | Возвращает определения шаблона, связанные с репозиторием. |
| TemplatedFinitionsapi | list_template_field_definitions_by_template_id | Get /v2/repositories/{RepositoryId}/TemplatedFinitions/{TemplateId}/FieldDefinitions | Возвращает определения поля, присвоенные определению шаблона (по идентификатору определения шаблона). |
| TemplatedFinitionsapi | list_template_field_definitions_by_template_name | Get /v2/repositories/{RepositoryId}/TemplatedFinitions/FieldDefinitions | Возвращает определения поля, присвоенные определению шаблона (по имени определения шаблона). |
