Lex Power Sign (előzetes verzió)
A Lex Persona egy európai minősített bizalmi szolgáltató, amely számos elektronikus aláírási megoldást kínál. A Lex Enterprise-nal az összes eIDAS-aláírási szinthez hozzáférhet, valamint számos aláíró hitelesítési módszerhez. Az aláírási könyvek digitális munkafolyamatokba vannak ágyazva. Automatizálhatja a Lex Enterprise és az összes eszköz közötti kapcsolatokat az ismétlődő feladatok kiküszöbölése, a hatékonyság növelése és a vállalkozás felgyorsítása érdekében.
Ez az összekötő a következő termékekben és régiókban érhető el:
| Service | Class | Régiók |
|---|---|---|
| Copilot Studio | prémium | Az összes Power Automate-régió, kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD) |
| Logikai alkalmazások | Standard | Az összes Logic Apps-régió , kivéve a következőket: - Azure Government-régiók - Azure China-régiók - Amerikai Védelmi Minisztérium (DoD) |
| Power Alkalmazások | prémium | Az összes Power Apps-régió , kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD) |
| Power Automate | prémium | Az összes Power Automate-régió, kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD) |
| Érintkezés | |
|---|---|
| Név | Lex Persona-támogatás |
| URL | https://support.lex-persona.com |
| support@lex-persona.com |
| Összekötő metaadatai | |
|---|---|
| Kiadó | Lex Persona |
| Webhely | https://www.lex-persona.com |
| Adatvédelmi irányelvek | https://www.lex-persona.com/politique-de-confidentialite/ |
| Kategóriák | AI; Webhely |
A Lex Persona egy európai minősített bizalmi szolgáltató, amely számos elektronikus aláírási megoldást kínál. Ezzel az összekötővel egyszerűen hozzáadhatja az elektronikus aláírási képességet a Microsoft-alapú alkalmazáshoz (PowerApp, .NET-alapú webalkalmazás, Dynamics...) és környezetéhez (Outlook, SharePoint, Teams...). Az összekötőt a Lex Enterprise Munkafolyamat-kezelője is alátámasztja. Különböző típusú lépésekből álló elektronáta-aláírási munkafolyamatokat hozhat létre, amelyek sorrendben és/vagy párhuzamosan végrehajthatók. Az összekötő támogatja az összes eIDAS-aláírási szintet, és számos aláíró hitelesítési módszert kínál (OTP, SSO, France Connect, Identité Numérique La Poste, hardveres tokenek...)
Előfeltételek
A folytatáshoz a következőkre lesz szüksége:
- Lex Enterprise-előfizetés. A próbacsomag használata a teszteléshez
A környezeti követelmények a következők:
- Microsoft Power Apps- vagy Power Automate-csomag egyéni összekötő funkcióval
- A Power Platform CLI-eszközei
Hitelesítő adatok lekérése
Kérjük, vegye fel a kapcsolatot értékesítési képviselőivel commercial@lex-persona.com , hogy lex Enteprise-előfizetést vagy egy fiókot szerezzen a próbaverziós rendszereinken.
Csatlakozzon a Lex Enterprise portálhoz a fiókjával, és hozzon létre egy API-kulcsot.
Ismerkedés az összekötővel
Először hozzon létre egy kapcsolatot az összekötőhöz. Állítsa be a hitelesítési módszert API-kulcsra, adja meg az API-kulcsot ("Tulajdonos act_XXXXXXX"), és adja meg, hogy az API-kulcsot az API-hívások Autrorization fejlécében kell elhelyezni.
Az egyszerű aláírási munkafolyamat létrehozásának lépései a következők:
- közvetlenül a tigger után kérje le a csatlakoztatott Lex Enterprise felhasználói azonosítót (erre az azonosítóra van szükség egy munkafolyamat létrehozásához) a Lekéréses művelettel
- keresési hozzájárulási oldalak a keresési hozzájárulási oldalakkal action_. A szöveges paraméter használatával név alapján kereshet a hozzájárulási oldalakon (a hozzájárulási oldalak határozzák meg az aláírási szintet, és előre konfigurálva vannak a Lex Enterprise-környezetben)
- aláírási munkafolyamat létrehozása a Munkafolyamat létrehozása művelettel. Ebben a lépésben meg kell adnia az aláírók adatait.
- aláírási profilok keresése a Keresési aláírási profilok művelettel. A szöveges paraméterrel név alapján kereshet az aláírási profilokban (az aláírási profilok a hozzájárulási lapok viselkedésének bizonyos aspektusait szabályozzák). Kényszerítse az aláírót, hogy például aláírás előtt görgessen a dokumentum aljára)
- Dokumentum lekérése a környezetből (SharePoint, Outlook, OneDrive...)
- adja hozzá a dokumentumot a munkafolyamathoz a Create part művelettel, és állítsa a createDocument paramétert igazra
- indítsa el a munkafolyamatot a Munkafolyamat frissítése művelettel, és állítsa a munkafolyamat állapotátindításra
Felhívjuk: Az összekötő alapértelmezés szerint párosítva van a próbaverziós kiszolgálóval. Ha az összekötőt a saját bérlőjével szeretné párosítani, módosítania kell a gazdagép URL-címét az összekötő biztonsági definíciójában vagy a apiDefinitions.json fájlban:
- "host": "yourtenant.lexpersona.com",
Problémák és korlátozások ismerete
A Dokumentum létrehozása művelet elfogadja a hasznos adatokban lévő dokumentumrészek listáját. Ha azonban több alkatrészt ad meg, csak az elsőt veszi figyelembe a rendszer (ezt az API hibája okozza). Ezt az összekötő következő kiadásában kijavítjuk).
Ezért, ha több dokumentumot szeretne hozzáadni egy munkafolyamathoz, a Create part meghívását kell végrehajtania, és a createDocument paraméter igaz értékre van állítva az egyes dokumentumokhoz.
Gyakori hibák és jogorvoslatok
API-híváshiba esetén az API-hívás válasza egy átfogó hibaüzenetet tartalmaz, amely az összekötő futtatási előzményeiben jelenik meg. Az üzenet naplóazonosítót is tartalmaz, így ha további információra van szüksége a hibáról, csatlakozhat a Lex Enteprise portálhoz, és megtekintheti a kiszolgáló naplófájlját. Alternativley, beállíthatja a Postman kérést, hogy keressen a szerver naplók (plase tekintse meg a dokumentációt: https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html#search-logs).
Az API által visszaadott leggyakoribb HTTP-hibakódok a következők:
- 400-os hiba – Hibás kérés. Hiba történt a kérelem kifizetésében. A hiba okával kapcsolatos információkért tekintse meg a naplót
- 401-s hiba – Jogosulatlan. Nem rendelkezik hozzáférési jogosultságokkal a művelet végrehajtásához. A Lex Persona felhasználói hozzáférési jogosultságának ellenőrzése
- 403-os hiba – Tiltott. Az API-kulcs inverz vagy le van tiltva
- 404-s hiba – Nem található. Hiba történt a kérés URL-címében
A dokumentációban további részleteket is találhat az egyes API-hívások lehetséges hibakódjairól (https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html)
GYIK
Az összekötő által támogatott dokumentumformátumok
Az aláírásra küldhető dokumentumok pdf, docx, pptx és xlsx formátumúak lehetnek. Az összekötő szükség esetén pdf formátumba konvertálja a dokumentumokat, és az aláírások PAdES formátumúak lesznek.
XML-dokumentumokat is aláírhat. Ebben az esetben a rendszer nem alkalmaz átalakítást, és az aláírások XAdES formátumúak lesznek.
Zip-fájlokat is feltölthet. Az összekötő kibontja az archívumot, és minden dokumentumot hozzáad a munkafolyamathoz.
Mellékleteket is hozzáadhat az aláírási munkafolyamatokhoz. A melléklet nincs aláírva, és bármilyen formátummal rendelkezhet.
Egy dokumentum több aláíróval is rendelkezhet
Igen. A dokumentumok aláíróinak száma korlátlan.
Egyszerre több dokumentumot is aláírhat?
Igen. Több dokumentumot is hozzáadhat egy munkafolyamathoz, és az összes dokumentum egyidejűleg lesz aláírva. Vegye figyelembe azonban, hogy ebben az esetben a dokumentumkészletet juridriálisan összekapcsoljuk, és hogy a rendszer egyedi bizonyítékfájlt fog létrehozni.
Létrehozhat mutlpiple workglowst is, amely ugyanazt az aláírót használja. Aláíráskor a dokumentumok listája megjelenik az aláírónak, és az aláírónak lehetősége lesz kiválasztani az aláíráshoz szükséges dokumentumokat. Ebben az esetben a dokumentumok jogi szempontból függetlenek lesznek, és minden dokumentumhoz előállítunk egy bizonyítékfájlt.
Lehet-e offline aláírni egy dokumentumot?
Nem. A hozzájárulási oldalak eléréséhez intenet kapcsolatra van szükség.
Lehet-e automatikus aláírás-remidereket küldeni az aláíróknak?
Igen. Konfigurálhatja az emlékeztető időszakát és a küldendő emlékeztetők maximális számát.
Lehetséges módosítani egy már megkezdett aláírási munkafolyamatot
Igen. Aláírás előtt bármit módosíthat a munkafolyamatban. Az első aláírás után nem lehet módosítani a dokumentumokat, de továbbra is módosíthatja a munkafolyamat lépéseit.
Az egyszeri jelszavak érvényességi időtartama
A One Time Passwords érvényességi időtartama két perc (a hozzájárulási oldalakon egy countdow jelenik meg).
Ellenőrizhető-e az elektronikus aláírás érvényessége?
Az Adobe Acrobat Aláírások paneljén ellenőrizheti a pdf-dokumentumban található aláírások érvényességét. Másik lehetőségként használhat megbízható aláírás-érvényesítési webszolgáltatást (https://ec.europa.eu/digital-building-blocks/DSS/webapp-demo/validation például)
Mik a Lex Persona-dokumentum tárolási feltételei?
Alapértelmezés szerint a dokumentumokat bizonyítékként tároljuk a kiszolgálókon. A Tou bármikor kereshet és tölthet le dokumentumokat. Igény esetén azonban alapvetően törölhetjük a dokumentumait a kiszolgálóinkról.
Megtartja-e a Lex Persona az időbélyeg-jogkivonatokat?
Nem. Nem tartjuk meg az időbélyeg-jogkivonatokat. Szükség esetén ezeket a jogkivonatokat extracxtálhatja az aláírt dokumentumokból.
Van-e elállási időszak egy aláírt dokumentum esetében?
Igen. A visszavonási periond a dokumentumra vonatkozó jogi feltételektől függ.
Le lehet mondani egy aláírási munkafolyamatot?
Igen. A szerzői jogosultságokkal rendelkező felhasználók bármikor megszakíthatják a megkezdett aláírási munkafolyamatokat. A rendszer nem hoz létre kiürítési fájlt, és ha a dokumentumot egy vagy több aláíró már aláírta, a rendszer érvényteleníti a kilakoltatásokat.
Kapcsolat létrehozása
Az összekötő a következő hitelesítési típusokat támogatja:
| Alapértelmezett | A kapcsolat létrehozásának paraméterei. | Minden régió | Nem osztható meg |
Alapértelmezett
Alkalmazható: Minden régió
A kapcsolat létrehozásának paraméterei.
Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.
| Név | Típus | Description | Kötelező |
|---|---|---|---|
| API-kulcs | securestring | Az API API-kulcsa | True |
Szabályozási korlátok
| Name | Hívások | Megújítási időszak |
|---|---|---|
| API-hívások kapcsolatonként | 100 | 60 másodperc |
Műveletek
| A lap url-címének lekérése |
A címzett hozzájárulási oldalának URL-címének létrehozása és lekérése |
| Alkatrész létrehozása |
Dokumentumrész létrehozása |
| Aláírási profil frissítése |
Aláírási profil frissítése |
| Aláírási profil lekérése |
Aláírási profil lekérése |
| Aláírási profil létrehozása |
Aláírási profil létrehozása |
| Aláírási profilok keresése |
Aláírási profilok keresése |
| Bizonyítékfájl letöltése |
A munkafolyamat bizonyítékfájljának letöltése |
| Dokumentum frissítése |
Dokumentum frissítése |
| Dokumentum lekérése |
Dokumentum lekérése |
| Dokumentum létrehozása |
Dokumentum létrehozása előre létrehozott részekből |
| Dokumentum törlése |
Dokumentum törlése |
| Dokumentumok keresése |
Dokumentumok keresése |
| Hozzájárulási lapok keresése |
Hozzájárulási lapok keresése |
| Hozzájárulási oldal lekérése |
Hozzájárulási oldal adatainak lekérése a hozzájárulási oldal azonosítójából |
| Kapcsolattartó létrehozása |
Partner hozzáadása az aktuális felhasználó partnerlistájához |
| Keresési munkafolyamatok |
Keresési munkafolyamatok |
| Lekérés |
A csatlakoztatott felhasználói azonosító lekérése |
| Metaadat-elrendezés létrehozása |
Metaadat-elrendezés létrehozása |
| Metaadat-elrendezések keresése |
Munkafolyamat-elrendezések keresése |
| Metaadatok elrendezésének frissítése |
Metaadat-elrendezés frissítése |
| Metaadatok elrendezésének lekérése |
Munkafolyamat-elrendezés lekérése |
| Metaadatok leképezésének lekérése |
A megadott bérlő metaadat-leképezésének lekérése |
| Munkafolyamat-dokumentumok letöltése |
A munkafolyamat dokumentumainak letöltése |
| Munkafolyamat frissítése |
Munkafolyamat frissítése |
| Munkafolyamat lekérése |
Munkafolyamat lekérése munkafolyamat-azonosítóból |
| Munkafolyamat létrehozása |
Munkafolyamat létrehozása |
| Munkafolyamat törlése |
Munkafolyamat törlése |
| Névjegy frissítése |
Meglévő kapcsolattartási adatok módosítása |
| Névjegy törlése |
Partner eltávolítása az aktuális felhasználó contects listájából |
| Partner lekérése |
Kapcsolattartási adatok lekérése a partnerazonosítóból |
| Partnerek keresése |
Partnerek keresése |
A lap url-címének lekérése
A címzett hozzájárulási oldalának URL-címének létrehozása és lekérése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Munkafolyamat-azonosító
|
workflowId | True | string |
A munkafolyamat azonosítója |
|
Címzett e-mail címe
|
recipientEmail | string |
Az érintett címzett e-mail-címe |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Az érintett címzett hozzájárulási oldalának URL-címe
|
inviteUrl | string |
Az érintett címzett hozzájárulási oldalának URL-címe |
Alkatrész létrehozása
Dokumentumrész létrehozása
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Munkafolyamat-azonosító
|
workflowId | True | string |
Az érintett munkafolyamat azonosítója |
|
Tartalomtípus
|
Content-Type | True | string |
Tartalom típusa |
|
Cotent Disposition
|
Content-Disposition | True | string |
Tartalomeloszlás |
|
Dokumentum létrehozása
|
createDocuments | string |
Dokumentum létrehozása ebből a részből |
|
|
Mellékletek figyelmen kívül hagyása
|
ignoreAttachments | string |
A mellékletek figyelmen kívül lesznek hagyva |
|
|
Aláírási profil azonosítója
|
signatureProfileId | string |
Mellékletnek minősülő rész, ha nincs megadva |
|
|
Csomagolja ki
|
unzip | string |
Fájlok kibontás |
|
|
Pdf–PdfA
|
pdf2pdfa | string |
Pdf konvertálása pdf/A formátumra |
|
|
Dokumentum
|
document | True | binary |
A feltöltött fájladatok |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Dokumentumok
|
documents | array of document |
Dokumentumok létrehozása |
|
ignoredAttachments
|
ignoredAttachments | integer |
ignoredAttachments |
|
Részek
|
parts | array of part |
Részek |
Aláírási profil frissítése
Aláírási profil frissítése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Aláírási profil azonosítója
|
spId | True | string |
Az aláírási profil azonosítója |
|
Tartalomtípus
|
Content-Type | True | string |
Tartalom típusa |
|
Alapértelmezett
|
isDefault | string |
Ez az aláírási profil lesz az alapértelmezett |
|
|
Le van tiltva
|
isDisabled | string |
Az aláírási profil letiltása |
|
|
Név
|
name | string |
Az aláírási profil neve |
|
|
Aláírás típusa
|
signatureType | string |
pades,xades,xadesDetached,xadesDetachedManifest,cades,helios |
|
|
A dokumentum aljára görgetés kényszerítése
|
forceScrollDocument | boolean |
Az aláíró kényszerítése a dokumentum aljára görgetéshez |
|
|
Látható aláírási mód
|
pdfVisibleSignatureMode | string |
Látható aláírási mód (engedélyezett, letiltva, noImage) |
|
|
Aláírás szövege
|
pdfSignatureImageText | string |
Aláíráspárnákban megjelenő szöveg |
|
|
Aláírás szövegszíne
|
pdfSignatureImageTextColor | string |
A szöveg színe a színösszefűzési párnákban |
|
|
Aláírás szövegmérete
|
pdfSignatureImageTextSize | number |
Az ingatures párnákban megjelenő szöveg mérete |
Válaszok
- Törzs
- signatureProfile
Aláírási profil lekérése
Aláírási profil lekérése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Aláírási profil azonosítója
|
spId | True | string |
Az aláírási profil azonosítója |
Válaszok
- Törzs
- signatureProfile
Aláírási profil létrehozása
Aláírási profil létrehozása
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Bérlőazonosító
|
tenantId | True | string |
A bérlő azonosítója |
|
Tartalomtípus
|
Content-Type | True | string |
Tartalom típusa |
|
Alapértelmezett
|
isDefault | True | string |
Ez az aláírási profil lesz az alapértelmezett |
|
Le van tiltva
|
isDisabled | string |
Az aláírási profil letiltása |
|
|
Név
|
name | True | string |
Az aláírási profil neve |
|
Dokumentum típusa
|
documentType | True | string |
pdf, xml, word, excel, powerpoint, egyéb |
|
Aláírás típusa
|
signatureType | True | string |
pades,xades,xadesDetached,xadesDetachedManifest,cades,helios |
|
A dokumentum aljára görgetés kényszerítése
|
forceScrollDocument | True | boolean |
Az aláíró kényszerítése a dokumentum aljára görgetéshez |
|
Látható aláírási mód
|
pdfVisibleSignatureMode | string |
Látható aláírási mód (engedélyezett, letiltva, noImage) |
|
|
Aláírás szövege
|
pdfSignatureImageText | string |
Aláíráspárnákban megjelenő szöveg |
|
|
Aláírás szövegszíne
|
pdfSignatureImageTextColor | string |
A szöveg színe a színösszefűzési párnákban |
|
|
Aláírás szövegmérete
|
pdfSignatureImageTextSize | number |
Az ingatures párnákban megjelenő szöveg mérete |
Válaszok
- Törzs
- signatureProfile
Aláírási profilok keresése
Aláírási profilok keresése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Szöveg keresése
|
text | string |
Szöveg keresése |
|
|
Alapértelmezett keresés
|
items.isDefault | string |
Alapértelmezett aláírási profilok keresése |
|
|
Keresés letiltva
|
items.isDisabled | string |
Letiltott aláírási profilok keresése |
|
|
Keresési név
|
items.name | string |
Keresés aláírási profilnév alapján |
|
|
Keresési dokumentum típusa
|
items.documentType | string |
Keresés dokumentumtípus szerint |
|
|
Keresés aláírástípusa
|
items.signatureType | string |
Keresés aláírástípus szerint |
|
|
Keresés létrehozási dátuma
|
items.created | string |
Keresés létrehozási dátum szerint |
|
|
Keresési frissítés dátuma
|
items.updated | string |
Keresés a legutóbbi frissítés dátuma szerint |
|
|
Rendezési szempont:
|
sortBy | string |
A keresési eredmény rendezéséhez használt mező |
|
|
Rendezési sorrend
|
sortOrder | string |
A rendezés iránya |
|
|
Cikkek száma oldalanként
|
itemsPerPage | string |
A válasz oldalankénti elemeinek száma |
|
|
Lapindex
|
pageIndex | string |
A visszaadott oldal indexe |
Válaszok
- Törzs
- signatureProfiles
Bizonyítékfájl letöltése
A munkafolyamat bizonyítékfájljának letöltése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Munkafolyamat-azonosító
|
workflowId | True | string |
A munkafolyamat azonosítója |
|
Elfogadás
|
Accept | True | string |
Elfogadás |
Válaszok
- response
- binary
Dokumentum frissítése
Dokumentum frissítése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
A dokumentum azonosítója |
|
Tartalomtípus
|
Content-Type | True | string |
Tartalom típusa |
|
signatureProfileId
|
signatureProfileId | string |
A dokumentumhoz aply-ként használni kívánt aláírási profil |
|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
|
imagePage
|
imagePage | float |
imagePage |
|
|
imageWidth
|
imageWidth | float |
imageWidth |
|
|
imageX
|
imageX | float |
imageX |
|
|
imageY
|
imageY | float |
imageY |
Válaszok
- Törzs
- document
Dokumentum lekérése
Dokumentum lekérése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
A dokumentum azonosítója |
Válaszok
- Törzs
- document
Dokumentum létrehozása
Dokumentum létrehozása előre létrehozott részekből
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Munkafolyamat-azonosító
|
workflowId | True | string |
Az érintett munkafolyamat azonosítója |
|
Tartalomtípus
|
Content-Type | True | string |
Tartalom típusa |
|
tartalomtípus
|
contentType | string |
tartalomtípus |
|
|
filename
|
filename | string |
filename |
|
|
kivonat
|
hash | string |
kivonat |
|
|
size
|
size | integer |
size |
|
|
signatureProfileId
|
signatureProfileId | string |
A dokumentum aláírási profilja |
Válaszok
- Törzs
- document
Dokumentum törlése
Dokumentum törlése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
A dokumentum azonosítója |
Válaszok
- Törzs
- document
Dokumentumok keresése
Dokumentumok keresése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Szöveg keresése
|
text | string |
Szöveg keresése |
|
|
Metaadat-elrendezés keresése
|
items.layoutId | string |
Keresés metaadat-elrendezés szerint |
|
|
Keresési csoport
|
items.groupId | string |
Keresés felhasználói csoport szerint |
|
|
Felhasználó keresése
|
items.userId | string |
Keresés tulajdonos szerint |
|
|
Munkafolyamat-azonosító keresése
|
items.workflowId | string |
Keresés munkafolyamat-azonosító szerint |
|
|
Keresési munkafolyamat neve
|
items.workflowName | string |
Keresés munkafolyamat neve szerint |
|
|
Metaadatok keresése 1
|
items.data1 | string |
Keresés a metaadatok értéke szerint 1 |
|
|
Metaadatok keresése 2
|
items.data2 | string |
Keresés a metaadatok értéke szerint 2 |
|
|
Metaadatok keresése 3
|
items.data3 | string |
Keresés a metaadatok értéke szerint 3 |
|
|
Metaadatok keresése 4
|
items.data4 | string |
Keresés a metaadatok értéke szerint 4 |
|
|
Metaadatok keresése 5
|
items.data5 | string |
Keresés a metaadatok értéke szerint 5 |
|
|
Metaadatok keresése 6
|
items.data6 | string |
Keresés a metaadatok értéke szerint 6 |
|
|
Metaadatok keresése 7
|
items.data7 | string |
Keresés a metaadatok értéke szerint 7 |
|
|
Metaadatok keresése 8
|
items.data8 | string |
Keresés a metaadatok értéke szerint 8 |
|
|
Keresési aláírási profil
|
items.signatureProfileId | string |
Keresés aláírási profil alapján |
|
|
Keresés létrehozási dátuma
|
items.created | string |
Keresés létrehozási dátum szerint |
|
|
Keresési frissítés dátuma
|
items.updated | string |
Keresés a legutóbbi frissítés dátuma szerint |
|
|
Rendezési szempont:
|
sortBy | string |
A keresési eredmény rendezéséhez használt mező |
|
|
Rendezési sorrend
|
sortOrder | string |
A rendezés iránya |
|
|
Cikkek száma oldalanként
|
itemsPerPage | string |
A válasz oldalankénti elemeinek száma |
|
|
Lapindex
|
pageIndex | string |
A visszaadott oldal indexe |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
items
|
items | documents |
Hozzájárulási lapok keresése
Hozzájárulási lapok keresése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Szöveg keresése
|
text | string |
Szöveg keresése |
|
|
Alapértelmezett keresés
|
items.isDefault | string |
Alapértelmezett hozzájárulási oldal keresése |
|
|
Keresés letiltva
|
items.isDisabled | string |
Letiltott hozzájárulási lapok keresése |
|
|
Keresési név
|
items.name | string |
Keresés hozzájárulási oldal neve alapján |
|
|
Keresési lépés típusa
|
items.stepType | string |
Keresés lépéstípus szerint |
|
|
Keresés ügyfélazonosítója
|
items.clientId | string |
Keresés ügyfélazonosító szerint |
|
|
Keresés létrehozási dátuma
|
items.created | string |
Keresés létrehozási dátum szerint |
|
|
Keresési frissítés dátuma
|
items.updated | string |
Keresés a legutóbbi frissítés dátuma szerint |
|
|
Rendezési szempont:
|
sortBy | string |
Az a mező, amelyre a keresési eredményt rendezni szeretné |
|
|
Rendezési sorrend
|
sortOrder | string |
A rendezés iránya |
|
|
Cikkek száma oldalanként
|
itemsPerPage | string |
A válasz oldalankénti elemeinek száma |
|
|
Lapindex
|
pageIndex | string |
A visszaadott oldal indexe |
Válaszok
- Törzs
- consentPages
Hozzájárulási oldal lekérése
Hozzájárulási oldal adatainak lekérése a hozzájárulási oldal azonosítójából
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Hozzájárulás oldalazonosítója
|
cpId | True | string |
A hozzájárulási oldal azonosítója |
|
Tartalomtípus
|
Content-Type | True | string |
Tartalom típusa |
Válaszok
- Törzs
- consentPage
Kapcsolattartó létrehozása
Partner hozzáadása az aktuális felhasználó partnerlistájához
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Felhasználóazonosító
|
userId | True | string |
Felhasználó, akihez a partner tartozik |
|
Tartalomtípus
|
Content-Type | True | string |
Tartalom típusa |
|
Kapcsolattartási e-mail-cím
|
True | string |
Kapcsolattartási e-mail-cím |
|
|
Contatct telefonszám
|
phoneNumber | string |
telefonszám |
|
|
Kapcsolattartó utóneve
|
firstName | True | string |
keresztnév |
|
Kapcsolattartó vezetékneve
|
lastName | True | string |
lastName |
|
Kapcsolattartási ország
|
country | string |
country |
Válaszok
- Törzs
- contact
Keresési munkafolyamatok
Keresési munkafolyamatok
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Elfogadás
|
Accept | string |
Elfogadás |
|
|
Szöveg keresése
|
text | string |
Szöveg keresése |
|
|
Metaadat-elrendezés keresése
|
items.layoutId | string |
Keresés metaadat-elrendezés szerint |
|
|
Keresési sablon
|
items.templateId | string |
Keresés munkafolyamat-sablon alapján |
|
|
Keresési csoport
|
items.groupId | string |
Keresés felhasználói csoport szerint |
|
|
Felhasználó keresése
|
items.userId | string |
Keresés tulajdonos szerint |
|
|
Keresés e-mailben
|
items.email | string |
Keresés a tulajdonos e-mail-címe alapján |
|
|
Utónév keresése
|
items.firstname | string |
Keresés a tulajdonos utóneve szerint |
|
|
Vezetéknév keresése
|
items.lastname | string |
Keresés a tulajdonos vezetékneve szerint |
|
|
Keresési állapot
|
items.workflowStatus | string |
Keresés munkafolyamat-állapot szerint |
|
|
Metaadatok keresése 1
|
items.data1 | string |
Keresés a metaadatok értéke szerint 1 |
|
|
Metaadatok keresése 2
|
items.data2 | string |
Keresés a metaadatok értéke szerint 2 |
|
|
Metaadatok keresése 3
|
items.data3 | string |
Keresés a metaadatok értéke szerint 3 |
|
|
Metaadatok keresése 4
|
items.data4 | string |
Keresés a metaadatok értéke szerint 4 |
|
|
Metaadatok keresése 5
|
items.data5 | string |
Keresés a metaadatok értéke szerint 5 |
|
|
Metaadatok keresése 6
|
items.data6 | string |
Keresés a metaadatok értéke szerint 6 |
|
|
Metaadatok keresése 7
|
items.data7 | string |
Keresés a metaadatok értéke szerint 7 |
|
|
Metaadatok keresése 8
|
items.data8 | string |
Keresés a metaadatok értéke szerint 8 |
|
|
Keresés létrehozási dátuma
|
items.created | string |
Keresés létrehozási dátum szerint |
|
|
Keresési frissítés dátuma
|
items.updated | string |
Keresés a legutóbbi frissítés dátuma szerint |
|
|
Keresés kezdő dátuma
|
items.started | string |
Keresés kezdő dátum szerint |
|
|
Rendezési szempont:
|
sortBy | string |
A keresési eredmény rendezéséhez használt mező |
|
|
Rendezési sorrend
|
sortOrder | string |
A rendezés iránya |
|
|
Cikkek száma oldalanként
|
itemsPerPage | string |
A válasz oldalankénti elemeinek száma |
|
|
Lapindex
|
pageIndex | string |
A visszaadott oldal indexe |
Válaszok
- Törzs
- workflows
Lekérés
Metaadat-elrendezés létrehozása
Metaadat-elrendezés létrehozása
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Bérlőazonosító
|
tenantId | True | string |
Az elrendezés azonosítója |
|
Tartalomtípus
|
Content-Type | True | string |
Tartalom típusa |
|
Név
|
name | True | string |
Az elrendezés neve |
|
Le van tiltva
|
isDisabled | boolean |
Ha igaz értékre van állítva, az elrendezés le lesz tiltva |
|
|
rés
|
slot | string |
Metaadatelem (adat1–adat8) |
|
|
alapértelmezett
|
default | string |
Metaadatok alapértelmezett értéke ebben az elrendezésben |
|
|
optional
|
optional | boolean |
Ha igaz, az érték megadása nem kötelező |
|
|
readonly
|
readonly | boolean |
Az érték felülbírálható |
|
|
rememberLastValue
|
rememberLastValue | boolean |
Ha igaz értékre van állítva, az érték a munkafolyamatok között is megmarad |
Válaszok
Metaadatok elrendezése
- Törzs
- layout
Metaadat-elrendezések keresése
Munkafolyamat-elrendezések keresése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Szöveg keresése
|
text | string |
Szöveg keresése |
|
|
Keresés letiltva
|
items.isDisabled | string |
Letiltott elrendezések keresése |
|
|
Keresési név
|
items.name | string |
Keresés elrendezésnév szerint |
|
|
Metaadatok keresése
|
items.dataConfigurations.slot | string |
Keresés metaadatok jelenléte alapján |
|
|
Keresés létrehozási dátuma
|
items.created | string |
Keresés létrehozási dátum szerint |
|
|
Keresési frissítés dátuma
|
items.updated | string |
Keresés a legutóbbi frissítés dátuma szerint |
|
|
Rendezési szempont:
|
sortBy | string |
A keresési eredmény rendezéséhez használt mező |
|
|
Rendezési sorrend
|
sortOrder | string |
A rendezés iránya |
|
|
Cikkek száma oldalanként
|
itemsPerPage | string |
A válasz oldalankénti elemeinek száma |
|
|
Lapindex
|
pageIndex | string |
A visszaadott oldal indexe |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
items
|
items | layouts |
Metaadatok elrendezésének frissítése
Metaadat-elrendezés frissítése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Bérlőazonosító
|
layoutId | True | string |
Az elrendezés azonosítója |
|
Tartalomtípus
|
Content-Type | True | string |
Tartalom típusa |
|
Név
|
name | True | string |
Az elrendezés neve |
|
Le van tiltva
|
isDisabled | boolean |
Ha igaz értékre van állítva, az elrendezés le lesz tiltva |
|
|
rés
|
slot | string |
Metaadatelem (adat1–adat8) |
|
|
alapértelmezett
|
default | string |
Metaadatok alapértelmezett értéke ebben az elrendezésben |
|
|
optional
|
optional | boolean |
Ha igaz, az érték megadása nem kötelező |
|
|
readonly
|
readonly | boolean |
Az érték felülbírálható |
|
|
rememberLastValue
|
rememberLastValue | boolean |
Ha igaz értékre van állítva, az érték a munkafolyamatok között is megmarad |
Válaszok
Metaadatok elrendezése
- Törzs
- layout
Metaadatok elrendezésének lekérése
Munkafolyamat-elrendezés lekérése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Elrendezés azonosítója
|
layoutId | True | string |
Az elrendezés azonosítója |
Válaszok
Metaadatok elrendezése
- Törzs
- layout
Metaadatok leképezésének lekérése
A megadott bérlő metaadat-leképezésének lekérése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Bérlőazonosító
|
tenantId | True | string |
A bérlő azonosítója |
Válaszok
- Törzs
- dataMapping
Munkafolyamat-dokumentumok letöltése
A munkafolyamat dokumentumainak letöltése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Munkafolyamat-azonosító
|
workflowId | True | string |
A munkafolyamat azonosítója |
Válaszok
- response
- binary
Munkafolyamat frissítése
Munkafolyamat frissítése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Munkafolyamat-azonosító
|
workflowId | True | string |
A frissíteni kívánt munkafolyamat azonosítója |
|
Tartalomtípus
|
Content-Type | string |
Tartalomtípus |
|
|
Felhasználóazonosító
|
userId | string |
A munkafolyamat-tulajdonos azonosítója |
|
|
Név
|
name | string |
A munkafolyamat neve |
|
|
Description
|
description | string |
A munkafolyamat leírása |
|
|
azonosító
|
id | string |
lépésazonosító |
|
|
stepType
|
stepType | string |
aláírás vagy jóváhagyás |
|
|
consentPageId
|
consentPageId | True | string |
A címzetthez társított hozzájárulási oldal (aláírási szint) azonosítója |
|
e-mail
|
True | string |
címzett e-mail címe |
|
|
userId
|
userId | string |
hivatkozás lefelhasználóra ahelyett, hogy menet közben hoz létre címzettet |
|
|
telefonszám
|
phoneNumber | string |
reicpient mobiltelefonszáma |
|
|
keresztnév
|
firstName | string |
címzett utóneve |
|
|
lastName
|
lastName | string |
címzett vezetékneve |
|
|
country
|
country | string |
címzett országkódja |
|
|
preferredLocale
|
preferredLocale | string |
címzett területi kódja |
|
|
organizationId
|
organizationId | string |
A címzett LE-szervezetének azonosítója |
|
|
requiredRecipients
|
requiredRecipients | number |
azoknak az aláíróknak a minimális száma, akiknek alá kell írniuk a következő lépést |
|
|
validityPeriod
|
validityPeriod | number |
lépés érvényességi időtartama |
|
|
inviteperiod
|
inviteperiod | number |
aláírás-emlékeztetők gyakorisága |
|
|
maxInvites
|
maxInvites | number |
aláírás-emlékeztetők maximális száma |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
szabályozza az aláírt dokumentum aláíróknak történő kézbesítését |
|
|
allowComments
|
allowComments | boolean |
engedélyezi vagy tiltja a megjegyzéseket ehhez a lépéshez |
|
|
hideAttachments
|
hideAttachments | boolean |
szabályozza a mellékletek megjelenítését az aláírók számára |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
szabályozza a többi aláíró megjelenítését az aláírónak |
|
|
Értesítési események
|
notifiedEvents | array of string |
Értesítéses munkafolyamat-események |
|
|
userId
|
userId | string |
Figyelő felhasználói azonosítója |
|
|
notifiedEvents
|
notifiedEvents | array of string |
A figyelőnek értesítendő munkafolyamat-események |
|
|
e-mail
|
string |
|
||
|
Munkafolyamat állapota
|
workflowStatus | string |
A munkafolyamat aktuális állapota |
|
|
data1
|
data1 | string |
első metaadatok |
|
|
data2
|
data2 | string |
második metaadatok |
|
|
data3
|
data3 | string |
harmadik metaadatok |
|
|
data4
|
data4 | string |
negyedik metaadatok |
|
|
data5
|
data5 | string |
ötödik metaadatok |
|
|
data6
|
data6 | string |
hatodik metaadatok |
|
|
data7
|
data7 | string |
hetedik metaadatok |
|
|
data8
|
data8 | string |
heighth metaadatok |
Válaszok
- Törzs
- workflow
Munkafolyamat lekérése
Munkafolyamat lekérése munkafolyamat-azonosítóból
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Munkafolyamat-azonosító
|
workflowId | True | string |
A munkafolyamat azonosítója |
Válaszok
- Törzs
- workflow
Munkafolyamat létrehozása
Munkafolyamat létrehozása
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Felhasználóazonosító
|
userId | True | string |
A munkafolyamat-tulajdonos felhasználói azonosítója |
|
Tartalomtípus
|
Content-Type | string |
Tartalomtípus |
|
|
Név
|
name | True | string |
A munkafolyamat neve |
|
Description
|
description | string |
A munkafolyamat leírása |
|
|
azonosító
|
id | string |
lépésazonosító |
|
|
stepType
|
stepType | string |
aláírás vagy jóváhagyás |
|
|
consentPageId
|
consentPageId | True | string |
A címzetthez társított hozzájárulási oldal (aláírási szint) azonosítója |
|
e-mail
|
True | string |
címzett e-mail címe |
|
|
userId
|
userId | string |
hivatkozás lefelhasználóra ahelyett, hogy menet közben hoz létre címzettet |
|
|
telefonszám
|
phoneNumber | string |
reicpient mobiltelefonszáma |
|
|
keresztnév
|
firstName | string |
címzett utóneve |
|
|
lastName
|
lastName | string |
címzett vezetékneve |
|
|
country
|
country | string |
címzett országkódja |
|
|
preferredLocale
|
preferredLocale | string |
címzett területi kódja |
|
|
organizationId
|
organizationId | string |
A címzett LE-szervezetének azonosítója |
|
|
requiredRecipients
|
requiredRecipients | number |
azoknak az aláíróknak a minimális száma, akiknek alá kell írniuk a következő lépést |
|
|
validityPeriod
|
validityPeriod | number |
lépés érvényességi időtartama |
|
|
inviteperiod
|
inviteperiod | number |
aláírás-emlékeztetők gyakorisága |
|
|
maxInvites
|
maxInvites | number |
aláírás-emlékeztetők maximális száma |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
szabályozza az aláírt dokumentum aláíróknak történő kézbesítését |
|
|
allowComments
|
allowComments | boolean |
engedélyezi vagy tiltja a megjegyzéseket ehhez a lépéshez |
|
|
hideAttachments
|
hideAttachments | boolean |
szabályozza a mellékletek megjelenítését az aláírók számára |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
szabályozza a többi aláíró megjelenítését az aláírónak |
|
|
Értesítési események
|
notifiedEvents | array of string |
Értesítéses munkafolyamat-események |
|
|
userId
|
userId | string |
A figyelő felhasználói azonosítója |
|
|
notifiedEvents
|
notifiedEvents | array of string |
A figyelőnek értesítendő munkafolyamat-események |
|
|
e-mail
|
string |
A figyelő e-mail-címe |
||
|
Sablon azonosítója
|
templateId | string |
Annak a sablonnak az azonosítója, amelyből a munkafolyamat származik |
|
|
Elrendezés azonosítója
|
layoutId | string |
A worklow által használt metaadat-elrendezés |
|
|
data1
|
data1 | string |
Első metaadatok |
|
|
data2
|
data2 | string |
Második metaadatok |
|
|
data3
|
data3 | string |
Harmadik metaadatok |
|
|
data4
|
data4 | string |
Negyedik metaadatok |
|
|
data5
|
data5 | string |
Ötödik metaadatok |
|
|
data6
|
data6 | string |
Hatodik metaadatok |
|
|
data7
|
data7 | string |
Hetedik metaadatok |
|
|
data8
|
data8 | string |
Magassági metaadatok |
Válaszok
- Törzs
- workflow
Munkafolyamat törlése
Munkafolyamat törlése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Munkafolyamat-azonosító
|
workflowId | True | string |
A törölni kívánt munkafolyamat azonosítója |
Válaszok
- Törzs
- workflow
Névjegy frissítése
Meglévő kapcsolattartási adatok módosítása
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Kapcsolattartó azonosító
|
contactId | True | string |
A partner azonosítója |
|
Tartalomtípus
|
Content-Type | True | string |
Tartalom típusa |
|
A kapcsolattartó e-mail-címe
|
string |
A kapcsolattartó e-mail-címe |
||
|
A partner telefonszáma
|
phoneNumber | string |
A partner telefonszáma |
|
|
A partner utóneve
|
firstName | string |
A partner utóneve |
|
|
A partner vezetékneve
|
lastName | string |
A partner vezetékneve |
|
|
A kapcsolattartó országa
|
country | string |
A kapcsolattartó országa |
Válaszok
- Törzs
- contact
Névjegy törlése
Partner eltávolítása az aktuális felhasználó contects listájából
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Kapcsolattartó azonosító
|
contactId | True | string |
A partner azonosítója |
|
Tartalomtípus
|
Content-Type | True | string |
Tartalom típusa |
Válaszok
- Törzs
- contact
Partner lekérése
Kapcsolattartási adatok lekérése a partnerazonosítóból
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Kapcsolattartó azonosító
|
contactId | True | string |
A partner azonosítója |
|
Tartalomtípus
|
Content-Type | True | string |
Tartalom típusa |
Válaszok
- Törzs
- contact
Partnerek keresése
Partnerek keresése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Szöveg keresése
|
text | string |
Keresés szöveg szerint |
|
|
Keresés e-mailben
|
items.email | string |
Keresés e-mailben |
|
|
Keresés telefonszáma
|
items.phoneNumber | string |
Keresés telefonszám alapján |
|
|
Utónév keresése
|
items.fisrtName | string |
Keresés utónév alapján |
|
|
Vezetéknév keresése
|
items.lastName | string |
Keresés vezetéknév szerint |
|
|
Keresés országában
|
items.country | string |
Keresés ország szerint |
|
|
Cikkek száma oldalanként
|
itemsPerPage | number |
A válasz oldalankénti elemeinek száma |
|
|
Lapindex
|
pageIndex | number |
A visszaadott oldal indexe |
Válaszok
- Törzs
- contacts
Definíciók
consentPage
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
allowOrganization
|
allowOrganization | boolean |
Lehetővé teszi a szervezetek használatát |
|
authenticateUser
|
authenticateUser | boolean |
Aláíró hitelesítésének előírása |
|
clientId
|
clientId | string |
Ügyfélazonosító |
|
Létrehozott
|
created | number |
Létrehozás dátuma |
|
emUrl
|
emUrl | string |
A Evidences Manager URL-címe |
|
hideDownloads
|
hideDownloads | boolean |
A dokumentumok letöltési hivatkozásai nem jelennek meg a hozzájárulási oldalakon |
|
hideMobileQrCode
|
hideMobileQrCode | boolean |
Elrejti a QR-kódokat a konstans oldalakon |
|
azonosító
|
id | string |
A hozzájárulási oldal azonosítója |
|
isCountryRequired
|
isCountryRequired | boolean |
Az ország kötelezővé teszi az aláírók adatait |
|
isDisabled
|
isDisabled | boolean |
A Hozzájárulás lap le van tiltva |
|
logoResourceId
|
logoResourceId | string |
A hozzájárulási lap embléma-erőforrásának azonosítója |
|
név
|
name | string |
A hozzájárulási oldal neve |
|
primaryColor
|
primaryColor | string |
Hozzájárulási oldal elsődleges színe |
|
secondaryColor
|
secondaryColor | string |
Hozzájárulási oldal másodlagos színe |
|
sharedPassphrase
|
sharedPassphrase | string |
Megosztott jelszó |
|
aláírási mód
|
signing mode | string |
Aláírási mód (helyi vagy kiszolgáló) |
|
stepType
|
stepType | string |
lépés típusa (aláírás vagy jóváhagyás) |
|
tenantId
|
tenantId | string |
Bérlőazonosító |
|
tsaUrl
|
tsaUrl | string |
Időbélyeg-szolgáltató URL-címe |
|
frissül
|
updated | number |
Utolsó módosítás dátuma |
|
verifyEmail
|
verifyEmail | boolean |
Ha tue értékre van állítva, az aláírók e-mailben kapják meg az OTP-ket |
|
verifyPhoneNumber
|
verifyPhoneNumber | boolean |
Ha igaz értékre van állítva, az aláírók szöveges üzenetben kapják meg az OTP-ket |
consentPages
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
items
|
items | array of consentPage |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
összesElemek
|
totalItems | integer |
összesElemek |
kapcsolatfelvétel
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
country
|
country | string |
Kapcsolattartási ország |
|
Létrehozott
|
created | integer |
Partnerlétrehozási dátum |
|
e-mail
|
string |
Kapcsolattartási e-mail-cím |
|
|
keresztnév
|
firstName | string |
Kapcsolattartó firstName |
|
azonosító
|
id | string |
Kapcsolattartó azonosítója |
|
lastName
|
lastName | string |
Kapcsolattartó vezetékneve |
|
név
|
name | string |
Partner neve (utónév + vezetéknév)) |
|
telefonszám
|
phoneNumber | string |
Kapcsolattartó telefonszáma |
|
tenantId
|
tenantId | string |
Bérlőazonosító |
|
frissül
|
updated | integer |
Kapcsolatfelvétel az utolsó módosítás dátumával |
|
userId
|
userId | string |
A partner tulajdonosának azonosítója |
kapcsolattartók
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
items
|
items | array of contact |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
összesElemek
|
totalItems | integer |
összesElemek |
dataMapping
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
leírás
|
data1.description | string |
Metaadatok leírása |
|
név
|
data1.name | string |
Metaadatok neve |
|
minta
|
data1.pattern | string |
Metaadat-minta |
|
options
|
data1.options | array of object |
options |
|
value
|
data1.options.value | string |
Metaadatok értéke |
|
típus
|
data1.type | string |
típus |
|
leírás
|
data2.description | string |
Metaadatok leírása |
|
név
|
data2.name | string |
Metaadatok neve |
|
minta
|
data2.pattern | string |
Metaadat-minta |
|
options
|
data2.options | array of object |
options |
|
value
|
data2.options.value | string |
Metaadatok értéke |
|
típus
|
data2.type | string |
típus |
|
leírás
|
data3.description | string |
Metaadatok leírása |
|
név
|
data3.name | string |
Metaadatok neve |
|
minta
|
data3.pattern | string |
Metaadat-minta |
|
options
|
data3.options | array of object |
options |
|
value
|
data3.options.value | string |
Metaadatok értéke |
|
típus
|
data3.type | string |
típus |
|
leírás
|
data4.description | string |
Metaadatok leírása |
|
név
|
data4.name | string |
Metaadatok neve |
|
minta
|
data4.pattern | string |
Metaadat-minta |
|
options
|
data4.options | array of object |
options |
|
value
|
data4.options.value | string |
Metaadatok értéke |
|
típus
|
data4.type | string |
típus |
|
leírás
|
data5.description | string |
Metaadatok leírása |
|
név
|
data5.name | string |
Metaadatok neve |
|
minta
|
data5.pattern | string |
Metaadat-minta |
|
options
|
data5.options | array of object |
options |
|
value
|
data5.options.value | string |
Metaadatok értéke |
|
típus
|
data5.type | string |
típus |
|
leírás
|
data6.description | string |
Metaadatok leírása |
|
név
|
data6.name | string |
Metaadatok neve |
|
minta
|
data6.pattern | string |
Metaadat-minta |
|
options
|
data6.options | array of object |
options |
|
value
|
data6.options.value | string |
Metaadatok értéke |
|
típus
|
data6.type | string |
típus |
|
leírás
|
data7.description | string |
Metaadatok leírása |
|
név
|
data7.name | string |
Metaadatok neve |
|
minta
|
data7.pattern | string |
Metaadat-minta |
|
options
|
data7.options | array of object |
options |
|
value
|
data7.options.value | string |
Metaadatérték |
|
típus
|
data7.type | string |
típus |
|
leírás
|
data8.description | string |
Metaadatok leírása |
|
név
|
data8.name | string |
Metaadatok neve |
|
minta
|
data8.pattern | string |
Metaadat-minta |
|
options
|
data8.options | array of object |
options |
|
value
|
data8.options.value | string |
Metaadatok értéke |
|
típus
|
data8.type | string |
típus |
dokumentum
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Létrehozott
|
created | integer |
Létrehozás dátuma |
|
groupId
|
groupId | string |
A dokumentum tulajdonoscsoportjának azonosítója |
|
azonosító
|
id | string |
A dokumentum azonosítója |
|
Részek
|
parts | array of part |
Részek |
|
pdfSignatureFields
|
pdfSignatureFields | array of pdfSigField |
pdfSignatureFields |
|
signatureProfileId
|
signatureProfileId | string |
A dokumentum aláírási profiljának azonosítója |
|
tenantId
|
tenantId | string |
Bérlőazonosító |
|
frissül
|
updated | integer |
Utolsó módosítás dátuma |
|
userId
|
userId | string |
Dokumentumtulajdonos felhasználói azonosítója |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
A dokumentum megtekintésére jogosult csoportok listája |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
A dokumentum megtekintését engedélyező felhasználók listája |
|
workflowId
|
workflowId | string |
Annak a munkafolyamatnak az azonosítója, amelyhez a dokumentum tartozik |
|
workflowName
|
workflowName | string |
Annak a munkafolyamatnak a neve, amelyhez a dokumentum tartozik |
Dokumentumok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
items
|
items | array of document |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
összesElemek
|
totalItems | integer |
összesElemek |
elrendezés
Metaadatok elrendezése
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Létrehozott
|
created | number |
Létrehozás dátuma |
|
azonosító
|
id | string |
Elrendezés azonosítója |
|
isDisabled
|
isDisabled | boolean |
Ha igaz értékre van állítva, az elrendezés fel lett bontva |
|
név
|
name | string |
Az elrendezés neve |
|
tenantId
|
tenantId | string |
A bérlő azonosítója |
|
frissül
|
updated | number |
Utolsó módosítás dátuma |
|
dataConfigurations
|
dataConfigurations | array of object | |
|
rés
|
dataConfigurations.slot | string |
Metaadatelem (adat1–adat8) |
|
alapértelmezett
|
dataConfigurations.default | string |
Metaadatok alapértelmezett értéke ebben az elrendezésben |
|
optional
|
dataConfigurations.optional | boolean |
Ha igaz, a metaadatok értékének megadása nem kötelező |
|
readonly
|
dataConfigurations.readonly | boolean |
Az érték felülbírálható |
|
rememberLastValue
|
dataConfigurations.rememberLastValue | boolean |
Ha igaz értékre van állítva, az érték a munkafolyamatok között is megmarad |
Elrendezések
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
items
|
items | array of object | |
|
Létrehozott
|
items.created | number |
Létrehozás dátuma |
|
dataConfigurations
|
items.dataConfigurations | array of layout | |
|
itemsPerPage
|
itemsPerPage | number |
Elemek száma oldalanként |
|
pageIndex
|
pageIndex | number |
A visszaadott oldal indexe |
|
összesElemek
|
totalItems | number |
A kérelem által érintett elemek teljes száma |
part
Dokumentumrész
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
tartalomtípus
|
contentType | string |
tartalomtípus |
|
filename
|
filename | string |
filename |
|
kivonat
|
hash | string |
kivonat |
|
size
|
size | integer |
size |
pdfSigField
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
imagePage
|
imagePage | float |
imagePage |
|
imageWidth
|
imageWidth | float |
imageWidth |
|
imageX
|
imageX | float |
imageX |
|
imageY
|
imageY | float |
imageY |
signatureProfile
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Létrehozott
|
created | number |
Létrehozás dátuma |
|
documentType
|
documentType | string |
A dokumentumok típusa |
|
forceScrollDocument
|
forceScrollDocument | boolean |
Az aláíró kényszerítése a dokumentum aljára görgetéshez |
|
azonosító
|
id | string |
az aláírási profil azonosítója |
|
isDefault
|
isDefault | boolean |
Ez az aláírási profil lesz az alapértelmezett |
|
isDisabled
|
isDisabled | boolean |
Az aláírási profil letiltása |
|
név
|
name | string |
Az aláírási profil neve |
|
pdfSignatureImageText
|
pdfSignatureImageText | string |
Aláíráspárnákban megjelenő szöveg |
|
pdfSignatureImageTextColor
|
pdfSignatureImageTextColor | string |
A szöveg színe a színösszefűzési párnákban |
|
pdfSignatureImageTextSize
|
pdfSignatureImageTextSize | number |
Az ingatures párnákban megjelenő szöveg mérete |
|
pdfVisibleSignatureMode
|
pdfVisibleSignatureMode | string |
Látható aláírási mód (engedélyezett, letiltva, noImage) |
|
Aláírás típusa
|
signatureType | string |
pades, xades, xadesDetached, xadesDetachedManifest, cades, helios |
|
tenantId
|
tenantId | string |
Bérlőazonosító |
|
frissül
|
updated | number |
Utolsó módosítás dátuma |
signatureProfiles
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
items
|
items | array of signatureProfile | |
|
itemsPerPage
|
itemsPerPage | number |
Elemek száma oldalanként |
|
pageIndex
|
pageIndex | number |
A visszaadott oldal indexe |
|
összesElemek
|
totalItems | number |
A kérelem által érintett elemek teljes száma |
felhasználó
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
approveAllowed
|
approveAllowed | boolean |
Ha igaz értékre van állítva, a felhasználó jóváhagyhatja a dokumentumokat |
|
country
|
country | string |
A felhasználó országa |
|
Létrehozott
|
created | integer |
Létrehozás dátuma |
|
e-mail
|
string |
Felhasználó e-mail-címe |
|
|
keresztnév
|
firstName | string |
A felhasználó utóneve |
|
groupId
|
groupId | string |
A felhasználó csoportjának azonosítója |
|
azonosító
|
id | string |
A felhasználó azonosítója |
|
isDisabled
|
isDisabled | boolean |
Ha igaz, a felhasználó le van tiltva |
|
lastLogin
|
lastLogin | integer |
A felhasználó utolsó bejelentkezési dátuma |
|
lastName
|
lastName | string |
A felhasználó vezetékneve |
|
név
|
name | string |
A felhasználó neve (utónév + vezetéknév) |
|
organizationTitles
|
organizationTitles | array of |
A felhasználó szórakozásai a szervezeteiben |
|
telefonszám
|
phoneNumber | string |
A felhasználó telefonszáma |
|
signAllowed
|
signAllowed | boolean |
Ha igaz értékre van állítva, a felhasználó aláírhatja a dokumentumokat |
|
tárgy
|
subject | string |
A felhasználó belső alhálózati kódja |
|
tenantId
|
tenantId | string |
A bérlő azonosítója |
|
frissül
|
updated | integer |
Utolsó módosítás dátuma |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Azon csoport listája, amelyben a felhasználó megfigyelőként működhet |
munkafolyamat
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Létrehozott
|
created | integer |
Létrehozott |
|
currentRecipientEmails
|
currentRecipientEmails | array of |
currentRecipientEmails |
|
currentRecipientUsers
|
currentRecipientUsers | array of |
currentRecipientUsers |
|
data1
|
data1 | string |
Metaadatok 1 |
|
data2
|
data2 | string |
Metaadatok 2 |
|
data3
|
data3 | string |
Metaadatok 3 |
|
data4
|
data4 | string |
Metaadatok 4 |
|
data5
|
data5 | string |
Metaadatok 5 |
|
data6
|
data6 | string |
Metaadatok 6 |
|
data7
|
data7 | string |
Metaadatok 7 |
|
data8
|
data8 | string |
Metaadatok 8 |
|
leírás
|
description | string |
A munkafolyamat leírása |
|
e-mail
|
string |
A munkafolyamat-tulajdonos e-mail-címe |
|
|
keresztnév
|
firstName | string |
A munkafolyamat-tulajdonos utóneve |
|
groupId
|
groupId | string |
A munkafolyamat-tulajdonoscsoport azonosítója |
|
azonosító
|
id | string |
A munkafolyamat azonosítója |
|
lastName
|
lastName | string |
A munkafolyamat-tulajdonos vezetékneve |
|
layoutId
|
layoutId | string |
A munkafolyamat metaadat-elrendezésének azonosítója |
|
naplók
|
logs | array of |
Naplózza a wokflow elemeit |
|
név
|
name | string |
A munkafolyamat-tulajdonos neve (utónév + vezetéknév) |
|
notifiedEvents
|
notifiedEvents | array of string |
A munkafolyamat által értesített események listája |
|
haladás
|
progress | integer |
A munkafolyamat előrehaladása százalékban |
|
steps
|
steps | array of object |
steps |
|
allowComments
|
steps.allowComments | boolean |
Engedélyezi/tiltja az interaktív megjegyzések ara engedélyezett a lépés |
|
hideAttachments
|
steps.hideAttachments | boolean |
A mellékletek aláírók számára történő megjelenítésének szabályozása |
|
hideWorkflowRecipients
|
steps.hideWorkflowRecipients | boolean |
A többi aláíró megjelenítésének szabályozása az aláíró számára |
|
azonosító
|
steps.id | string |
Lépésazonosító |
|
invitePeriod
|
steps.invitePeriod | integer |
invitePeriod |
|
isFinished
|
steps.isFinished | boolean |
isFinished |
|
elindítva
|
steps.isStarted | boolean |
elindítva |
|
naplók
|
steps.logs | array of |
naplók |
|
maxInvites
|
steps.maxInvites | integer |
maxInvites |
|
recipients
|
steps.recipients | array of object |
recipients |
|
consentPageId
|
steps.recipients.consentPageId | string |
consentPageId |
|
country
|
steps.recipients.country | string |
country |
|
e-mail
|
steps.recipients.email | string |
|
|
keresztnév
|
steps.recipients.firstName | string |
keresztnév |
|
lastName
|
steps.recipients.lastName | string |
lastName |
|
telefonszám
|
steps.recipients.phoneNumber | string |
telefonszám |
|
userId
|
steps.recipients.userId | string |
userId |
|
requiredRecipients
|
steps.requiredRecipients | integer |
requiredRecipients |
|
sendDownloadLink
|
steps.sendDownloadLink | boolean |
sendDownloadLink |
|
stepType
|
steps.stepType | string |
stepType |
|
validityPeriod
|
steps.validityPeriod | integer |
validityPeriod |
|
tenantId
|
tenantId | string |
tenantId |
|
frissül
|
updated | integer |
frissül |
|
userId
|
userId | string |
userId |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Azon csoportok listája, amelyekben a felhasználók megfigyelőként működhetnek |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
viewAuthorizedUsers |
|
watchers
|
watchers | array of object |
watchers |
|
e-mail
|
watchers.email | string |
|
|
notifiedEvents
|
watchers.notifiedEvents | array of string |
notifiedEvents |
|
userId
|
watchers.userId | string |
userId |
|
workflowStatus
|
workflowStatus | string |
workflowStatus |
workflows
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
items
|
items | array of workflow |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
összesElemek
|
totalItems | integer |
összesElemek |
bináris
Ez a bináris alapszintű adattípus.