Lex Power Sign (Önizleme)
Lex Persona, bir dizi elektronik imza çözümü sunan bir Avrupa nitelikli güven hizmetleri sağlayıcısıdır. Lex Enterprise ile tüm eIDAS imza düzeylerine ve çok sayıda imzalayan kimlik doğrulama yöntemine erişebilirsiniz. İmza kitaplarınız dijital iş akışlarına eklenir. Yinelenen görevleri ortadan kaldırmak, verimlilik kazanmak ve işinizi hızlandırmak için Lex Enterprise ile tüm araçlarınız arasındaki bağlantıları otomatikleştirin.
Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:
| Hizmet | Class | Bölgeler |
|---|---|---|
| Copilot Studio | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Logic Apps | Standart | Aşağıdakiler dışında tüm Logic Apps bölgeleri : - Azure Kamu bölgeleri - Azure Çin bölgeleri - ABD Savunma Bakanlığı (DoD) |
| Power Apps | Premium | Aşağıdakiler dışında tüm Power Apps bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Power Automate | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| İletişim | |
|---|---|
| İsim | Lex Persona desteği |
| URL | https://support.lex-persona.com |
| E-posta | support@lex-persona.com |
| Bağlayıcı Meta Verileri | |
|---|---|
| Publisher | Lex Kişisi |
| Web sitesi | https://www.lex-persona.com |
| Gizlilik ilkesi | https://www.lex-persona.com/politique-de-confidentialite/ |
| Kategoriler | AI; Web sitesi |
Lex Persona, bir dizi elektronik imza çözümü sunan bir Avrupa nitelikli güven hizmetleri sağlayıcısıdır. Bu bağlayıcı ile Microsoft tabanlı uygulamanıza (PowerApp, .NET tabanlı web uygulaması, Dynamics...) ve ortama (Outlook, Sharepoint, Teams...) elektronik imza özelliğini kolayca ekleyebilirsiniz. Bağlayıcı, Lex Enterprise İş Akışı yöneticimiz tarafından desteklenmektedir. Sıralı ve/veya paralel olarak yürütülebilen farklı adım türlerinden oluşan elektronc imza iş akışları oluşturabilirsiniz. Bağlayıcı tüm eIDAS imza düzeylerini destekler ve çok çeşitli imzalayan kimlik doğrulama yöntemleri sunar (OTP, SSO, France Connect, Identité Numérique La Poste, donanım belirteçleri...)
Önkoşullar
Devam etmek için aşağıdakilere sahip olmanız gerekir:
- Lex Enterprise aboneliği. Test etmek için deneme planını kullanma
Ortam gereksinimleri şunlardır:
- Özel bağlayıcı özelliğine sahip bir Microsoft Power Apps veya Power Automate planı
- Power platform CLI araçları
Kimlik bilgilerini alma
Bir Lex Enteprise aboneliği veya deneme sistemlerimizde bir hesap almak için adresinden satış temsilcilerimizle commercial@lex-persona.com iletişime geçin.
Hesabınızla Lex Enterprise portalına bağlanın ve bir API Anahtarı oluşturun.
Bağlayıcınızı kullanmaya başlama
İlk olarak bağlayıcı için bir bağlantı oluşturun. Kimlik doğrulama yöntemini API anahtarı olarak ayarlayın, API anahtarınızı ("Taşıyıcı act_XXXXXXX") sağlayın ve API anahtarının API çağrılarının Autrorization üst bilgisine yerleştirilmesi gerektiğini belirtin.
Basit bir imza iş akışı oluşturma adımları şunlardır:
- tigger'ınızdan hemen sonra, Beni Al eylemiyle bağlı Lex Enterprise kullanıcı kimliğini (iş akışı oluşturmak için bu kimlik gereklidir) alın
- Arama onayı sayfaları action_ arama onayı sayfaları. Onay sayfalarını ada göre aramak için metin parametresini kullanabilirsiniz (onay sayfaları imza düzeyini tanımlar ve Lex Kurumsal ortamınızda önceden yapılandırılmıştır)
- İş akışı oluştur eylemiyle bir imza iş akışı oluşturun . Bu adımda, imzalayanların bilgilerini sağlamanız gerekir.
- İmza profillerini ara eylemiyle imza profillerini arayın. İmza profillerini ada göre aramak için metin parametresini kullanabilirsiniz (imza profilleri onay sayfaları davranışının bazı yönlerini denetler. örneğin imzalamadan önce imzalayanı belgenin en altına kaydırmaya zorlayın)
- Ortamınızdan belge alma (Sharepoint, Outlook, OneDrive...)
- createDocument parametresini true olarak ayarlayarak Parça oluştur eylemiyle belgeyi iş akışına ekleyin
- İş akışını Güncelleştir iş akışı eylemiyle başlatın ve İş Akışı Durumu'nubaşlatıldı olarak ayarlayın
Lütfen unutmayın: Bağlayıcı varsayılan olarak deneme sunucumuzla eşleştirilir. Bağlayıcıyı kendi kiracınızla eşleştirmek istiyorsanız, bağlayıcının güvenlik tanımında veya apiDefinitions.json dosyasında konak URL'sini değiştirmeniz gerekir:
- "host": "yourtenant.lexpersona.com",
Sorunları ve sınırlamaları bilme
Belge oluştur eylemi, yükündeki belge bölümlerinin listesini kabul eder. Ancak, birden çok parça sağlarsanız yalnızca ilk bölüm dikkate alınır (bunun nedeni API'mizdeki bir hatadır. Bağlayıcı sonraki sürümde düzeltilecektir).
Sonuç olarak, bir iş akışına birden çok belge eklemek istiyorsanız, her belge için createDocument parametresi true olarak ayarlanmış bir Parça oluştur çağrısı yapmanız gerekir.
Yaygın hatalar ve çözümler
API çağrısı hatası durumunda, API çağrısı yanıtı bağlayıcının çalıştırma geçmişinde görüntülenen kapsamlı bir hata iletisi içerir. İleti ayrıca bir günlük kimliği içerir, böylece hata hakkında daha fazla bilgiye ihtiyacınız olursa Lex Enteprise portalına bağlanabilir ve sunucu günlük dosyasına bakabilirsiniz. Alternativley, sunucu günlüklerimizi aramak için bir Postman isteği ayarlayabilirsiniz (plase belgelere bakın: https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html#search-logs).
API'miz tarafından döndürülen daha yaygın HTTP hata kodları şunlardır:
- Hata 400 - Hatalı istek. İstek paylodunuzda bir sorun var. Hatanın nedeni hakkında bilgi bulmak için günlüğe başvurun
- Hata 401 - Yetkisiz. Bu işlemi gerçekleştirmek için erişim haklarına sahip değil. Lex Persona kullanıcı erişim haklarınızı denetleyin
- Hata 403 - Yasak. API anahtarınız geçersiz veya devre dışı
- Hata 404 - Bulunamadı. İstek Url'nizde bir hata var
Ayrıca her API çağrısı olası hata kodlarıyla ilgili daha fazla bilgi için belgelerimizi de inceleyebilirsiniz (https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html)
FAQ
Bağlayıcı tarafından desteklenen belge biçimleri nelerdir?
İmza için gönderebileceğiniz belgelerde pdf, docx, pptx ve xlsx biçimleri bulunabilir. Bağlayıcı gerekirse belgeleri pdf'ye dönüştürür ve imzalar PAdES biçimine sahip olur.
XML belgelerini imzalamak da mümkündür. Bu durumda, hiçbir dönüştürme uygulanmaz ve imzalar XAdES biçimine sahip olur.
Zip dosyalarını karşıya yüklemek de mümkündür. Bağlayıcı arşivi açar ve her belgeyi iş akışına ekler.
İmza iş akışlarına ek de ekleyebilirsiniz. Ek imzalı değil ve herhangi bir biçime sahip olabilir.
Belgenin birden çok imzalayanı olabilir mi?
Evet. Belgeyi imzalayanların sayısı sınırsızdır.
Aynı anda birden çok belge imzalamak mümkündür
Evet. Bir iş akışına birden çok belge ekleyebilirsiniz ve tüm belgeler aynı anda imzalanır. Ancak, bu durumda belge kümesinin geçersiz olarak bağlanacağını ve sistemin benzersiz bir kanıt dosyası oluşturacağını unutmayın.
Aynı imzayı atan mutlpiple workglows da oluşturabilirsiniz. İmza zamanında belge listesi imzalayana sunulur ve imzalayan, imzalamak için hevesle istediği belgeleri seçme fırsatına sahip olur. Bu durumda, belgeler birbirinden bağımsız olacak, ans her belge için bir kanıt dosyası oluşturulacaktır.
Belgeyi çevrimdışı olarak imzalamak mümkündür
Hayır. Onay sayfalarına erişmek için bir intenet bağlantısı gereklidir.
İmzalayanlara otomatik imza remider'leri göndermek mümkündür
Evet. Anımsatıcı süresini ve gönderilecek en fazla anımsatıcı sayısını yapılandırabilirsiniz.
Önceden başlatılan bir imza iş akışını değiştirmek mümkündür
Evet. Herhangi bir imzadan önce iş akışındaki her şeyi değiştirebilirsiniz. İlk imzadan sonra, belgeleri değiştirmek mümkün değildir, ancak iş akışı adımlarını yine de değiştirebilirsiniz.
Tek Seferlik Parolaların geçerlilik süresi nedir?
Tek Seferlik Parolaların geçerlilik süresi iki dakikadır (onay sayfalarında bir sayı görüntülenir).
Elektronik imza geçerliliğini doğrulamak mümkündür
Pdf belgesinde yer alan imzaların geçerliliğini denetlemek için Adobe Acrobat'ın İmzalar bölmesini kullanabilirsiniz. Alternatif olarak, güvenilir imza doğrulama web hizmetihttps://ec.europa.eu/digital-building-blocks/DSS/webapp-demo/validation (örneğin) kullanabilirsiniz
Lex Persona belge depolama koşulları nelerdir?
Varsayılan olarak, belgeleri sunucularımızda ans kanıt dosyalarını saklarız. Tou, belgeleri istediğiniz zaman arayabilir ve indirebilir. İstenirse, belgelerinizi sunucularımızdan özel olarak silebiliriz.
Lex Persona zaman damgaları belirteçlerini saklar mı?
Hayır. Zaman damgaları belirteçlerini saklamayız. Gerekirse, imzalı belgelerden bu belirteçleri fazladan ekleyebilirsiniz.
İmzalı bir belge için para çekme süresi var mı?
Evet. Cayma hakkı, belge için geçerli olan yasal koşullara bağlıdır.
İmza iş akışını iptal etmek mümkündür
Evet. Yazar kullanıcı, başlatılan imza iş akışını istediği zaman iptal edebilir. Hiçbir değerlendirme dosyası üretilmeyecek ve belge bir veya birden çok imzalayan tarafından zaten imzalanmışsa, sgnatures geçersiz kılınır.
Bağlantı oluşturma
Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:
| Varsayılan | Bağlantı oluşturmak için parametreler. | Tüm bölgeler | Paylaşılamaz |
Temerrüt
Geçerli: Tüm bölgeler
Bağlantı oluşturmak için parametreler.
Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.
| İsim | Türü | Description | Gerekli |
|---|---|---|---|
| API Anahtarı | securestring | Bu API için API Anahtarı | Doğru |
Azaltma Sınırları
| Name | Çağrılar | Yenileme Dönemi |
|---|---|---|
| Bağlantı başına API çağrıları | 100 | 60 saniye |
Eylemler
| Arama onayı sayfaları |
Arama onayı sayfaları |
| Belge oluşturma |
Önceden oluşturulmuş bölümlerden belge oluşturma |
| Belgelerde arama |
Belgelerde arama |
| Belgeyi alma |
Belge alma |
| Belgeyi güncelleştirme |
Bir belgeyi güncelleştirme |
| Belgeyi sil |
Belgeyi silme |
| Beni al |
Bağlı kullanıcı kimliğini alma |
| Birleştirilmiş sayfa URL'sini alma |
Alıcı için onay sayfası URL'sini oluşturma ve alma |
| İlgili kişi oluştur |
Geçerli kullanıcının kişi listesine kişi ekleme |
| İmza profili oluşturma |
İmza profili oluşturma |
| İmza profilini alma |
İmza profili alma |
| İmza profilini güncelleştirme |
İmza profilini güncelleştirme |
| İmza profillerini ara |
İmza profillerini ara |
| İş akışlarını arama |
İş akışlarını arama |
| İş akışı belgelerini indirme |
İş akışı belgelerini indirme |
| İş akışı oluşturma |
İş akışı oluşturma |
| İş akışını alma |
İş akışı kimliğinden iş akışı alma |
| İş akışını güncelleştirme |
İş akışını güncelleştirme |
| İş akışını silme |
İş akışını silme |
| Kanıt dosyasını indirme |
İş akışı kanıt dosyasını indirme |
| Kişi arama |
Kişi arama |
| Kişiyi alma |
Kişi kimliğinden kişi bilgilerini alma |
| Kişiyi güncelleştirme |
Mevcut kişi bilgilerini değiştirme |
| Kişiyi silme |
Geçerli kullanıcının contects listesinden kişiyi kaldırma |
| Meta veri düzeni oluşturma |
Meta veri düzeni oluşturma |
| Meta veri düzenini alma |
İş akışı düzeni alma |
| Meta veri düzenini güncelleştirme |
Meta veri düzenini güncelleştirme |
| Meta veri düzenlerinde arama |
İş akışı düzenlerinde arama |
| Meta veri eşlemesini alma |
Belirtilen kiracının meta veri eşlemesini alma |
| Onay alma sayfası |
Onay sayfası kimliğinden onay sayfası bilgilerini alma |
| Parça oluşturma |
Belge bölümü oluşturma |
Arama onayı sayfaları
Arama onayı sayfaları
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Arama metni
|
text | string |
Arama metni |
|
|
Varsayılan arama
|
items.isDefault | string |
Varsayılan onay sayfasını ara |
|
|
Arama devre dışı bırakıldı
|
items.isDisabled | string |
Devre dışı bırakılmış onay sayfalarını arama |
|
|
Arama adı
|
items.name | string |
Onay sayfa adına göre arama |
|
|
Arama adımı türü
|
items.stepType | string |
Adım türüne göre arama |
|
|
İstemci kimliğini ara
|
items.clientId | string |
İstemci kimliğine göre arama |
|
|
Arama oluşturma tarihi
|
items.created | string |
Oluşturma tarihine göre arama |
|
|
Güncelleştirme tarihini ara
|
items.updated | string |
Son güncelleştirme tarihine göre arama |
|
|
Sıralama ölçütü
|
sortBy | string |
Arama sonucunun sıralandığı alan |
|
|
Sıralama düzeni
|
sortOrder | string |
Sıralamanın yönü |
|
|
Sayfa başına öğe sayısı
|
itemsPerPage | string |
Yanıttaki sayfa başına öğe sayısı |
|
|
Sayfa dizini
|
pageIndex | string |
Döndürülen sayfanın dizini |
Döndürülenler
- Body
- consentPages
Belge oluşturma
Önceden oluşturulmuş bölümlerden belge oluşturma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İş Akışı Kimliği
|
workflowId | True | string |
İlgili iş akışının kimliği |
|
İçerik türü
|
Content-Type | True | string |
İçerik Türü |
|
içerik türü
|
contentType | string |
içerik türü |
|
|
filename
|
filename | string |
filename |
|
|
Karma
|
hash | string |
Karma |
|
|
size
|
size | integer |
size |
|
|
signatureProfileId
|
signatureProfileId | string |
Bu belgenin imza profili |
Döndürülenler
- Body
- document
Belgelerde arama
Belgelerde arama
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Arama metni
|
text | string |
Arama metni |
|
|
Arama meta veri düzeni
|
items.layoutId | string |
Meta veri düzenine göre arama |
|
|
Arama grubu
|
items.groupId | string |
Kullanıcılar grubuna göre arama |
|
|
Kullanıcı ara
|
items.userId | string |
Sahibine göre arama |
|
|
Arama iş akışı kimliği
|
items.workflowId | string |
İş akışı kimliğine göre arama |
|
|
arama iş akışı adı
|
items.workflowName | string |
İş akışı adına göre arama |
|
|
Arama meta verileri 1
|
items.data1 | string |
Meta veri değerine göre arama 1 |
|
|
Arama meta verileri 2
|
items.data2 | string |
Meta veri değerine göre arama 2 |
|
|
Arama meta verileri 3
|
items.data3 | string |
Meta veri değerine göre arama 3 |
|
|
Arama meta verileri 4
|
items.data4 | string |
Meta veri değerine göre arama 4 |
|
|
Arama meta verileri 5
|
items.data5 | string |
Meta veri değerine göre arama 5 |
|
|
Arama meta verileri 6
|
items.data6 | string |
Meta veri değerine göre arama 6 |
|
|
Arama meta verileri 7
|
items.data7 | string |
Meta veri değerine göre arama 7 |
|
|
Arama meta verileri 8
|
items.data8 | string |
Meta veri değerine göre arama 8 |
|
|
arama imzası profili
|
items.signatureProfileId | string |
İmza profiline göre arama |
|
|
Arama oluşturma tarihi
|
items.created | string |
Oluşturma tarihine göre arama |
|
|
Güncelleştirme tarihini ara
|
items.updated | string |
Son güncelleştirme tarihine göre arama |
|
|
Sıralama ölçütü
|
sortBy | string |
Arama sonucunu sıralamak için kullanılan alan |
|
|
Sıralama düzeni
|
sortOrder | string |
Sıralamanın yönü |
|
|
Sayfa başına öğe sayısı
|
itemsPerPage | string |
Yanıttaki sayfa başına öğe sayısı |
|
|
Sayfa dizini
|
pageIndex | string |
Döndürülen sayfanın dizini |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
items
|
items | documents |
Belgeyi alma
Belge alma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Belge Kimliği
|
documentId | True | string |
Belgenin kimliği |
Döndürülenler
- Body
- document
Belgeyi güncelleştirme
Bir belgeyi güncelleştirme
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Belge Kimliği
|
documentId | True | string |
Belgenin kimliği |
|
İçerik türü
|
Content-Type | True | string |
İçerik Türü |
|
signatureProfileId
|
signatureProfileId | string |
Bu belgeye eklenecek imza profili |
|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
|
imagePage
|
imagePage | float |
imagePage |
|
|
imageWidth
|
imageWidth | float |
imageWidth |
|
|
imageX
|
imageX | float |
imageX |
|
|
imageY
|
imageY | float |
imageY |
Döndürülenler
- Body
- document
Belgeyi sil
Belgeyi silme
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Belge Kimliği
|
documentId | True | string |
Belgenin kimliği |
Döndürülenler
- Body
- document
Beni al
Birleştirilmiş sayfa URL'sini alma
Alıcı için onay sayfası URL'sini oluşturma ve alma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İş Akışı Kimliği
|
workflowId | True | string |
İş akışının kimliği |
|
Alıcı E-postası
|
recipientEmail | string |
İlgili alıcının e-postası |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
İlgili alıcı için onay sayfası URL'si
|
inviteUrl | string |
İlgili alıcı için onay sayfası URL'si |
İlgili kişi oluştur
Geçerli kullanıcının kişi listesine kişi ekleme
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kullanıcı Kimliği
|
userId | True | string |
Kişinin ait olduğu kullanıcı |
|
İçerik türü
|
Content-Type | True | string |
İçerik Türü |
|
İlgili kişinin e-posta adresi
|
True | string |
İlgili kişinin e-posta adresi |
|
|
Telefon Numarasını Contatct
|
phoneNumber | string |
telefon numarası |
|
|
kişi adı
|
firstName | True | string |
ön ad |
|
İlgili Kişi Soyadı
|
lastName | True | string |
soyadı |
|
İlgili ülke
|
country | string |
country |
Döndürülenler
- Body
- contact
İmza profili oluşturma
İmza profili oluşturma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kiracı Kimliği
|
tenantId | True | string |
Kiracının kimliği |
|
İçerik türü
|
Content-Type | True | string |
İçerik Türü |
|
Varsayılandır
|
isDefault | True | string |
Bu imza profilini varsayılan profil yapar |
|
Devre Dışı
|
isDisabled | string |
Bu imza profilini devre dışı bırak |
|
|
İsim
|
name | True | string |
İmza profili adı |
|
Belge Türü
|
documentType | True | string |
pdf, xml, word, excel, powerpoint, diğer |
|
İmza türü
|
signatureType | True | string |
pades,xades,xadesDetached,xadesDetachedManifest,cades,helios |
|
Belgenin en altına doğru kaydırmaya zorlama
|
forceScrollDocument | True | boolean |
İmzalayanı belgenin en altına kaydırmaya zorlama |
|
Görünür imza modu
|
pdfVisibleSignatureMode | string |
Görünür imza modu (izin verildi, devre dışı, noImage) |
|
|
İmza metni
|
pdfSignatureImageText | string |
İmza bölmelerinde görüntülenen metin |
|
|
İmza metin rengi
|
pdfSignatureImageTextColor | string |
Singatures pad'lerinde görüntülenen metnin rengi |
|
|
İmza metin boyutu
|
pdfSignatureImageTextSize | number |
Singatures pad'lerinde görüntülenen metnin boyutu |
Döndürülenler
- Body
- signatureProfile
İmza profilini alma
İmza profili alma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İmza profili kimliği
|
spId | True | string |
İmza profilinin kimliği |
Döndürülenler
- Body
- signatureProfile
İmza profilini güncelleştirme
İmza profilini güncelleştirme
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İmza profili kimliği
|
spId | True | string |
İmza profilinin kimliği |
|
İçerik türü
|
Content-Type | True | string |
İçerik Türü |
|
Varsayılandır
|
isDefault | string |
Bu imza profilini varsayılan profil yapar |
|
|
Devre Dışı
|
isDisabled | string |
Bu imza profilini devre dışı bırak |
|
|
İsim
|
name | string |
İmza profili adı |
|
|
İmza türü
|
signatureType | string |
pades,xades,xadesDetached,xadesDetachedManifest,cades,helios |
|
|
Belgenin en altına doğru kaydırmaya zorlama
|
forceScrollDocument | boolean |
İmzalayanı belgenin en altına kaydırmaya zorlama |
|
|
Görünür imza modu
|
pdfVisibleSignatureMode | string |
Görünür imza modu (izin verildi, devre dışı, noImage) |
|
|
İmza metni
|
pdfSignatureImageText | string |
İmza bölmelerinde görüntülenen metin |
|
|
İmza metin rengi
|
pdfSignatureImageTextColor | string |
Singatures pad'lerinde görüntülenen metnin rengi |
|
|
İmza metin boyutu
|
pdfSignatureImageTextSize | number |
Singatures pad'lerinde görüntülenen metnin boyutu |
Döndürülenler
- Body
- signatureProfile
İmza profillerini ara
İmza profillerini ara
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Arama metni
|
text | string |
Arama metni |
|
|
Varsayılan arama
|
items.isDefault | string |
Varsayılan imza profillerini arama |
|
|
Arama devre dışı bırakıldı
|
items.isDisabled | string |
Devre dışı bırakılmış imza profillerini arama |
|
|
Arama adı
|
items.name | string |
İmza profili adına göre arama |
|
|
Arama belgesi. yazın
|
items.documentType | string |
Belge türüne göre arama |
|
|
arama imzası türü
|
items.signatureType | string |
İmza türüne göre arama |
|
|
Arama oluşturma tarihi
|
items.created | string |
Oluşturma tarihine göre arama |
|
|
Güncelleştirme tarihini ara
|
items.updated | string |
Son güncelleştirme tarihine göre arama |
|
|
Sıralama ölçütü
|
sortBy | string |
Arama sonucunu sıralamak için kullanılan alan |
|
|
Sıralama düzeni
|
sortOrder | string |
Sıralamanın yönü |
|
|
Sayfa başına öğe sayısı
|
itemsPerPage | string |
Yanıttaki sayfa başına öğe sayısı |
|
|
Sayfa dizini
|
pageIndex | string |
Döndürülen sayfanın dizini |
Döndürülenler
- Body
- signatureProfiles
İş akışlarını arama
İş akışlarını arama
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kabul etmek
|
Accept | string |
Kabul etmek |
|
|
Arama metni
|
text | string |
Arama metni |
|
|
Arama meta veri düzeni
|
items.layoutId | string |
Meta veri düzenine göre arama |
|
|
Arama şablonu
|
items.templateId | string |
İş akışı şablonuna göre arama |
|
|
Arama grubu
|
items.groupId | string |
Kullanıcılar grubuna göre arama |
|
|
Kullanıcı ara
|
items.userId | string |
Sahibine göre arama |
|
|
E-postada arama
|
items.email | string |
Sahibin e-posta adresine göre arama |
|
|
Ad ara
|
items.firstname | string |
Sahibin adına göre arama |
|
|
Soyadını ara
|
items.lastname | string |
Sahibin soyadına göre arama |
|
|
Arama durumu
|
items.workflowStatus | string |
İş akışı durumuna göre arama |
|
|
Arama meta verileri 1
|
items.data1 | string |
Meta veri değerine göre arama 1 |
|
|
Arama meta verileri 2
|
items.data2 | string |
Meta veri değerine göre arama 2 |
|
|
Arama meta verileri 3
|
items.data3 | string |
Meta veri değerine göre arama 3 |
|
|
Arama meta verileri 4
|
items.data4 | string |
Meta veri değerine göre arama 4 |
|
|
Arama meta verileri 5
|
items.data5 | string |
Meta veri değerine göre arama 5 |
|
|
Arama meta verileri 6
|
items.data6 | string |
Meta veri değerine göre arama 6 |
|
|
Arama meta verileri 7
|
items.data7 | string |
Meta veri değerine göre arama 7 |
|
|
Arama meta verileri 8
|
items.data8 | string |
Meta veri değerine göre arama 8 |
|
|
Arama oluşturma tarihi
|
items.created | string |
Oluşturma tarihine göre arama |
|
|
Güncelleştirme tarihini ara
|
items.updated | string |
Son güncelleştirme tarihine göre arama |
|
|
Arama başlangıç tarihi
|
items.started | string |
Başlangıç tarihine göre arama |
|
|
Sıralama ölçütü
|
sortBy | string |
Arama sonucunu sıralamak için kullanılan alan |
|
|
Sıralama düzeni
|
sortOrder | string |
Sıralamanın yönü |
|
|
Sayfa başına öğe sayısı
|
itemsPerPage | string |
Yanıttaki sayfa başına öğe sayısı |
|
|
Sayfa dizini
|
pageIndex | string |
Döndürülen sayfanın dizini |
Döndürülenler
- Body
- workflows
İş akışı belgelerini indirme
İş akışı belgelerini indirme
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İş Akışı Kimliği
|
workflowId | True | string |
İş akışının kimliği |
Döndürülenler
- response
- binary
İş akışı oluşturma
İş akışı oluşturma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kullanıcı Kimliği
|
userId | True | string |
İş akışı sahibi kullanıcı kimliği |
|
İçerik türü
|
Content-Type | string |
İçerik türü |
|
|
İsim
|
name | True | string |
İş akışının adı |
|
Description
|
description | string |
İş akışının açıklaması |
|
|
kimlik
|
id | string |
adım kimliği |
|
|
stepType
|
stepType | string |
imza veya onay |
|
|
consentPageId
|
consentPageId | True | string |
Bu alıcıyla ilişkili onay sayfasının kimliği (imza düzeyi) |
|
e-posta
|
True | string |
alıcının e-posta adresi |
|
|
userId
|
userId | string |
anında alıcı oluşturmak yerine bir LE kullanıcısını başvurma |
|
|
telefon numarası
|
phoneNumber | string |
reicpient'in cep telefonu numarası |
|
|
ön ad
|
firstName | string |
alıcının adı |
|
|
soyadı
|
lastName | string |
alıcının soyadı |
|
|
country
|
country | string |
alıcının ülke kodu |
|
|
preferredLocale
|
preferredLocale | string |
alıcının yerel ayar kodu |
|
|
organizationId
|
organizationId | string |
Alıcının LE kuruluşunun kimliği |
|
|
requiredRecipients
|
requiredRecipients | number |
bir sonraki adımı atmak için imzalaması gereken en az imzalayan sayısı |
|
|
validityPeriod
|
validityPeriod | number |
adım geçerlilik süresi |
|
|
inviteperiod
|
inviteperiod | number |
imza anımsatıcıları sıklığı |
|
|
maxInvites
|
maxInvites | number |
en fazla imza anımsatıcısı sayısı |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
imzalanan belgenin imzalayanlara teslimini denetler |
|
|
allowComments
|
allowComments | boolean |
bu adımda açıklamalara izin verir/bunları yasaklar |
|
|
hideAttachments
|
hideAttachments | boolean |
imzalayanlara eklerin görüntülenmesini denetler |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
imzalayana diğer imzalayanların görüntülenmesini denetler |
|
|
Bildirimli Olaylar
|
notifiedEvents | array of string |
Bildirimli iş akışı olayları |
|
|
userId
|
userId | string |
İzleyicinin kullanıcı kimliği |
|
|
notifiedEvents
|
notifiedEvents | array of string |
Bu izleyiciye bildirilecek iş akışı olayları |
|
|
e-posta
|
string |
İzleyicinin e-postası |
||
|
Şablon Kimliği
|
templateId | string |
İş akışının türetildiği şablonun kimliği |
|
|
Düzen Kimliği
|
layoutId | string |
worklow tarafından kullanılan meta veri düzeni |
|
|
veri1
|
data1 | string |
İlk meta veriler |
|
|
veri2
|
data2 | string |
İkinci meta veriler |
|
|
veri3
|
data3 | string |
Üçüncü meta veriler |
|
|
veri4
|
data4 | string |
Dördüncü meta veriler |
|
|
veri5
|
data5 | string |
Beşinci meta veriler |
|
|
veri6
|
data6 | string |
Altıncı meta veriler |
|
|
data7
|
data7 | string |
Yedinci meta veriler |
|
|
veri8
|
data8 | string |
Heighth meta verileri |
Döndürülenler
- Body
- workflow
İş akışını alma
İş akışı kimliğinden iş akışı alma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İş Akışı Kimliği
|
workflowId | True | string |
İş akışının kimliği |
Döndürülenler
- Body
- workflow
İş akışını güncelleştirme
İş akışını güncelleştirme
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İş Akışı Kimliği
|
workflowId | True | string |
Güncelleştirilecek iş akışının kimliği |
|
İçerik türü
|
Content-Type | string |
İçerik türü |
|
|
Kullanıcı Kimliği
|
userId | string |
İş akışı sahibinin kimliği |
|
|
İsim
|
name | string |
İş akışının adı |
|
|
Description
|
description | string |
İş akışının açıklaması |
|
|
kimlik
|
id | string |
adım kimliği |
|
|
stepType
|
stepType | string |
imza veya onay |
|
|
consentPageId
|
consentPageId | True | string |
Bu alıcıyla ilişkili onay sayfasının kimliği (imza düzeyi) |
|
e-posta
|
True | string |
alıcının e-posta adresi |
|
|
userId
|
userId | string |
anında alıcı oluşturmak yerine bir LE kullanıcısını başvurma |
|
|
telefon numarası
|
phoneNumber | string |
reicpient'in cep telefonu numarası |
|
|
ön ad
|
firstName | string |
alıcının adı |
|
|
soyadı
|
lastName | string |
alıcının soyadı |
|
|
country
|
country | string |
alıcının ülke kodu |
|
|
preferredLocale
|
preferredLocale | string |
alıcının yerel ayar kodu |
|
|
organizationId
|
organizationId | string |
Alıcının LE kuruluşunun kimliği |
|
|
requiredRecipients
|
requiredRecipients | number |
bir sonraki adımı atmak için imzalaması gereken en az imzalayan sayısı |
|
|
validityPeriod
|
validityPeriod | number |
adım geçerlilik süresi |
|
|
inviteperiod
|
inviteperiod | number |
imza anımsatıcıları sıklığı |
|
|
maxInvites
|
maxInvites | number |
en fazla imza anımsatıcısı sayısı |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
imzalanan belgenin imzalayanlara teslimini denetler |
|
|
allowComments
|
allowComments | boolean |
bu adımda açıklamalara izin verir/bunları yasaklar |
|
|
hideAttachments
|
hideAttachments | boolean |
imzalayanlara eklerin görüntülenmesini denetler |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
imzalayana diğer imzalayanların görüntülenmesini denetler |
|
|
Bildirimli Olaylar
|
notifiedEvents | array of string |
Bildirimli iş akışı olayları |
|
|
userId
|
userId | string |
İzleyici kullanıcı kimliği |
|
|
notifiedEvents
|
notifiedEvents | array of string |
Bu izleyiciye bildirilecek iş akışı olayları |
|
|
e-posta
|
string |
e-posta |
||
|
İş Akışı Durumu
|
workflowStatus | string |
İş akışının geçerli durumu |
|
|
veri1
|
data1 | string |
ilk meta veriler |
|
|
veri2
|
data2 | string |
ikinci meta veriler |
|
|
veri3
|
data3 | string |
üçüncü meta veriler |
|
|
veri4
|
data4 | string |
dördüncü meta veriler |
|
|
veri5
|
data5 | string |
beşinci meta veriler |
|
|
veri6
|
data6 | string |
altıncı meta veriler |
|
|
data7
|
data7 | string |
yedinci meta veriler |
|
|
veri8
|
data8 | string |
heighth meta verileri |
Döndürülenler
- Body
- workflow
İş akışını silme
İş akışını silme
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İş Akışı Kimliği
|
workflowId | True | string |
Silinecek iş akışının kimliği |
Döndürülenler
- Body
- workflow
Kanıt dosyasını indirme
İş akışı kanıt dosyasını indirme
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İş Akışı Kimliği
|
workflowId | True | string |
İş akışının kimliği |
|
Kabul etmek
|
Accept | True | string |
Kabul etmek |
Döndürülenler
- response
- binary
Kişi arama
Kişi arama
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Arama metni
|
text | string |
Metne göre arama |
|
|
E-postada arama
|
items.email | string |
E-postayla arama |
|
|
Arama telefon numarası
|
items.phoneNumber | string |
Telefon numarasına göre arama |
|
|
Ad ara
|
items.fisrtName | string |
Ada göre arama |
|
|
Soyadını ara
|
items.lastName | string |
Soyadına göre arama |
|
|
Ülke ara
|
items.country | string |
Ülkeye göre arama |
|
|
Sayfa başına öğe sayısı
|
itemsPerPage | number |
Yanıttaki sayfa başına öğe sayısı |
|
|
Sayfa dizini
|
pageIndex | number |
Döndürülen sayfanın dizini |
Döndürülenler
- Body
- contacts
Kişiyi alma
Kişi kimliğinden kişi bilgilerini alma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İrtibat Numarası
|
contactId | True | string |
Kişinin kimliği |
|
İçerik türü
|
Content-Type | True | string |
İçerik Türü |
Döndürülenler
- Body
- contact
Kişiyi güncelleştirme
Mevcut kişi bilgilerini değiştirme
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İrtibat Numarası
|
contactId | True | string |
Kişinin kimliği |
|
İçerik türü
|
Content-Type | True | string |
İçerik Türü |
|
Kişinin e-posta adresi
|
string |
Kişinin e-posta adresi |
||
|
Kişinin Telefon Numarası
|
phoneNumber | string |
Kişinin Telefon Numarası |
|
|
Kişinin adı
|
firstName | string |
Kişinin adı |
|
|
Kişinin Soyadı
|
lastName | string |
Kişinin Soyadı |
|
|
İlgili kişinin ülkesi
|
country | string |
İlgili kişinin ülkesi |
Döndürülenler
- Body
- contact
Kişiyi silme
Geçerli kullanıcının contects listesinden kişiyi kaldırma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İrtibat Numarası
|
contactId | True | string |
Kişinin kimliği |
|
İçerik türü
|
Content-Type | True | string |
İçerik Türü |
Döndürülenler
- Body
- contact
Meta veri düzeni oluşturma
Meta veri düzeni oluşturma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kiracı Kimliği
|
tenantId | True | string |
Düzenin kimliği |
|
İçerik türü
|
Content-Type | True | string |
İçerik Türü |
|
İsim
|
name | True | string |
Düzen adı |
|
Devre dışı bırakıldı
|
isDisabled | boolean |
True olarak ayarlanırsa düzen devre dışı bırakılır |
|
|
Yuvası
|
slot | string |
Meta veri öğesi (data1 to data8) |
|
|
default
|
default | string |
Bu düzendeki meta veri varsayılan değeri |
|
|
optional
|
optional | boolean |
True ise, bir değer sağlamak zorunlu değildir |
|
|
salt okunur
|
readonly | boolean |
Değer geçersiz kılınabilir |
|
|
rememberLastValue
|
rememberLastValue | boolean |
True olarak ayarlanırsa, değer iş akışları arasında kalıcı olur |
Döndürülenler
Meta veri düzeni
- Body
- layout
Meta veri düzenini alma
İş akışı düzeni alma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Düzen Kimliği
|
layoutId | True | string |
Düzenin kimliği |
Döndürülenler
Meta veri düzeni
- Body
- layout
Meta veri düzenini güncelleştirme
Meta veri düzenini güncelleştirme
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kiracı Kimliği
|
layoutId | True | string |
Düzenin kimliği |
|
İçerik türü
|
Content-Type | True | string |
İçerik Türü |
|
İsim
|
name | True | string |
Düzen adı |
|
Devre dışı bırakıldı
|
isDisabled | boolean |
True olarak ayarlanırsa düzen devre dışı bırakılır |
|
|
Yuvası
|
slot | string |
Meta veri öğesi (data1 to data8) |
|
|
default
|
default | string |
Bu düzendeki meta veri varsayılan değeri |
|
|
optional
|
optional | boolean |
True ise, bir değer sağlamak zorunlu değildir |
|
|
salt okunur
|
readonly | boolean |
Değer geçersiz kılınabilir |
|
|
rememberLastValue
|
rememberLastValue | boolean |
True olarak ayarlanırsa, değer iş akışları arasında kalıcı olur |
Döndürülenler
Meta veri düzeni
- Body
- layout
Meta veri düzenlerinde arama
İş akışı düzenlerinde arama
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Arama metni
|
text | string |
Arama metni |
|
|
Arama devre dışı bırakıldı
|
items.isDisabled | string |
Devre dışı bırakılmış düzenleri arama |
|
|
Arama adı
|
items.name | string |
Düzen adına göre arama |
|
|
Arama meta verileri
|
items.dataConfigurations.slot | string |
Meta verilerin varlığına göre arama |
|
|
Arama oluşturma tarihi
|
items.created | string |
Oluşturma tarihine göre arama |
|
|
Güncelleştirme tarihini ara
|
items.updated | string |
Son güncelleştirme tarihine göre arama |
|
|
Sıralama ölçütü
|
sortBy | string |
Arama sonucunu sıralamak için kullanılan alan |
|
|
Sıralama düzeni
|
sortOrder | string |
Sıralamanın yönü |
|
|
Sayfa başına öğe sayısı
|
itemsPerPage | string |
Yanıttaki sayfa başına öğe sayısı |
|
|
Sayfa dizini
|
pageIndex | string |
Döndürülen sayfanın dizini |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
items
|
items | layouts |
Meta veri eşlemesini alma
Belirtilen kiracının meta veri eşlemesini alma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kiracı Kimliği
|
tenantId | True | string |
Kiracının kimliği |
Döndürülenler
- Body
- dataMapping
Onay alma sayfası
Onay sayfası kimliğinden onay sayfası bilgilerini alma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Onay sayfası kimliği
|
cpId | True | string |
Onay sayfasının kimliği |
|
İçerik türü
|
Content-Type | True | string |
İçerik Türü |
Döndürülenler
- Body
- consentPage
Parça oluşturma
Belge bölümü oluşturma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İş Akışı Kimliği
|
workflowId | True | string |
İlgili iş akışının kimliği |
|
İçerik türü
|
Content-Type | True | string |
İçerik Türü |
|
Cotent Disposition
|
Content-Disposition | True | string |
content-dispotion |
|
Belge Oluştur
|
createDocuments | string |
Bu bölümden belge oluştur |
|
|
Ekleri yoksay
|
ignoreAttachments | string |
Ekler yoksayılır |
|
|
İmza profili kimliği
|
signatureProfileId | string |
Bölüm atlanırsa ek olarak kabul edilir |
|
|
Unzip
|
unzip | string |
Dosyaların sıkıştırmasını açma |
|
|
Pdf'yi PdfA'ya
|
pdf2pdfa | string |
Pdf'yi pdf/A'ya dönüştürme |
|
|
Belge
|
document | True | binary |
Karşıya yüklenen dosya verileri |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
evrak
|
documents | array of document |
Oluşturulan belgeler |
|
ignoredAttachments
|
ignoredAttachments | integer |
ignoredAttachments |
|
Parça
|
parts | array of part |
Parça |
Tanımlar
consentPage
| Name | Yol | Tür | Description |
|---|---|---|---|
|
allowOrganization
|
allowOrganization | boolean |
Kuruluşların kullanımına izin verir |
|
authenticateUser
|
authenticateUser | boolean |
İmzalayan kimlik doğrulaması uygular |
|
clientId
|
clientId | string |
İstemci Kimliği |
|
Oluşturulan
|
created | number |
Oluşturma tarihi |
|
emUrl
|
emUrl | string |
Kanıt yöneticisi Url'si |
|
hideDownloads
|
hideDownloads | boolean |
Belge indirme bağlantıları onay sayfalarında görüntülenmez |
|
hideMobileQrCode
|
hideMobileQrCode | boolean |
Birleştirilmiş sayfalardaki QR kodlarını gizler |
|
kimlik
|
id | string |
Onay sayfası kimliği |
|
isCountryRequired
|
isCountryRequired | boolean |
İmzalayanların bilgilerinde ülkeyi zorunlu kılar |
|
isDisabled
|
isDisabled | boolean |
Onay sayfası devre dışı bırakıldı |
|
logoResourceId
|
logoResourceId | string |
Onay sayfası logo kaynağının kimliği |
|
name
|
name | string |
Onay sayfası adı |
|
primaryColor
|
primaryColor | string |
Onay sayfası birincil rengi |
|
secondaryColor
|
secondaryColor | string |
Onay sayfası ikincil rengi |
|
sharedPassphrase
|
sharedPassphrase | string |
Paylaşılan parola |
|
imzalama modu
|
signing mode | string |
İmzalama modu (yerel veya sunucu) |
|
stepType
|
stepType | string |
adım türü (imza veya onay) |
|
tenantId
|
tenantId | string |
Kiracı Kimliği |
|
tsaUrl
|
tsaUrl | string |
Zaman damgası yetkilisi Url'si |
|
Güncel -leştirilmiş
|
updated | number |
Son değişiklik tarihi |
|
verifyEmail
|
verifyEmail | boolean |
Tue olarak ayarlanırsa, imzalayanlar e-postalar tarafından OTP'ler alır |
|
verifyPhoneNumber
|
verifyPhoneNumber | boolean |
True olarak ayarlanırsa, imzalayanlar kısa mesajla OTP'ler alır |
consentPages
| Name | Yol | Tür | Description |
|---|---|---|---|
|
items
|
items | array of consentPage |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
toplamÖğeler
|
totalItems | integer |
toplamÖğeler |
temas
| Name | Yol | Tür | Description |
|---|---|---|---|
|
country
|
country | string |
İlgili ülke |
|
Oluşturulan
|
created | integer |
Kişi oluşturma tarihi |
|
e-posta
|
string |
İlgili kişinin e-posta adresi |
|
|
ön ad
|
firstName | string |
İlgili Kişi adı |
|
kimlik
|
id | string |
Kişi kimliği |
|
soyadı
|
lastName | string |
İlgili Kişi soyadı |
|
name
|
name | string |
Kişi adı (ad + soyadı)) |
|
telefon numarası
|
phoneNumber | string |
İlgili kişi telefon numarası |
|
tenantId
|
tenantId | string |
Kiracı Kimliği |
|
Güncel -leştirilmiş
|
updated | integer |
İletişim son değiştirme tarihi |
|
userId
|
userId | string |
Kişi sahibinin kimliği |
contacts
| Name | Yol | Tür | Description |
|---|---|---|---|
|
items
|
items | array of contact |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
toplamÖğeler
|
totalItems | integer |
toplamÖğeler |
dataMapping
| Name | Yol | Tür | Description |
|---|---|---|---|
|
açıklama
|
data1.description | string |
Meta veri açıklaması |
|
name
|
data1.name | string |
Meta veri adı |
|
pattern
|
data1.pattern | string |
Meta veri deseni |
|
options
|
data1.options | array of object |
options |
|
value
|
data1.options.value | string |
Meta veri değeri |
|
type
|
data1.type | string |
type |
|
açıklama
|
data2.description | string |
Meta veri açıklaması |
|
name
|
data2.name | string |
Meta veri adı |
|
pattern
|
data2.pattern | string |
Meta veri deseni |
|
options
|
data2.options | array of object |
options |
|
value
|
data2.options.value | string |
Meta veri değeri |
|
type
|
data2.type | string |
type |
|
açıklama
|
data3.description | string |
Meta veri açıklaması |
|
name
|
data3.name | string |
Meta veri adı |
|
pattern
|
data3.pattern | string |
Meta veri deseni |
|
options
|
data3.options | array of object |
options |
|
value
|
data3.options.value | string |
Meta veri değeri |
|
type
|
data3.type | string |
type |
|
açıklama
|
data4.description | string |
Meta veri açıklaması |
|
name
|
data4.name | string |
Meta veri adı |
|
pattern
|
data4.pattern | string |
Meta veri deseni |
|
options
|
data4.options | array of object |
options |
|
value
|
data4.options.value | string |
Meta veri değeri |
|
type
|
data4.type | string |
type |
|
açıklama
|
data5.description | string |
Meta veri açıklaması |
|
name
|
data5.name | string |
Meta veri adı |
|
pattern
|
data5.pattern | string |
Meta veri deseni |
|
options
|
data5.options | array of object |
options |
|
value
|
data5.options.value | string |
Meta veri değeri |
|
type
|
data5.type | string |
type |
|
açıklama
|
data6.description | string |
Meta veri açıklaması |
|
name
|
data6.name | string |
Meta veri adı |
|
pattern
|
data6.pattern | string |
Meta veri deseni |
|
options
|
data6.options | array of object |
options |
|
value
|
data6.options.value | string |
Meta veri değeri |
|
type
|
data6.type | string |
type |
|
açıklama
|
data7.description | string |
Meta veri açıklaması |
|
name
|
data7.name | string |
Meta veri adı |
|
pattern
|
data7.pattern | string |
Meta veri deseni |
|
options
|
data7.options | array of object |
options |
|
value
|
data7.options.value | string |
Meta veri değeri |
|
type
|
data7.type | string |
type |
|
açıklama
|
data8.description | string |
Meta veri açıklaması |
|
name
|
data8.name | string |
Meta veri adı |
|
pattern
|
data8.pattern | string |
Meta veri deseni |
|
options
|
data8.options | array of object |
options |
|
value
|
data8.options.value | string |
Meta veri değeri |
|
type
|
data8.type | string |
type |
belge
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Oluşturulan
|
created | integer |
Oluşturma tarihi |
|
groupId
|
groupId | string |
Belge sahibinin grubunun kimliği |
|
kimlik
|
id | string |
Belgenin kimliği |
|
Parça
|
parts | array of part |
Parça |
|
pdfSignatureFields
|
pdfSignatureFields | array of pdfSigField |
pdfSignatureFields |
|
signatureProfileId
|
signatureProfileId | string |
Belgenin imza profilinin kimliği |
|
tenantId
|
tenantId | string |
Kiracı kimliği |
|
Güncel -leştirilmiş
|
updated | integer |
Son değişiklik tarihi |
|
userId
|
userId | string |
Belge sahibi kullanıcı kimliği |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Belgeyi görüntülemesine izin verilen grupların listesi |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
Belgeyi görüntülemesine izin veren kullanıcıların listesi |
|
workflowId
|
workflowId | string |
Belgenin ait olduğu iş akışının kimliği |
|
iş akışı adı
|
workflowName | string |
Belgenin ait olduğu iş akışının adı |
evrak
| Name | Yol | Tür | Description |
|---|---|---|---|
|
items
|
items | array of document |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
toplamÖğeler
|
totalItems | integer |
toplamÖğeler |
Düzen
Meta veri düzeni
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Oluşturulan
|
created | number |
Oluşturma tarihi |
|
kimlik
|
id | string |
Düzen Kimliği |
|
isDisabled
|
isDisabled | boolean |
True olarak ayarlanırsa düzen bozulmuş olur |
|
name
|
name | string |
Düzenin adı |
|
tenantId
|
tenantId | string |
Kiracının kimliği |
|
Güncel -leştirilmiş
|
updated | number |
Son değişiklik tarihi |
|
dataConfigurations
|
dataConfigurations | array of object | |
|
Yuvası
|
dataConfigurations.slot | string |
Meta veri öğesi (data1 to data8) |
|
default
|
dataConfigurations.default | string |
Bu düzendeki meta veri varsayılan değeri |
|
optional
|
dataConfigurations.optional | boolean |
True ise, bu meta veriler için bir değer sağlamak zorunlu değildir |
|
salt okunur
|
dataConfigurations.readonly | boolean |
Değer geçersiz kılınabilir |
|
rememberLastValue
|
dataConfigurations.rememberLastValue | boolean |
True olarak ayarlanırsa, değer iş akışları arasında kalıcı olur |
Düzen
| Name | Yol | Tür | Description |
|---|---|---|---|
|
items
|
items | array of object | |
|
Oluşturulan
|
items.created | number |
Oluşturma tarihi |
|
dataConfigurations
|
items.dataConfigurations | array of layout | |
|
itemsPerPage
|
itemsPerPage | number |
Sayfa başına öğe sayısı |
|
pageIndex
|
pageIndex | number |
Döndürülen sayfanın dizini |
|
toplamÖğeler
|
totalItems | number |
İstekle ilgili öğelerin toplam sayısı |
part
Belge bölümü
| Name | Yol | Tür | Description |
|---|---|---|---|
|
içerik türü
|
contentType | string |
içerik türü |
|
filename
|
filename | string |
filename |
|
Karma
|
hash | string |
Karma |
|
size
|
size | integer |
size |
pdfSigField
| Name | Yol | Tür | Description |
|---|---|---|---|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
imagePage
|
imagePage | float |
imagePage |
|
imageWidth
|
imageWidth | float |
imageWidth |
|
imageX
|
imageX | float |
imageX |
|
imageY
|
imageY | float |
imageY |
signatureProfile
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Oluşturulan
|
created | number |
Oluşturma tarihi |
|
documentType
|
documentType | string |
Belgelerin türü |
|
forceScrollDocument
|
forceScrollDocument | boolean |
İmzalayanı belgenin en altına kaydırmaya zorlama |
|
kimlik
|
id | string |
imza profili kimliği |
|
Varsayılan
|
isDefault | boolean |
Bu imza profilini varsayılan profil yapar |
|
isDisabled
|
isDisabled | boolean |
Bu imza profilini devre dışı bırak |
|
name
|
name | string |
İmza profili adı |
|
pdfSignatureImageText
|
pdfSignatureImageText | string |
İmza bölmelerinde görüntülenen metin |
|
pdfSignatureImageTextColor
|
pdfSignatureImageTextColor | string |
Singatures pad'lerinde görüntülenen metnin rengi |
|
pdfSignatureImageTextSize
|
pdfSignatureImageTextSize | number |
Singatures pad'lerinde görüntülenen metnin boyutu |
|
pdfVisibleSignatureMode
|
pdfVisibleSignatureMode | string |
Görünür imza modu (izin verildi, devre dışı, noImage) |
|
İmza türü
|
signatureType | string |
pades, xades, xadesDetached, xadesDetachedManifest, cades, helios |
|
tenantId
|
tenantId | string |
Kiracı Kimliği |
|
Güncel -leştirilmiş
|
updated | number |
Son değişiklik tarihi |
signatureProfiles
| Name | Yol | Tür | Description |
|---|---|---|---|
|
items
|
items | array of signatureProfile | |
|
itemsPerPage
|
itemsPerPage | number |
Sayfa başına öğe sayısı |
|
pageIndex
|
pageIndex | number |
Döndürülen sayfanın dizini |
|
toplamÖğeler
|
totalItems | number |
İstekle ilgili öğelerin toplam sayısı |
user
| Name | Yol | Tür | Description |
|---|---|---|---|
|
approveAllowed
|
approveAllowed | boolean |
True olarak ayarlanırsa, kullanıcı belgeleri onaylayabilir |
|
country
|
country | string |
Kullanıcının ülkesi |
|
Oluşturulan
|
created | integer |
Oluşturma tarihi |
|
e-posta
|
string |
Kullanıcının e-posta adresi |
|
|
ön ad
|
firstName | string |
Kullanıcının Adı |
|
groupId
|
groupId | string |
Kullanıcı grubunun kimliği |
|
kimlik
|
id | string |
Kullanıcının kimliği |
|
isDisabled
|
isDisabled | boolean |
True ise, kullanıcı devre dışı bırakılır |
|
lastLogin
|
lastLogin | integer |
Kullanıcının son oturum açma tarihi |
|
soyadı
|
lastName | string |
Kullanıcının Soyadı |
|
name
|
name | string |
Kullanıcının adı (ad + soyadı) |
|
organizationTitles
|
organizationTitles | array of |
Kullanıcının kuruluşlarındaki eğlenceleri |
|
telefon numarası
|
phoneNumber | string |
Kullanıcının telefon numarası |
|
signAllowed
|
signAllowed | boolean |
True olarak ayarlanırsa, kullanıcı belgeleri imzalayabilir |
|
konu
|
subject | string |
Kullanıcının iç alt görev kodu |
|
tenantId
|
tenantId | string |
Kiracının kimliği |
|
Güncel -leştirilmiş
|
updated | integer |
Son değişiklik tarihi |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Kullanıcının gözlemci olarak davranabileceği grubun listesi |
iş akışı
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Oluşturulan
|
created | integer |
Oluşturulan |
|
currentRecipientEmails
|
currentRecipientEmails | array of |
currentRecipientEmails |
|
currentRecipientUsers
|
currentRecipientUsers | array of |
currentRecipientUsers |
|
veri1
|
data1 | string |
Meta Veri 1 |
|
veri2
|
data2 | string |
Meta Veri 2 |
|
veri3
|
data3 | string |
Meta Veri 3 |
|
veri4
|
data4 | string |
Meta Veri 4 |
|
veri5
|
data5 | string |
Meta Veri 5 |
|
veri6
|
data6 | string |
Meta Veri 6 |
|
data7
|
data7 | string |
Meta Veri 7 |
|
veri8
|
data8 | string |
Meta Veri 8 |
|
açıklama
|
description | string |
İş akışının açıklaması |
|
e-posta
|
string |
İş akışı sahibinin e-postası |
|
|
ön ad
|
firstName | string |
İş akışı sahibinin adı |
|
groupId
|
groupId | string |
İş akışı sahibinin grubunun kimliği |
|
kimlik
|
id | string |
İş akışının kimliği |
|
soyadı
|
lastName | string |
İş akışı sahibinin soyadı |
|
layoutId
|
layoutId | string |
İş akışının meta veri düzeninin kimliği |
|
logs
|
logs | array of |
Wokflow öğelerini günlüğe kaydeder |
|
name
|
name | string |
İş akışı sahibinin adı (ad + soyadı) |
|
notifiedEvents
|
notifiedEvents | array of string |
İş akışı tarafından bildirilen olayların lis'i |
|
ilerleme
|
progress | integer |
İş akışının yüzde cinsinden ilerleme durumu |
|
steps
|
steps | array of object |
steps |
|
allowComments
|
steps.allowComments | boolean |
Adımda izin verilen etkileşimli açıklamalara izin verir/yasaklar |
|
hideAttachments
|
steps.hideAttachments | boolean |
İmzalayanlara eklerin görüntülenmesini denetler |
|
hideWorkflowRecipients
|
steps.hideWorkflowRecipients | boolean |
İmzalayana diğer imzalayanların görüntülenmesini denetler |
|
kimlik
|
steps.id | string |
Adım kimliği |
|
invitePeriod
|
steps.invitePeriod | integer |
invitePeriod |
|
isFinished
|
steps.isFinished | boolean |
isFinished |
|
Başlatıldı mı
|
steps.isStarted | boolean |
Başlatıldı mı |
|
logs
|
steps.logs | array of |
logs |
|
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-posta
|
steps.recipients.email | string |
e-posta |
|
ön ad
|
steps.recipients.firstName | string |
ön ad |
|
soyadı
|
steps.recipients.lastName | string |
soyadı |
|
telefon numarası
|
steps.recipients.phoneNumber | string |
telefon numarası |
|
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 |
|
Güncel -leştirilmiş
|
updated | integer |
Güncel -leştirilmiş |
|
userId
|
userId | string |
userId |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Kullanıcıların gözlemci olarak görev yapabilecekleri grupların listesi |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
viewAuthorizedUsers |
|
watchers
|
watchers | array of object |
watchers |
|
e-posta
|
watchers.email | string |
e-posta |
|
notifiedEvents
|
watchers.notifiedEvents | array of string |
notifiedEvents |
|
userId
|
watchers.userId | string |
userId |
|
workflowStatus
|
workflowStatus | string |
workflowStatus |
workflows
| Name | Yol | Tür | Description |
|---|---|---|---|
|
items
|
items | array of workflow |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
toplamÖğeler
|
totalItems | integer |
toplamÖğeler |
ikili
Bu, 'ikili' temel veri türüdür.