esmlouvy-connector
Toto je datový konektor umožňující datovou výměnu mezi obchodní logikou aplikace eSMLOUVY a datovým serverem HCL Domino. Ovládá se pomocí REST API
This Python package is automatically generated by the Swagger Codegen project:
- API version: 1.1.1
- Package version: 1.1.1
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
Requirements.
Python 2.7 and 3.4+
Installation & Usage
pip install
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import esmlouvy_connector
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import esmlouvy_connector
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import esmlouvy_connector
from esmlouvy_connector.rest import ApiException
from pprint import pprint
# Configure API key authorization: apiKey
configuration = esmlouvy_connector.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = esmlouvy_connector.AdminsApi(esmlouvy_connector.ApiClient(configuration))
try:
# získá konfiguraci konektoru
api_response = api_instance.get_config()
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->get_config: %s\n" % e)
# Configure API key authorization: apiKey
configuration = esmlouvy_connector.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = esmlouvy_connector.AdminsApi(esmlouvy_connector.ApiClient(configuration))
try:
# získá konfiguraci databáze serveru Domino
api_response = api_instance.get_profile()
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->get_profile: %s\n" % e)
# Configure API key authorization: apiKey
configuration = esmlouvy_connector.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = esmlouvy_connector.AdminsApi(esmlouvy_connector.ApiClient(configuration))
try:
# získá pomocný profil (řízené slovníky) konfigurace databáze serveru Domino
api_response = api_instance.get_profile_dir()
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->get_profile_dir: %s\n" % e)
# Configure API key authorization: apiKey
configuration = esmlouvy_connector.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = esmlouvy_connector.AdminsApi(esmlouvy_connector.ApiClient(configuration))
try:
# získá pomocný profil (role) konfigurace databáze serveru Domino
api_response = api_instance.get_profile_roles()
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->get_profile_roles: %s\n" % e)
# Configure API key authorization: apiKey
configuration = esmlouvy_connector.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = esmlouvy_connector.AdminsApi(esmlouvy_connector.ApiClient(configuration))
body = esmlouvy_connector.ConfigBody() # ConfigBody | (optional)
try:
# aktualizuje hlavní konfiguraci konektoru
api_response = api_instance.put_config(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->put_config: %s\n" % e)
# Configure API key authorization: apiKey
configuration = esmlouvy_connector.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = esmlouvy_connector.AdminsApi(esmlouvy_connector.ApiClient(configuration))
body = esmlouvy_connector.ProfileMain() # ProfileMain | (optional)
try:
# aktualizuje nebo vytvoří hlavní konfiguraci aplikace Domino
api_response = api_instance.put_profile(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->put_profile: %s\n" % e)
# Configure API key authorization: apiKey
configuration = esmlouvy_connector.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = esmlouvy_connector.AdminsApi(esmlouvy_connector.ApiClient(configuration))
body = esmlouvy_connector.ProfileDirectory() # ProfileDirectory | (optional)
try:
# aktualizuje nebo vytvoří pomocný profil (řízené slovníky) konfigurace databáze serveru Domino
api_response = api_instance.put_profile_dir(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->put_profile_dir: %s\n" % e)
# Configure API key authorization: apiKey
configuration = esmlouvy_connector.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# create an instance of the API class
api_instance = esmlouvy_connector.AdminsApi(esmlouvy_connector.ApiClient(configuration))
body = esmlouvy_connector.ProfileRoles() # ProfileRoles | (optional)
try:
# aktualizuje nebo vytvoří pomocný profil (role) konfigurace databáze serveru Domino
api_response = api_instance.put_profile_roles(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->put_profile_roles: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://esmlouvy.sysnet.cz/SYSNET/eSMLOUVY/1.1.1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AdminsApi | get_config | GET /config | získá konfiguraci konektoru |
| AdminsApi | get_profile | GET /profile | získá konfiguraci databáze serveru Domino |
| AdminsApi | get_profile_dir | GET /profile_dir | získá pomocný profil (řízené slovníky) konfigurace databáze serveru Domino |
| AdminsApi | get_profile_roles | GET /profile_roles | získá pomocný profil (role) konfigurace databáze serveru Domino |
| AdminsApi | put_config | PUT /config | aktualizuje hlavní konfiguraci konektoru |
| AdminsApi | put_profile | PUT /profile | aktualizuje nebo vytvoří hlavní konfiguraci aplikace Domino |
| AdminsApi | put_profile_dir | PUT /profile_dir | aktualizuje nebo vytvoří pomocný profil (řízené slovníky) konfigurace databáze serveru Domino |
| AdminsApi | put_profile_roles | PUT /profile_roles | aktualizuje nebo vytvoří pomocný profil (role) konfigurace databáze serveru Domino |
| AttachmentsApi | delete_attachment | DELETE /attachment/{identifier} | odstraní přílohu i s metadaty |
| AttachmentsApi | get_attachment | GET /attachment/download/{identifier} | vrací soubor přílohy |
| AttachmentsApi | get_attachment_list | GET /attachment | získá seznam příloh |
| AttachmentsApi | get_attachment_list_container | GET /atachment/container/{container} | vrací seznam příloh v kontejneru |
| AttachmentsApi | get_attachment_list_document | GET /atachment/document/{document} | vrací seznam příloh v dokumentu |
| AttachmentsApi | get_attachment_metadata | GET /attachment/{identifier} | vrací metadata přílohy |
| AttachmentsApi | post_attachment | POST /attachment | uploaduje novou přílohu (Crud) |
| AttachmentsApi | put_attachment | PUT /attachment/{identifier} | aktualizuje metadata přílohy |
| DevelopersApi | info_api | GET /info | vrací servisní informace |
| NamesApi | get_authors | GET /authors | Vrátí všechna jména autorů |
| NamesApi | get_readers | GET /readers | Vrátí všechna jména čtenářů |
| NamesApi | replace_name | POST /replace_name | Zamění jméno ve všech dokumentech a polích, kde se vyskytuje |
| PublicApi | delete_budget_category | DELETE /budget_category/{identifier} | odstraní položku rozpočtového zařazení s daným identifikátorem (cruD) |
| PublicApi | delete_container | DELETE /container/{identifier} | odstraní dokumentový kontejner s daným identifikátorem (cruD) |
| PublicApi | delete_cover | DELETE /cover/{identifier} | odstraní krycí list s daným identifikátorem (cruD) |
| PublicApi | delete_payment_event | DELETE /payment_event/{identifier} | odstraní položku platebního kalenáře s daným identifikátorem (cruD) |
| PublicApi | delete_registration | DELETE /registration/{identifier} | odstraní evidenční list s daným identifikátorem (cruD) |
| PublicApi | delete_standpoint | DELETE /standpoint/{identifier} | odstraní stanovisko s daným identifikátorem (cruD) |
| PublicApi | get_budget_category | GET /budget_category/{identifier} | vrací položku rozpočtového zařazení s daným identifikátorem (cRud) |
| PublicApi | get_budget_category_list | GET /budget_category | vrací seznam rozpočtových zařazení |
| PublicApi | get_budget_category_list_by_dept | GET /budget_category/dept/{dept} | vrací všechna rozpočtová opatření pro útvar |
| PublicApi | get_container | GET /container/{identifier} | vrací dokumentový kontejner s daným identifikátorem (cRud) |
| PublicApi | get_container_content | GET /container/items/{identifier} | vrací obsah kontejneru s daným identifikátorem |
| PublicApi | get_container_list | GET /container | vrací seznam dokumentových kontejnerů |
| PublicApi | get_cover | GET /cover/{identifier} | vrací krycí list s daným identifikátorem (cRud) |
| PublicApi | get_cover_list | GET /cover | vrací seznam kycích listů |
| PublicApi | get_cover_list_container | GET /cover/container/{container} | vrací seznam kycích listů v kontejneru |
| PublicApi | get_payment_event | GET /payment_event/{identifier} | vrací položku platebního kalenáře s daným identifikátorem (cRud) |
| PublicApi | get_payment_event_list | GET /payment_event | vrací seznam položek platebního kalendáře |
| PublicApi | get_payment_event_list_parent | GET /payment_event/parent/{parent} | vrací seznam položek platebního kalendáře pro nadřazený dokument |
| PublicApi | get_registration | GET /registration/{identifier} | vrací evidenční list s daným identifikátorem (cRud) |
| PublicApi | get_registration_list | GET /registration | vrací seznam registračních listů |
| PublicApi | get_registration_list_container | GET /registration/container/{container} | vrací seznam registračních listů v kontejneru |
| PublicApi | get_standpoint | GET /standpoint/{identifier} | vrací stanovisko s daným identifikátorem (cRud) |
| PublicApi | get_standpoint_list | GET /standpoint | vrací seznam stanovisek |
| PublicApi | get_standpoint_list_container | GET /standpoint/container/{container} | vrací seznam stanovisek v kontejneru |
| PublicApi | get_standpoint_list_parent | GET /standpoint/parent/{parent} | vrací seznam stanovisek pro nadřízený dokument |
| PublicApi | post_budget_category | POST /budget_category | vytvoří novou položku rozpočtového zařazení (Crud) |
| PublicApi | post_container | POST /container | vytvoří nový dokumentový kontejner (Crud) |
| PublicApi | post_cover | POST /cover | vytvoří nový krycí list (Crud) |
| PublicApi | post_payment_event | POST /payment_event | vytvoří novou položku platebního kalendáře (Crud) |
| PublicApi | post_registration | POST /registration | vytvoří nový evidenční list (Crud) |
| PublicApi | post_standpoint | POST /standpoint | vytvoří nové stanovisko (Crud) |
| PublicApi | put_budget_category | PUT /budget_category/{identifier} | aktualizuje položku rozpočtového zařazení s daným identifikátorem (crUd) |
| PublicApi | put_container | PUT /container/{identifier} | aktualizuje dokumentový kontejner s daným identifikátorem (crUd) |
| PublicApi | put_cover | PUT /cover/{identifier} | aktualizuje krycí list s daným identifikátorem (crUd) |
| PublicApi | put_payment_event | PUT /payment_event/{identifier} | aktualizuje položku platebního kalenáře s daným identifikátorem (crUd) |
| PublicApi | put_registration | PUT /registration/{identifier} | aktualizuje evidenční list s daným identifikátorem (crUd) |
| PublicApi | put_standpoint | PUT /standpoint/{identifier} | aktualizuje stanovisko s daným identifikátorem (crUd) |
Documentation For Models
- Address
- BaseDominoDocument
- BaseSheetDocument
- BudgetCategory
- Choice
- Company
- ConfigBody
- Container
- CoverSheet
- DocumentAcl
- DocumentAttachment
- DocumentAttachmentEntry
- DocumentAttachmentList
- DocumentEntry
- DocumentEntryList
- DocumentHeader
- DocumentHidden
- DocumentWorkflow
- DominoCommons
- GeneralAcl
- PaymentEvent
- ProfileDirectory
- ProfileMain
- ProfileRoles
- RegistrationSheet
- ReplaceName
- Standpoint
Documentation For Authorization
apiKey
- Type: API key
- API key parameter name: X-API-KEY
- Location: HTTP header
Author
Metadata
Release files for sysnet-esmlouvy 1.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sysnet-esmlouvy-1.1.1.tar.gz | 77.5 kB | Without provenance | Details for sysnet-esmlouvy-1.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sysnet_esmlouvy-1.1.1-py3-none-any.whl | Python 3 | none | any | Details for sysnet_esmlouvy-1.1.1-py3-none-any.whl |
Total release size: 210.7 kB
Release files / sysnet-esmlouvy-1.1.1.tar.gz
| Download URL | sysnet-esmlouvy-1.1.1.tar.gz |
|---|---|
| Size | 77.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fe8981562ff02bf9108ef4797ab96c4469616aee81aa62b068e5469fad0c268c
|
|
BLAKE2b-256 checksum How to use checksums |
3c6166bc5819228ce3cd237893d89af0909a3e7e6e61794883b5eef569c246d7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.4
|
Release files / sysnet_esmlouvy-1.1.1-py3-none-any.whl
| Download URL | sysnet_esmlouvy-1.1.1-py3-none-any.whl |
|---|---|
| Size | 133.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
662f0d53c6091ab34ac3faf65b655f78c2733895f03d877d3a0b569a9a485c46
|
|
BLAKE2b-256 checksum How to use checksums |
02a34e93ee8ee76287c0e95b0271fb7ae6ad428cbb794267005aeb58755c62c3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.4
|
Security for sysnet-esmlouvy 1.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.