Aracılığıyla paylaş

Adobe Acrobat Sign

Adobe, dünyanın en güvenilir dijital belge imzalama hizmetidir. Adobe Acrobat Sign ile el ile gerçekleştirilen işlemleri tamamen dijital deneyimlere dönüştürebilirsiniz. Sözleşmelerin durumunu oluşturmak, göndermek ve izlemek için Adobe Acrobat Sign işlevini sık kullandığınız uygulamalara ekleyin.

Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:

Hizmet Class Bölgeler
Copilot Studio Standart Aşağıdakiler dışında tüm Power Automate bölgeleri :
     - 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 Çin bölgeleri
     - ABD Savunma Bakanlığı (DoD)
Power Apps Standart Aşağıdakiler dışında tüm Power Apps bölgeleri :
     - US Government (GCC High)
     - 21Vianet tarafından işletilen Çin Bulutu
     - ABD Savunma Bakanlığı (DoD)
Power Automate Standart Aşağıdakiler dışında tüm Power Automate bölgeleri :
     - US Government (GCC High)
     - 21Vianet tarafından işletilen Çin Bulutu
     - ABD Savunma Bakanlığı (DoD)
İletişim
İsim Adobe Acrobat Sign Desteği
URL https://helpx.adobe.com/contact/enterprise-support.dc.html#sign
E-posta support@echosign.zendesk.com
Bağlayıcı Meta Verileri
Publisher ADOBE INC.
Web sitesi https://acrobat.adobe.com/us/en/sign.html
Gizlilik ilkesi https://www.adobe.com/privacy/policy.html
Kategoriler Web sitesi

Adobe Acrobat Sign

Adobe, dünyanın en güvenilir dijital belge imzalama hizmetidir. Adobe Acrobat Sign ile el ile gerçekleştirilen işlemleri tamamen dijital deneyimlere dönüştürebilirsiniz. Sözleşmelerin durumunu oluşturmak, göndermek ve izlemek için Adobe Acrobat Sign işlevini sık kullandığınız uygulamalara ekleyin.

Yayımcı: Adobe, Inc.

Önkoşullar

Adobe Acrobat Sign hesabı gereklidir.

Kimlik bilgilerini alma

Mevcut Değil

Bağlayıcınızı kullanmaya başlama

Bağlayıcı kullanıcı kılavuzu https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html

Bilinen sorunlar ve sınırlamalar

Mevcut Değil

Yaygın hatalar ve çözümler

Mevcut Değil

FAQ

Bağlayıcı kullanıcı kılavuzu https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html

Azaltma Sınırları

Name Çağrılar Yenileme Dönemi
Bağlantı başına API çağrıları 250 60 saniye

Eylemler

Arama ölçütlerine göre tüm sözleşmelerin listesini alma

Bu işlem iş akışı kimliği gibi ölçütlere göre sözleşmeleri arar.
Belge URL'sinden kitaplık şablonu oluşturma

Bu işlem, belge URL'sinden Adobe Acrobat Sign kitaplığında bir şablon oluşturur. Sözleşme göndermek için bu şablonu kullanın
Belge URL'sinden kitaplık şablonu oluşturma (Eski) [KULLANIM DIŞI]

Bu işlem, belge URL'sinden Adobe Acrobat Sign kitaplığında bir şablon oluşturur. Sözleşme göndermek için bu şablonu kullanın
Belge URL'sinden sözleşme oluşturma ve imza için gönderme

Bu işlem, Adobe Acrobat Sign'a yüklenen bir belgeden bir sözleşme oluşturur ve imza için gönderir.
Belge URL'sinden sözleşme oluşturma ve imza için gönderme (Eski) [KULLANIM DIŞI]

Bu işlem, Adobe Acrobat Sign'a yüklenen bir belgeden bir sözleşme oluşturur ve imza için gönderir.
Belgeyi karşıya yükleme ve belge kimliği alma (Eski) [KULLANIM DIŞI]

Bu işlem, Adobe Acrobat Sign hesabınıza bir belge yükler ve bunun için bir belge kimliği döndürür. Bu belge geçici olarak Adobe Acrobat Sign'da depolanır ve belge kimliği sözleşme oluşturma gibi diğer işlemler için kullanılabilir.
Belgeyi karşıya yükleme ve belge kimliğini alma

Bu işlem, Adobe Acrobat Sign hesabınıza bir belge yükler ve bunun için bir belge kimliği döndürür. Bu belge geçici olarak Adobe Acrobat Sign'da depolanır ve belge kimliği sözleşme oluşturma gibi diğer işlemler için kullanılabilir.
bir iş akışından sözleşme oluşturma ve imza için gönderme

Bu işlem, Adobe Acrobat Sign'daki bir iş akışından bir sözleşme oluşturur ve imza için gönderir.
Dosya içeriğinden sözleşme oluşturma ve imza için gönderme

Bu işlem, Adobe Acrobat Sign'daki bir dosyadan bir sözleşme oluşturur ve imza için gönderir.
İmzalama URL'sini alma

Bu işlem, bir sözleşmenin geçerli imzalayanları için e-imza sayfasının URL'sini alır.
İmzalı sözleşmenin PDF'sini alma

Bu işlem, birleştirilmiş veya imzalanmış sözleşmenin PDF dosya akışını getirir. Dosya akışının .pdf dosya uzantısıyla biten bir dosya adıyla depolanması gerektiğini unutmayın.
İmzalı sözleşmenin PDF'sini alma [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine imzalı bir sözleşmenin PDF'sini alın'ı kullanın.

Bu işlem, birleştirilmiş veya imzalanmış sözleşmenin PDF dosya akışını getirir. Dosya akışının .pdf dosya uzantısıyla biten bir dosya adıyla depolanması gerektiğini unutmayın.
İş akışının ayrıntılı bilgilerini alma

Bu işlem, iş akışıyla ilgili ayrıntılı bilgi parçalarını getirir.
Karşıya yüklenen bir belgeden kitaplık şablonu oluşturma

Bu işlem, karşıya yüklenen bir belgeden Adobe Acrobat Sign kitaplığında bir şablon oluşturur. Sözleşme göndermek için bu şablonu kullanın.
Karşıya yüklenen bir belgeden kitaplık şablonu oluşturma (Eski) [KULLANIM DIŞI]

Bu işlem, karşıya yüklenen bir belgeden Adobe Acrobat Sign kitaplığında bir şablon oluşturur. Sözleşme göndermek için bu şablonu kullanın.
Karşıya yüklenen bir belgeden sözleşme oluşturma ve imza için gönderme

Bu işlem, Adobe Acrobat Sign'a yüklenen bir belgeden bir sözleşme oluşturur ve imza için gönderir.
Karşıya yüklenen bir belgeden sözleşme oluşturma ve imza için gönderme (Eski) [KULLANIM DIŞI]

Bu işlem, Adobe Acrobat Sign'a yüklenen bir belgeden bir sözleşme oluşturur ve imza için gönderir.
Kitaplık şablonundan sözleşme oluşturma ve imza için gönderme

Bu işlem, kullanıcının Adobe Acrobat Sign kitaplığında depolanan bir şablondan bir sözleşme oluşturur ve imza için gönderir.
Kitaplık şablonundan sözleşme oluşturma ve imza için gönderme (Eski) [KULLANIM DIŞI]

Bu işlem, kullanıcının Adobe Acrobat Sign kitaplığında depolanan bir şablondan bir sözleşme oluşturur ve imza için gönderir.
Kullanıcının ait olduğu tüm grupların listesini alma

Bu işlem, kullanıcının ait olduğu tüm grupların listesini getirir.
Sözleşme görünümü URL'sini alma

Sözleşmenin en son durum görünümü URL'sini alır.
Sözleşmeden belge alma

Bu işlem, sözleşmenin belirli bir belgesinin dosya akışını getirir.
Sözleşmeden belge alma [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Sözleşmeden belge al'ı kullanın.

Bu işlem, sözleşmenin belirli bir belgesinin dosya akışını getirir.
Sözleşmeden tüm belge kimliklerinin listesini alma

Bu işlem, bir sözleşmenin tüm belgelerinin ve destekleyici belgelerinin kimliklerini getirir.
Sözleşmeden tüm belge kimliklerinin listesini alma [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine bir sözleşmedeki tüm belge kimliklerinin listesini alın'ı kullanın.

Bu işlem, bir sözleşmenin tüm belgelerinin ve destekleyici belgelerinin kimliklerini getirir.
Sözleşmenin denetim kaydının PDF'sini alma

Bu işlem, sözleşme denetim kaydının PDF dosya akışını getirir. Dosya akışının .pdf dosya uzantısıyla biten bir dosya adıyla depolanması gerektiğini unutmayın.
Sözleşmenin durumunu alma

Bu işlem, durum gibi bir sözleşmenin tüm geçerli bilgilerini getirir.
Sözleşmenin durumunu alma [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Bir sözleşmenin durumunu alın'ı kullanın.

Bu işlem, durum gibi bir sözleşmenin tüm geçerli bilgilerini getirir.
Sözleşmenin form alanı verilerini alma (Eski) [KULLANIM DIŞI]

Sözleşmenin etkileşimli form alanlarına girilen verileri alır.
Sözleşmenin form alanı verilerini CSV biçiminde alma

Sözleşmenin etkileşimli form alanlarına girilen verileri alır.
Sözleşmenin form alanı verilerini JSON biçiminde alma

Sözleşmenin etkileşimli form alanlarına girilen verileri alır.
Sözleşmeyi iptal etme

Yolda agreementId ile tanımlanan sözleşmeyi iptal eder.
Tüm iş akışlarının listesini alma

Bu işlem, kullanıcının tüm iş akışlarının listesini getirir.
Tüm kitaplık şablonlarının listesini alma

Bu işlem, kullanıcının Adobe Acrobat Sign kitaplığında şablon olarak depolanan tüm belgelerin listesini getirir.
Tüm kitaplık şablonlarının listesini alma (Eski) [KULLANIM DIŞI]

Bu işlem, kullanıcının Adobe Acrobat Sign kitaplığında şablon olarak depolanan tüm belgelerin listesini getirir.
Tüm sözleşmelerin listesini alma

Bu işlem, kullanıcının tüm sözleşmelerinin listesini getirir.
Tüm sözleşmelerin listesini alma (Eski) [KULLANIM DIŞI]

Bu işlem, kullanıcının tüm sözleşmelerinin listesini getirir.
Tüm web formlarının listesini alma

Bu işlem, kullanıcının tüm web formlarının listesini getirir.

Arama ölçütlerine göre tüm sözleşmelerin listesini alma

İşlem Kimliği:
SearchAgreements

Bu işlem iş akışı kimliği gibi ölçütlere göre sözleşmeleri arar.

Parametreler

Name Anahtar Gerekli Tür Description
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Grup Adı/Kimliği
 groupId string

Grubun kimliği. Bunu kullanmak için , 'Adı'nda' alanının seçilmesi gerekir
İş Akışı Adı/Kimliği
 workflowId string

Listeden özel iş akışı seçin veya özel iş akışı kimliğini girin.
Oluşturulduktan Sonra
 gt string

İzin verilen en düşük tarih-saat. Örnek: 2020-12-31T23:59:00Z
Daha Önce Oluşturuldu
 lt string

İzin verilen en yüksek tarih-saat. Örnek: 2023-12-31T23:59:00Z
Sayfa Boyutu
 pageSize integer

Yanıt sayfasındaki öğe sayısı. Varsayılan olarak: 50; Maksimum: 500
Başlangıç Dizini
 startIndex integer

Döndürülecek arama sonuçlarının 0 tabanlı ilk satırı (uzaklık).

Döndürülenler

Kullanıcı sözleşmesi dizi nesnesini içeren bir JSON

Body
userAgreementListV6

Belge URL'sinden kitaplık şablonu oluşturma

İşlem Kimliği:
CreateLibraryDocumentByUrl_V2

Bu işlem, belge URL'sinden Adobe Acrobat Sign kitaplığında bir şablon oluşturur. Sözleşme göndermek için bu şablonu kullanın

Parametreler

Name Anahtar Gerekli Tür Description
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Şablon Adı
 name True string

Şablonu tanımlamak için kullanılan Sözleşme Adı
Şablon Türü
 templateTypes True array of string

Bir veya daha fazla kitaplık şablonu türünün listesi
Paylaşım Modu
 sharingMode True string

Bu kitaplık belgesine kimlerin erişimi olması gerektiğini belirtir
URL
 url True string

Ham dosya içeriğini almak için genel olarak erişilebilir bir URL
İsim
 name True string

Gönderilen belgenin özgün sistem dosya adı
Türü
 mimeType True string

Başvuruda bulunılan dosyanın mime türü; örneğin, uygulama/pdf
Şablon Durumu
 state True string

Kitaplık belgesinin durumu.
Grup Adı/Kimliği
 groupId string

Grubun kimliği. Bunu kullanmak için , 'Adı'nda' alanının seçilmesi gerekir

Döndürülenler

Kitaplık şablonunu açıklayan bir JSON nesnesi

Body
LibraryDocumentCreationResponseV6

Belge URL'sinden kitaplık şablonu oluşturma (Eski) [KULLANIM DIŞI]

İşlem Kimliği:
CreateLibraryDocumentByUrl

Bu işlem, belge URL'sinden Adobe Acrobat Sign kitaplığında bir şablon oluşturur. Sözleşme göndermek için bu şablonu kullanın

Parametreler

Name Anahtar Gerekli Tür Description
Şablon Adı
 name True string

Şablonu tanımlamak için kullanılan Sözleşme Adı
Şablon Türü
 libraryTemplateTypes True string

Bir veya daha fazla kitaplık şablonu türünün listesi
Ile paylaş
 librarySharingMode True string

Bu kitaplık belgesine kimlerin erişimi olması gerektiğini belirtir
URL
 url True string

Belgeyi almak için genel olarak erişilebilir bir URL
İsim
 name True string

Uzantılı başvuruda bulunan belgenin adı
URL (2)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (2)
 name string

Uzantılı başvuruda bulunan belgenin adı
URL (3)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (3)
 name string

Uzantılı başvuruda bulunan belgenin adı
URL (4)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (4)
 name string

Uzantılı başvuruda bulunan belgenin adı
URL (5)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (5)
 name string

Uzantılı başvuruda bulunan belgenin adı
URL (6)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (6)
 name string

Uzantılı başvuruda bulunan belgenin adı
URL (7)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (7)
 name string

Uzantılı başvuruda bulunan belgenin adı
URL (8)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (8)
 name string

Uzantılı başvuruda bulunan belgenin adı
URL (9)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (9)
 name string

Uzantılı başvuruda bulunan belgenin adı
URL (10)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (10)
 name string

Uzantılı başvuruda bulunan belgenin adı

Döndürülenler

Kitaplık şablonunu açıklayan bir JSON nesnesi

Body
LibraryDocumentCreationResponse

Belge URL'sinden sözleşme oluşturma ve imza için gönderme

İşlem Kimliği:
CreateAgreementByUrl_V2

Bu işlem, Adobe Acrobat Sign'a yüklenen bir belgeden bir sözleşme oluşturur ve imza için gönderir.

Parametreler

Name Anahtar Gerekli Tür Description
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Sözleşme Adı
 name True string

Sözleşmenin adı
URL
 url True string

Ham dosya içeriğini almak için genel olarak erişilebilir bir URL
İsim
 name True string

Gönderilen belgenin özgün sistem dosya adı
Türü
 mimeType True string

Başvuruda bulunılan dosyanın mime türü; örneğin, uygulama/pdf
İmza Türü
 signatureType True string

İstenen İmza türünü belirtir - E-imza veya Yazılı
E-posta
 email True string

Katılımcının e-posta adresi
Authentication
 authenticationMethod string

Varsayılan kimlik doğrulaması: e-posta (Yok)
Şifre
 password string

Katılımcı için gereken parola
Ülke Kodu
 countryCode string

Belgeyi görüntülemek ve imzalamak için gereken alıcının telefon ülke kodu
Telefon No.
 phone string

Sözleşmeyi görüntülemek ve imzalamak için gereken alıcının telefon numarası
Sağlayıcı Kimliği
 providerId string

Dijital Kimlik Ağ Geçidi Sağlayıcı Kimliği.
Sipariş
 order True integer

1 ile başlayan ve imzalama grubunun imzalaması gereken konumu gösteren dizin.
Rol
 role True string

Katılımcı kümesinin geçerli rolleri (imzalayan, onaylayan vb.).
Grup Adı/Kimliği
 groupId string

Grubun kimliği. Bunu kullanmak için , 'Adı'nda' alanının seçilmesi gerekir
Message
 message string

Alıcılara eylemlerini isteyen isteğe bağlı bir ileti
Gönderme Türü
 sendType string

Kaynak tarafından sözleşme göndermek için kullanılan deneyim türü
E-posta
 email string

Sözleşmenin BILGI e-postası
Süre Sonu Süresi
 expirationTime string

Sözleşmenin sona erdiği süre. Örnek: 2020-12-31T23:59:00Z
Dış Kimlik
 externalId string

Sisteminizden rastgele bir değer
Anımsatıcı Sıklığı
 reminderFrequency string

Anımsatıcıları ne sıklıkta göndermek istiyorsunuz?
Belge Parolası
 openPassword string

İmzalanan sözleşme PDF'sini şifrelemek için kullanılması gereken parola
İsim
 fieldName string

Alanın adı
Değer
 defaultValue string

Alanın varsayılan değeri
Yeniden Yönlendirme Gecikmesi
 redirectDelay string

Kullanıcı başarı sayfasına alınmadan önceki gecikme (saniye olarak).
Yeniden yönlendirme URL'si
 redirectUrl string

İmzalama işlemini tamamladıktan sonra yeniden yönlendirme url'si, örneğin. https://adobe.com
İlk E-postalar
 initEmails string

Sözleşme başlatma olayları için bildirim postalarını denetleme.
Devlet
 state True string

Sözleşmenin inmesi gereken eyalet.

Döndürülenler

Yeni oluşturulan sözleşmenin kimliğini içeren bir JSON

Body
AgreementCreationResponseV6

Belge URL'sinden sözleşme oluşturma ve imza için gönderme (Eski) [KULLANIM DIŞI]

İşlem Kimliği:
CreateAgreementByUrl

Bu işlem, Adobe Acrobat Sign'a yüklenen bir belgeden bir sözleşme oluşturur ve imza için gönderir.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Adı
 name True string

Sözleşmenin adı
URL
 url True string

Belgeyi almak için genel olarak erişilebilir bir URL
İsim
 name True string

Uzantılı başvuruda bulunan belgenin adı
İmza Türü
 signatureType True string

İstemek istediğiniz imza türü - E-imza veya Yazılı
Alıcı E-postası
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü
 recipientSetRole True string

Alıcının rolünü belirtin
Message
 message string

Alıcılara eylemlerini isteyen isteğe bağlı bir ileti
Son Tarihe Kadar Olan Günler
 daysUntilSigningDeadline integer

Belgenin süresi dolmadan önce kalan gün sayısı
Anımsatıcı Sıklığı
 reminderFrequency string

Anımsatıcıları ne sıklıkta göndermek istiyorsunuz?
Belge Parolası
 openPassword string

İmzalanan sözleşme PDF'sini şifrelemek için kullanılması gereken parola
URL (2)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (2)
 name string

Uzantılı başvuruda bulunan belgenin adı
URL (3)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (3)
 name string

Uzantılı başvuruda bulunan belgenin adı
URL (4)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (4)
 name string

Uzantılı başvuruda bulunan belgenin adı
URL (5)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (5)
 name string

Uzantılı başvuruda bulunan belgenin adı
URL (6)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (6)
 name string

Uzantılı başvuruda bulunan belgenin adı
URL (7)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (7)
 name string

Uzantılı başvuruda bulunan belgenin adı
URL (8)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (8)
 name string

Uzantılı başvuruda bulunan belgenin adı
URL (9)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (9)
 name string

Uzantılı başvuruda bulunan belgenin adı
URL (10)
 url string

Belgeyi almak için genel olarak erişilebilir bir URL
Ad (10)
 name string

Uzantılı başvuruda bulunan belgenin adı
Alıcı E-postası (2)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (2)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (2)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (3)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (3)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (3)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (4)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (4)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (4)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (5)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (5)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (5)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (6)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (6)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (6)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (7)
 email True string

Alıcının e-posta adresi
Alıcı İmza Siparişi (7)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (7)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (8)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (8)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (8)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (9)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (9)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (9)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (10)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (10)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (10)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (11)
 email True string

Alıcının e-posta adresi
Alıcı İmzaLama Siparişi (11)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (11)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (12)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (12)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (12)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (13)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (13)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (13)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (14)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (14)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (14)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (15)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (15)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (15)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (16)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Siparişi (16)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (16)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (17)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (17)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (17)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (18)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Siparişi (18)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (18)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (19)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (19)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (19)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (20)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (20)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (20)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (21)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (21)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (21)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (22)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (22)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (22)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (23)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (23)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (23)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (24)
 email True string

Alıcının e-posta adresi
Alıcı İmzaLama Siparişi (24)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (24)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (25)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (25)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (25)
 recipientSetRole True string

Alıcının rolünü belirtin
Form Alan Adı (1)
 fieldName string

Alanın adı
Form Alanı Değeri (1)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (2)
 fieldName string

Alanın adı
Form Alanı Değeri (2)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (3)
 fieldName string

Alanın adı
Form Alanı Değeri (3)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (4)
 fieldName string

Alanın adı
Form Alanı Değeri (4)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (5)
 fieldName string

Alanın adı
Form Alanı Değeri (5)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (6)
 fieldName string

Alanın adı
Form Alanı Değeri (6)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (7)
 fieldName string

Alanın adı
Form Alanı Değeri (7)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (8)
 fieldName string

Alanın adı
Form Alanı Değeri (8)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (9)
 fieldName string

Alanın adı
Form Alanı Değeri (9)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (10)
 fieldName string

Alanın adı
Form Alanı Değeri (10)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (11)
 fieldName string

Alanın adı
Form Alanı Değeri (11)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (12)
 fieldName string

Alanın adı
Form Alanı Değeri (12)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (13)
 fieldName string

Alanın adı
Form Alanı Değeri (13)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (14)
 fieldName string

Alanın adı
Form Alanı Değeri (14)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (15)
 fieldName string

Alanın adı
Form Alanı Değeri (15)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (16)
 fieldName string

Alanın adı
Form Alanı Değeri (16)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (17)
 fieldName string

Alanın adı
Form Alanı Değeri (17)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (18)
 fieldName string

Alanın adı
Form Alanı Değeri (18)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (19)
 fieldName string

Alanın adı
Form Alanı Değeri (19)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (20)
 fieldName string

Alanın adı
Form Alanı Değeri (20)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (21)
 fieldName string

Alanın adı
Form Alanı Değeri (21)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (22)
 fieldName string

Alanın adı
Form Alanı Değeri (22)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (23)
 fieldName string

Alanın adı
Form Alanı Değeri (23)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (24)
 fieldName string

Alanın adı
Form Alanı Değeri (24)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (25)
 fieldName string

Alanın adı
Form Alanı Değeri (25)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (26)
 fieldName string

Alanın adı
Form Alanı Değeri (26)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (27)
 fieldName string

Alanın adı
Form Alanı Değeri (27)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (28)
 fieldName string

Alanın adı
Form Alanı Değeri (28)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (29)
 fieldName string

Alanın adı
Form Alanı Değeri (29)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (30)
 fieldName string

Alanın adı
Form Alanı Değeri (30)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (31)
 fieldName string

Alanın adı
Form Alanı Değeri (31)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (32)
 fieldName string

Alanın adı
Form Alanı Değeri (32)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (33)
 fieldName string

Alanın adı
Form Alanı Değeri (33)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (34)
 fieldName string

Alanın adı
Form Alanı Değeri (34)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (35)
 fieldName string

Alanın adı
Form Alanı Değeri (35)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (36)
 fieldName string

Alanın adı
Form Alanı Değeri (36)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (37)
 fieldName string

Alanın adı
Form Alanı Değeri (37)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (38)
 fieldName string

Alanın adı
Form Alanı Değeri (38)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (39)
 fieldName string

Alanın adı
Form Alanı Değeri (39)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (40)
 fieldName string

Alanın adı
Form Alanı Değeri (40)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (41)
 fieldName string

Alanın adı
Form Alanı Değeri (41)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (42)
 fieldName string

Alanın adı
Form Alanı Değeri (42)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (43)
 fieldName string

Alanın adı
Form Alanı Değeri (43)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (44)
 fieldName string

Alanın adı
Form Alanı Değeri (44)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (45)
 fieldName string

Alanın adı
Form Alanı Değeri (45)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (46)
 fieldName string

Alanın adı
Form Alanı Değeri (46)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (47)
 fieldName string

Alanın adı
Form Alanı Değeri (47)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (48)
 fieldName string

Alanın adı
Form Alanı Değeri (48)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (49)
 fieldName string

Alanın adı
Form Alanı Değeri (49)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (50)
 fieldName string

Alanın adı
Form Alanı Değeri (50)
 defaultValue string

Alanın varsayılan değeri

Döndürülenler

Yeni oluşturulan sözleşmenin kimliğini içeren bir JSON

Body
AgreementCreationResponse

Belgeyi karşıya yükleme ve belge kimliği alma (Eski) [KULLANIM DIŞI]

İşlem Kimliği:
CreateTransientDocument

Bu işlem, Adobe Acrobat Sign hesabınıza bir belge yükler ve bunun için bir belge kimliği döndürür. Bu belge geçici olarak Adobe Acrobat Sign'da depolanır ve belge kimliği sözleşme oluşturma gibi diğer işlemler için kullanılabilir.

Parametreler

Name Anahtar Gerekli Tür Description
Dosya Adı
 File-Name True string

Karşıya yüklenecek belgenin adı, uzantılı
Dosya İçeriği
 File True contentOnly

Karşıya yüklenecek belgenin dosya akışı

Döndürülenler

Karşıya yüklenen belgenin kimliğini içeren bir JSON

Body
TransientDocumentResponse

Belgeyi karşıya yükleme ve belge kimliğini alma

İşlem Kimliği:
CreateTransientDocument_V2

Bu işlem, Adobe Acrobat Sign hesabınıza bir belge yükler ve bunun için bir belge kimliği döndürür. Bu belge geçici olarak Adobe Acrobat Sign'da depolanır ve belge kimliği sözleşme oluşturma gibi diğer işlemler için kullanılabilir.

Parametreler

Name Anahtar Gerekli Tür Description
Dosya Adı
 File-Name True string

Karşıya yüklenecek belgenin adı, uzantılı
Dosya İçeriği
 File True contentOnly

Karşıya yüklenecek belgenin dosya akışı
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com

Döndürülenler

Karşıya yüklenen belgenin kimliğini içeren bir JSON

Body
TransientDocumentResponse

bir iş akışından sözleşme oluşturma ve imza için gönderme

İşlem Kimliği:
CreateAgreementFromWorkflow

Bu işlem, Adobe Acrobat Sign'daki bir iş akışından bir sözleşme oluşturur ve imza için gönderir.

Parametreler

Name Anahtar Gerekli Tür Description
adıyla
 x-api-user True string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Grup Adı/Kimliği
 groupId True string

Grubun kimliği. Bunu kullanmak için , 'Adı'nda' alanının seçilmesi gerekir
İş Akışı Adı/Kimliği
 workflowIdParam True string

Listeden özel iş akışı seçin veya özel iş akışı kimliğini girin.
agreementWorkflowSchema
 agreementWorkflowSchema True dynamic

Seçili olayın ayrıntıları.

Döndürülenler

Yeni oluşturulan sözleşmenin kimliğini içeren bir JSON

Body
AgreementCreationResponseV6

Dosya içeriğinden sözleşme oluşturma ve imza için gönderme

İşlem Kimliği:
CreateAgreementByFileStream

Bu işlem, Adobe Acrobat Sign'daki bir dosyadan bir sözleşme oluşturur ve imza için gönderir.

Parametreler

Name Anahtar Gerekli Tür Description
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Sözleşme Adı
 name True string

Sözleşmenin adı
İsim
 fileName True string

Karşıya yüklenecek belgenin adı, uzantılı
Content
 formData True byte

Karşıya yüklenecek belgenin dosya akışı
İmza Türü
 signatureType True string

İstemek istediğiniz imza türü - e-imza veya yazılmış
E-posta
 email True string

Katılımcının e-posta adresi
Authentication
 authenticationMethod string

Varsayılan kimlik doğrulaması: e-posta (Yok)
Şifre
 password string

Katılımcı için gereken parola
Ülke Kodu
 countryCode string

Belgeyi görüntülemek ve imzalamak için gereken alıcının telefon ülke kodu
Telefon No.
 phone string

Sözleşmeyi görüntülemek ve imzalamak için gereken alıcının telefon numarası
Sağlayıcı Kimliği
 providerId string

Dijital Kimlik Ağ Geçidi Sağlayıcı Kimliği.
Sipariş
 order True integer

1 ile başlayan ve imzalama grubunun imzalaması gereken konumu gösteren dizin.
Rol
 role True string

Katılımcı kümesinin geçerli rolleri (imzalayan, onaylayan vb.).
Grup Adı/Kimliği
 groupId string

Grubun kimliği. Bunu kullanmak için , 'Adı'nda' alanının seçilmesi gerekir
Message
 message string

Alıcılara eylemlerini isteyen isteğe bağlı bir ileti
Gönderme Türü
 sendType string

Kaynak tarafından sözleşme göndermek için kullanılan deneyim türü
E-posta
 email string

Sözleşmenin BILGI e-postası
Süre Sonu Süresi
 expirationTime string

Sözleşmenin sona erdiği süre. Örnek: 2020-12-31T23:59:00Z
Dış Kimlik
 externalId string

Sisteminizden rastgele bir değer
Anımsatıcı Sıklığı
 reminderFrequency string

Anımsatıcıları ne sıklıkta göndermek istiyorsunuz?
Belge Parolası
 openPassword string

İmzalanan sözleşme PDF'sini şifrelemek için kullanılması gereken parola
İsim
 fieldName string

Alanın adı
Değer
 defaultValue string

Alanın varsayılan değeri
Yeniden Yönlendirme Gecikmesi
 redirectDelay string

Kullanıcı başarı sayfasına alınmadan önceki gecikme (saniye olarak).
Yeniden yönlendirme URL'si
 redirectUrl string

İmzalama işlemini tamamladıktan sonra yeniden yönlendirme url'si, örneğin. https://adobe.com
İlk E-postalar
 initEmails string

Sözleşme başlatma olayları için bildirim postalarını denetleme.
Devlet
 state True string

Sözleşmenin inmesi gereken eyalet.

Döndürülenler

Yeni oluşturulan sözleşmenin kimliğini içeren bir JSON

Body
AgreementCreationResponseV6

İmzalama URL'sini alma

İşlem Kimliği:
GetSigningUrls

Bu işlem, bir sözleşmenin geçerli imzalayanları için e-imza sayfasının URL'sini alır.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Kimliği
 agreementId True string

Sözleşmeyi oluşturan eylem tarafından sağlanan sözleşme kimliği
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com

Döndürülenler

Body
SigningUrlResponse

İmzalı sözleşmenin PDF'sini alma

İşlem Kimliği:
GetCombinedDocument_V2

Bu işlem, birleştirilmiş veya imzalanmış sözleşmenin PDF dosya akışını getirir. Dosya akışının .pdf dosya uzantısıyla biten bir dosya adıyla depolanması gerektiğini unutmayın.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Kimliği
 agreementId True string

Sözleşmeyi oluşturan eylem tarafından sağlanan sözleşme kimliği
Destekleyici Belgeler eklensin mi?
 attachSupportingDocuments boolean

Doğruysa, imzalanan sözleşme PDF'sine destekleyici belgeler ekleyin
Denetim Raporu Eklensin mi?
 attachAuditReport boolean

Doğruysa, imzalanan sözleşme PDF'sine bir denetim raporu ekleyin
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com

Döndürülenler

Belgenin dosya akışı

response
CombinedDocumentResponse

İmzalı sözleşmenin PDF'sini alma [KULLANIM DIŞI]

İşlem Kimliği:
GetCombinedDocument

Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine imzalı bir sözleşmenin PDF'sini alın'ı kullanın.

Bu işlem, birleştirilmiş veya imzalanmış sözleşmenin PDF dosya akışını getirir. Dosya akışının .pdf dosya uzantısıyla biten bir dosya adıyla depolanması gerektiğini unutmayın.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Kimliği
 agreementId True string

Sözleşmeyi oluşturan eylem tarafından sağlanan sözleşme kimliği
Destekleyici Belgeler eklensin mi?
 attachSupportingDocuments boolean

Doğruysa, imzalanan sözleşme PDF'sine destekleyici belgeler ekleyin
Denetim Raporu Eklensin mi?
 auditReport boolean

Doğruysa, imzalanan sözleşme PDF'sine bir denetim raporu ekleyin

Döndürülenler

Belgenin dosya akışı

response
CombinedDocumentResponse

İş akışının ayrıntılı bilgilerini alma

İşlem Kimliği:
GetWorkflowInfo

Bu işlem, iş akışıyla ilgili ayrıntılı bilgi parçalarını getirir.

Parametreler

Name Anahtar Gerekli Tür Description
İş Akışı Kimliği
 workflowId True string

Bilgileri gereken iş akışının iş akışı kimliği
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Grup Adı/Kimliği
 groupId string

Grubun kimliği. Bunu kullanmak için , 'Adı'nda' alanının seçilmesi gerekir

Döndürülenler

İş akışı hakkında ayrıntılı bilgi içeren bir JSON

Body
WorkflowDescriptionV6

Karşıya yüklenen bir belgeden kitaplık şablonu oluşturma

İşlem Kimliği:
CreateLibraryDocumentById_V2

Bu işlem, karşıya yüklenen bir belgeden Adobe Acrobat Sign kitaplığında bir şablon oluşturur. Sözleşme göndermek için bu şablonu kullanın.

Parametreler

Name Anahtar Gerekli Tür Description
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Şablon Adı
 name True string

Şablonu tanımlamak için kullanılan Sözleşme Adı
Şablon Türü
 templateTypes True array of string

Bir veya daha fazla kitaplık şablonu türünün listesi
Paylaşım Modu
 sharingMode True string

Bu kitaplık belgesine kimlerin erişimi olması gerektiğini belirtir
Kimlik
 transientDocumentId True string

Geçici bir belge karşıya yüklenerek alınan belge kimliği
Şablon Durumu
 state True string

Kitaplık belgesinin durumu.
Grup Adı/Kimliği
 groupId string

Grubun kimliği. Bunu kullanmak için , 'Adı'nda' alanının seçilmesi gerekir

Döndürülenler

Kitaplık şablonunu açıklayan bir JSON nesnesi

Body
LibraryDocumentCreationResponseV6

Karşıya yüklenen bir belgeden kitaplık şablonu oluşturma (Eski) [KULLANIM DIŞI]

İşlem Kimliği:
CreateLibraryDocumentById

Bu işlem, karşıya yüklenen bir belgeden Adobe Acrobat Sign kitaplığında bir şablon oluşturur. Sözleşme göndermek için bu şablonu kullanın.

Parametreler

Name Anahtar Gerekli Tür Description
Şablon Adı
 name True string

Şablonu tanımlamak için kullanılan Sözleşme Adı
Şablon Türü
 libraryTemplateTypes True string

Bir veya daha fazla kitaplık şablonu türünün listesi
Ile paylaş
 librarySharingMode True string

Bu kitaplık belgesine kimlerin erişimi olması gerektiğini belirtir
Belge Kimliği
 transientDocumentId True string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (2)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (3)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (4)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (5)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (6)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (7)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (8)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (9)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (10)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği

Döndürülenler

Kitaplık şablonunu açıklayan bir JSON nesnesi

Body
LibraryDocumentCreationResponse

Karşıya yüklenen bir belgeden sözleşme oluşturma ve imza için gönderme

İşlem Kimliği:
CreateAgreementById_V2

Bu işlem, Adobe Acrobat Sign'a yüklenen bir belgeden bir sözleşme oluşturur ve imza için gönderir.

Parametreler

Name Anahtar Gerekli Tür Description
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Sözleşme Adı
 name True string

Sözleşmenin adı
Kimlik
 transientDocumentId True string

Geçici bir belge karşıya yüklenerek alınan belge kimliği
İmza Türü
 signatureType True string

İstemek istediğiniz imza türü - e-imza veya yazılmış
E-posta
 email True string

Katılımcının e-posta adresi
Authentication
 authenticationMethod string

Varsayılan kimlik doğrulaması: e-posta (Yok)
Şifre
 password string

Katılımcı için gereken parola
Ülke Kodu
 countryCode string

Belgeyi görüntülemek ve imzalamak için gereken alıcının telefon ülke kodu
Telefon No.
 phone string

Sözleşmeyi görüntülemek ve imzalamak için gereken alıcının telefon numarası
Sağlayıcı Kimliği
 providerId string

Dijital Kimlik Ağ Geçidi Sağlayıcı Kimliği.
Sipariş
 order True integer

1 ile başlayan ve imzalama grubunun imzalaması gereken konumu gösteren dizin.
Rol
 role True string

Katılımcı kümesinin geçerli rolleri (imzalayan, onaylayan vb.).
Grup Adı/Kimliği
 groupId string

Grubun kimliği. Bunu kullanmak için , 'Adı'nda' alanının seçilmesi gerekir
Message
 message string

Alıcılara eylemlerini isteyen isteğe bağlı bir ileti
Gönderme Türü
 sendType string

Kaynak tarafından sözleşme göndermek için kullanılan deneyim türü
E-posta
 email string

Sözleşmenin BILGI e-postası
Süre Sonu Süresi
 expirationTime string

Sözleşmenin sona erdiği süre. Örnek: 2020-12-31T23:59:00Z
Dış Kimlik
 externalId string

Sisteminizden rastgele bir değer
Anımsatıcı Sıklığı
 reminderFrequency string

Anımsatıcıları ne sıklıkta göndermek istiyorsunuz?
Belge Parolası
 openPassword string

İmzalanan sözleşme PDF'sini şifrelemek için kullanılması gereken parola
İsim
 fieldName string

Alanın adı
Değer
 defaultValue string

Alanın varsayılan değeri
Yeniden Yönlendirme Gecikmesi
 redirectDelay string

Kullanıcı başarı sayfasına alınmadan önceki gecikme (saniye olarak).
Yeniden yönlendirme URL'si
 redirectUrl string

İmzalama işlemini tamamladıktan sonra yeniden yönlendirme url'si, örneğin. https://adobe.com
İlk E-postalar
 initEmails string

Sözleşme başlatma olayları için bildirim postalarını denetleme.
Devlet
 state True string

Sözleşmenin inmesi gereken eyalet.

Döndürülenler

Yeni oluşturulan sözleşmenin kimliğini içeren bir JSON

Body
AgreementCreationResponseV6

Karşıya yüklenen bir belgeden sözleşme oluşturma ve imza için gönderme (Eski) [KULLANIM DIŞI]

İşlem Kimliği:
CreateAgreementById

Bu işlem, Adobe Acrobat Sign'a yüklenen bir belgeden bir sözleşme oluşturur ve imza için gönderir.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Adı
 name True string

Sözleşmenin adı
Belge Kimliği
 transientDocumentId True string

Belge karşıya yüklenerek alınan belge kimliği
İmza Türü
 signatureType True string

İstemek istediğiniz imza türü - E-imza veya Yazılı
Alıcı E-postası
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü
 recipientSetRole True string

Alıcının rolünü belirtin
Message
 message string

Alıcılara eylemlerini isteyen isteğe bağlı bir ileti
Son Tarihe Kadar Olan Günler
 daysUntilSigningDeadline integer

Belgenin süresi dolmadan önce kalan gün sayısı
Anımsatıcı Sıklığı
 reminderFrequency string

Anımsatıcıları ne sıklıkta göndermek istiyorsunuz?
Belge Parolası
 openPassword string

İmzalanan sözleşme PDF'sini şifrelemek için kullanılması gereken parola
Belge Kimliği (2)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (3)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (4)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (5)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (6)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (7)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (8)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (9)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Belge Kimliği (10)
 transientDocumentId string

Belge karşıya yüklenerek alınan belge kimliği
Alıcı E-postası (2)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (2)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (2)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (3)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (3)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (3)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (4)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (4)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (4)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (5)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (5)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (5)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (6)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (6)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (6)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (7)
 email True string

Alıcının e-posta adresi
Alıcı İmza Siparişi (7)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (7)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (8)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (8)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (8)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (9)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (9)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (9)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (10)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (10)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (10)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (11)
 email True string

Alıcının e-posta adresi
Alıcı İmzaLama Siparişi (11)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (11)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (12)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (12)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (12)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (13)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (13)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (13)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (14)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (14)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (14)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (15)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (15)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (15)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (16)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Siparişi (16)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (16)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (17)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (17)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (17)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (18)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Siparişi (18)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (18)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (19)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (19)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (19)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (20)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (20)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (20)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (21)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (21)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (21)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (22)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (22)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (22)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (23)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (23)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (23)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (24)
 email True string

Alıcının e-posta adresi
Alıcı İmzaLama Siparişi (24)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (24)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (25)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (25)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (25)
 recipientSetRole True string

Alıcının rolünü belirtin
Form Alan Adı (1)
 fieldName string

Alanın adı
Form Alanı Değeri (1)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (2)
 fieldName string

Alanın adı
Form Alanı Değeri (2)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (3)
 fieldName string

Alanın adı
Form Alanı Değeri (3)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (4)
 fieldName string

Alanın adı
Form Alanı Değeri (4)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (5)
 fieldName string

Alanın adı
Form Alanı Değeri (5)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (6)
 fieldName string

Alanın adı
Form Alanı Değeri (6)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (7)
 fieldName string

Alanın adı
Form Alanı Değeri (7)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (8)
 fieldName string

Alanın adı
Form Alanı Değeri (8)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (9)
 fieldName string

Alanın adı
Form Alanı Değeri (9)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (10)
 fieldName string

Alanın adı
Form Alanı Değeri (10)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (11)
 fieldName string

Alanın adı
Form Alanı Değeri (11)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (12)
 fieldName string

Alanın adı
Form Alanı Değeri (12)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (13)
 fieldName string

Alanın adı
Form Alanı Değeri (13)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (14)
 fieldName string

Alanın adı
Form Alanı Değeri (14)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (15)
 fieldName string

Alanın adı
Form Alanı Değeri (15)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (16)
 fieldName string

Alanın adı
Form Alanı Değeri (16)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (17)
 fieldName string

Alanın adı
Form Alanı Değeri (17)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (18)
 fieldName string

Alanın adı
Form Alanı Değeri (18)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (19)
 fieldName string

Alanın adı
Form Alanı Değeri (19)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (20)
 fieldName string

Alanın adı
Form Alanı Değeri (20)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (21)
 fieldName string

Alanın adı
Form Alanı Değeri (21)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (22)
 fieldName string

Alanın adı
Form Alanı Değeri (22)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (23)
 fieldName string

Alanın adı
Form Alanı Değeri (23)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (24)
 fieldName string

Alanın adı
Form Alanı Değeri (24)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (25)
 fieldName string

Alanın adı
Form Alanı Değeri (25)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (26)
 fieldName string

Alanın adı
Form Alanı Değeri (26)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (27)
 fieldName string

Alanın adı
Form Alanı Değeri (27)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (28)
 fieldName string

Alanın adı
Form Alanı Değeri (28)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (29)
 fieldName string

Alanın adı
Form Alanı Değeri (29)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (30)
 fieldName string

Alanın adı
Form Alanı Değeri (30)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (31)
 fieldName string

Alanın adı
Form Alanı Değeri (31)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (32)
 fieldName string

Alanın adı
Form Alanı Değeri (32)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (33)
 fieldName string

Alanın adı
Form Alanı Değeri (33)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (34)
 fieldName string

Alanın adı
Form Alanı Değeri (34)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (35)
 fieldName string

Alanın adı
Form Alanı Değeri (35)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (36)
 fieldName string

Alanın adı
Form Alanı Değeri (36)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (37)
 fieldName string

Alanın adı
Form Alanı Değeri (37)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (38)
 fieldName string

Alanın adı
Form Alanı Değeri (38)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (39)
 fieldName string

Alanın adı
Form Alanı Değeri (39)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (40)
 fieldName string

Alanın adı
Form Alanı Değeri (40)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (41)
 fieldName string

Alanın adı
Form Alanı Değeri (41)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (42)
 fieldName string

Alanın adı
Form Alanı Değeri (42)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (43)
 fieldName string

Alanın adı
Form Alanı Değeri (43)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (44)
 fieldName string

Alanın adı
Form Alanı Değeri (44)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (45)
 fieldName string

Alanın adı
Form Alanı Değeri (45)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (46)
 fieldName string

Alanın adı
Form Alanı Değeri (46)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (47)
 fieldName string

Alanın adı
Form Alanı Değeri (47)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (48)
 fieldName string

Alanın adı
Form Alanı Değeri (48)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (49)
 fieldName string

Alanın adı
Form Alanı Değeri (49)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (50)
 fieldName string

Alanın adı
Form Alanı Değeri (50)
 defaultValue string

Alanın varsayılan değeri

Döndürülenler

Yeni oluşturulan sözleşmenin kimliğini içeren bir JSON

Body
AgreementCreationResponse

Kitaplık şablonundan sözleşme oluşturma ve imza için gönderme

İşlem Kimliği:
CreateAgreementByTemplate_V2

Bu işlem, kullanıcının Adobe Acrobat Sign kitaplığında depolanan bir şablondan bir sözleşme oluşturur ve imza için gönderir.

Parametreler

Name Anahtar Gerekli Tür Description
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Sözleşme Adı
 name True string

Sözleşmenin adı
Template
 libraryDocumentId True string

Kitaplığınızda depolanan şablonlardan bir belge seçin
İmza Türü
 signatureType True string

İstemek istediğiniz imza türü - e-imza veya yazılmış
E-posta
 email True string

Katılımcının e-posta adresi
Authentication
 authenticationMethod string

Varsayılan kimlik doğrulaması: e-posta (Yok)
Şifre
 password string

Katılımcı için gereken parola
Ülke Kodu
 countryCode string

Belgeyi görüntülemek ve imzalamak için gereken alıcının telefon ülke kodu
Telefon No.
 phone string

Sözleşmeyi görüntülemek ve imzalamak için gereken alıcının telefon numarası
Sağlayıcı Kimliği
 providerId string

Dijital Kimlik Ağ Geçidi Sağlayıcı Kimliği.
Sipariş
 order True integer

1 ile başlayan ve imzalama grubunun imzalaması gereken konumu gösteren dizin.
Rol
 role True string

Katılımcı kümesinin geçerli rolleri (imzalayan, onaylayan vb.).
Grup Adı/Kimliği
 groupId string

Grubun kimliği. Bunu kullanmak için , 'Adı'nda' alanının seçilmesi gerekir
Message
 message string

Alıcılara eylemlerini isteyen isteğe bağlı bir ileti
Gönderme Türü
 sendType string

Kaynak tarafından sözleşme göndermek için kullanılan deneyim türü
E-posta
 email string

Sözleşmenin BILGI e-postası
Süre Sonu Süresi
 expirationTime string

Sözleşmenin sona erdiği süre. Örnek: 2020-12-31T23:59:00Z
Dış Kimlik
 externalId string

Sisteminizden rastgele bir değer
Anımsatıcı Sıklığı
 reminderFrequency string

Anımsatıcıları ne sıklıkta göndermek istiyorsunuz?
Belge Parolası
 openPassword string

İmzalanan sözleşme PDF'sini şifrelemek için kullanılması gereken parola
İsim
 fieldName string

Alanın adı
Değer
 defaultValue string

Alanın varsayılan değeri
Yeniden Yönlendirme Gecikmesi
 redirectDelay string

Kullanıcı başarı sayfasına alınmadan önceki gecikme (saniye olarak).
Yeniden yönlendirme URL'si
 redirectUrl string

İmzalama işlemini tamamladıktan sonra yeniden yönlendirme url'si, örneğin. https://adobe.com
İlk E-postalar
 initEmails string

Sözleşme başlatma olayları için bildirim postalarını denetleme.
Devlet
 state True string

Sözleşmenin inmesi gereken eyalet.

Döndürülenler

Yeni oluşturulan sözleşmenin kimliğini içeren bir JSON

Body
AgreementCreationResponseV6

Kitaplık şablonundan sözleşme oluşturma ve imza için gönderme (Eski) [KULLANIM DIŞI]

İşlem Kimliği:
CreateAgreementByTemplate

Bu işlem, kullanıcının Adobe Acrobat Sign kitaplığında depolanan bir şablondan bir sözleşme oluşturur ve imza için gönderir.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Adı
 name True string

Sözleşmenin adı
Belge Kitaplığı Şablonu
 libraryDocumentId True string

Kitaplığınızda depolanan şablonlardan bir belge seçin
İmza Türü
 signatureType True string

İstemek istediğiniz imza türü - E-imza veya Yazılı
Alıcı E-postası
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü
 recipientSetRole True string

Alıcının rolünü belirtin
Message
 message string

Alıcılara eylemlerini isteyen isteğe bağlı bir ileti
Son Tarihe Kadar Olan Günler
 daysUntilSigningDeadline integer

Belgenin süresi dolmadan önce kalan gün sayısı
Anımsatıcı Sıklığı
 reminderFrequency string

Anımsatıcıları ne sıklıkta göndermek istiyorsunuz?
Belge Parolası
 openPassword string

İmzalanan sözleşme PDF'sini şifrelemek için kullanılması gereken parola
Belge Kitaplığı Şablonu (2)
 libraryDocumentId string

Kitaplığınızda depolanan şablonlardan bir belge seçin
Belge Kitaplığı Şablonu (3)
 libraryDocumentId string

Kitaplığınızda depolanan şablonlardan bir belge seçin
Belge Kitaplığı Şablonu (4)
 libraryDocumentId string

Kitaplığınızda depolanan şablonlardan bir belge seçin
Belge Kitaplığı Şablonu (5)
 libraryDocumentId string

Kitaplığınızda depolanan şablonlardan bir belge seçin
Belge Kitaplığı Şablonu (6)
 libraryDocumentId string

Kitaplığınızda depolanan şablonlardan bir belge seçin
Belge Kitaplığı Şablonu (7)
 libraryDocumentId string

Kitaplığınızda depolanan şablonlardan bir belge seçin
Belge Kitaplığı Şablonu (8)
 libraryDocumentId string

Kitaplığınızda depolanan şablonlardan bir belge seçin
Belge Kitaplığı Şablonu (9)
 libraryDocumentId string

Kitaplığınızda depolanan şablonlardan bir belge seçin
Belge Kitaplığı Şablonu (10)
 libraryDocumentId string

Kitaplığınızda depolanan şablonlardan bir belge seçin
Alıcı E-postası (2)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (2)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (2)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (3)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (3)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (3)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (4)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (4)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (4)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (5)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (5)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (5)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (6)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (6)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (6)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (7)
 email True string

Alıcının e-posta adresi
Alıcı İmza Siparişi (7)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (7)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (8)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (8)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (8)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (9)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (9)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (9)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (10)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (10)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (10)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (11)
 email True string

Alıcının e-posta adresi
Alıcı İmzaLama Siparişi (11)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (11)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (12)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (12)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (12)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (13)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (13)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (13)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (14)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (14)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (14)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (15)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (15)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (15)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (16)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Siparişi (16)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (16)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (17)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (17)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (17)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (18)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Siparişi (18)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (18)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (19)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (19)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (19)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (20)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (20)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (20)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (21)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (21)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (21)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (22)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (22)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (22)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (23)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (23)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (23)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (24)
 email True string

Alıcının e-posta adresi
Alıcı İmzaLama Siparişi (24)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (24)
 recipientSetRole True string

Alıcının rolünü belirtin
Alıcı E-postası (25)
 email True string

Alıcının e-posta adresi
Alıcı İmzalama Sırası (25)
 signingOrder True integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Alıcı Rolü (25)
 recipientSetRole True string

Alıcının rolünü belirtin
Form Alan Adı (1)
 fieldName string

Alanın adı
Form Alanı Değeri (1)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (2)
 fieldName string

Alanın adı
Form Alanı Değeri (2)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (3)
 fieldName string

Alanın adı
Form Alanı Değeri (3)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (4)
 fieldName string

Alanın adı
Form Alanı Değeri (4)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (5)
 fieldName string

Alanın adı
Form Alanı Değeri (5)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (6)
 fieldName string

Alanın adı
Form Alanı Değeri (6)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (7)
 fieldName string

Alanın adı
Form Alanı Değeri (7)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (8)
 fieldName string

Alanın adı
Form Alanı Değeri (8)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (9)
 fieldName string

Alanın adı
Form Alanı Değeri (9)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (10)
 fieldName string

Alanın adı
Form Alanı Değeri (10)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (11)
 fieldName string

Alanın adı
Form Alanı Değeri (11)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (12)
 fieldName string

Alanın adı
Form Alanı Değeri (12)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (13)
 fieldName string

Alanın adı
Form Alanı Değeri (13)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (14)
 fieldName string

Alanın adı
Form Alanı Değeri (14)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (15)
 fieldName string

Alanın adı
Form Alanı Değeri (15)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (16)
 fieldName string

Alanın adı
Form Alanı Değeri (16)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (17)
 fieldName string

Alanın adı
Form Alanı Değeri (17)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (18)
 fieldName string

Alanın adı
Form Alanı Değeri (18)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (19)
 fieldName string

Alanın adı
Form Alanı Değeri (19)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (20)
 fieldName string

Alanın adı
Form Alanı Değeri (20)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (21)
 fieldName string

Alanın adı
Form Alanı Değeri (21)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (22)
 fieldName string

Alanın adı
Form Alanı Değeri (22)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (23)
 fieldName string

Alanın adı
Form Alanı Değeri (23)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (24)
 fieldName string

Alanın adı
Form Alanı Değeri (24)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (25)
 fieldName string

Alanın adı
Form Alanı Değeri (25)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (26)
 fieldName string

Alanın adı
Form Alanı Değeri (26)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (27)
 fieldName string

Alanın adı
Form Alanı Değeri (27)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (28)
 fieldName string

Alanın adı
Form Alanı Değeri (28)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (29)
 fieldName string

Alanın adı
Form Alanı Değeri (29)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (30)
 fieldName string

Alanın adı
Form Alanı Değeri (30)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (31)
 fieldName string

Alanın adı
Form Alanı Değeri (31)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (32)
 fieldName string

Alanın adı
Form Alanı Değeri (32)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (33)
 fieldName string

Alanın adı
Form Alanı Değeri (33)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (34)
 fieldName string

Alanın adı
Form Alanı Değeri (34)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (35)
 fieldName string

Alanın adı
Form Alanı Değeri (35)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (36)
 fieldName string

Alanın adı
Form Alanı Değeri (36)
 defaultValue string

Alanın varsayılan değeri
Form Alan Adı (37)
 fieldName string

Alanın adı
Form Alanı Değeri (37)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (38)
 fieldName string

Alanın adı
Form Alanı Değeri (38)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (39)
 fieldName string

Alanın adı
Form Alanı Değeri (39)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (40)
 fieldName string

Alanın adı
Form Alanı Değeri (40)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (41)
 fieldName string

Alanın adı
Form Alanı Değeri (41)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (42)
 fieldName string

Alanın adı
Form Alanı Değeri (42)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (43)
 fieldName string

Alanın adı
Form Alanı Değeri (43)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (44)
 fieldName string

Alanın adı
Form Alanı Değeri (44)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (45)
 fieldName string

Alanın adı
Form Alanı Değeri (45)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (46)
 fieldName string

Alanın adı
Form Alanı Değeri (46)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (47)
 fieldName string

Alanın adı
Form Alanı Değeri (47)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (48)
 fieldName string

Alanın adı
Form Alanı Değeri (48)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (49)
 fieldName string

Alanın adı
Form Alanı Değeri (49)
 defaultValue string

Alanın varsayılan değeri
Form Alanı Adı (50)
 fieldName string

Alanın adı
Form Alanı Değeri (50)
 defaultValue string

Alanın varsayılan değeri

Döndürülenler

Yeni oluşturulan sözleşmenin kimliğini içeren bir JSON

Body
AgreementCreationResponse

Kullanıcının ait olduğu tüm grupların listesini alma

İşlem Kimliği:
GetAllUserGroups

Bu işlem, kullanıcının ait olduğu tüm grupların listesini getirir.

Parametreler

Name Anahtar Gerekli Tür Description
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Kullanıcı kimliği
 userId True string

Yetkili kullanıcının sonucunu almak için, kullanıcı kimliği tırnak işaretleri olmadan 'ben' ile değiştirilebilir.

Döndürülenler

Belirli bir kullanıcı için grupların listesini içeren bir JSON

Body
UserGroupsInfoV6

Sözleşme görünümü URL'sini alma

İşlem Kimliği:
PostAgreementViews

Sözleşmenin en son durum görünümü URL'sini alır.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Kimliği
 agreementId True string

Bilgileri gereken sözleşmenin sözleşme kimliği
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Görünüm Adı
 name True string

İstenen sözleşme görünümünün adı
Otomatik Oturum Açma
 autoLoginUser boolean

True ise, döndürülen URL kullanıcının oturumunu otomatik olarak açar
Chrome Bayrağı Yok
 noChrome boolean

True ise, eklenmiş sayfa üst bilgi veya alt bilgi olmadan gösterilir
Çerçeve Üst Öğesi
 frameParent string

URL'lerin iframe edilebileceği etki alanı URL'lerinin virgülle ayrılmış listesi

Döndürülenler

Sözleşme görünümlerinin listesi

Body
AgreementViews

Sözleşmeden belge alma

İşlem Kimliği:
GetDocument_V2

Bu işlem, sözleşmenin belirli bir belgesinin dosya akışını getirir.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Kimliği
 agreementId True string

Belgesi gereken sözleşmenin sözleşme kimliği
Belge Kimliği
 documentId True string

Sözleşmenin belirli bir belgesinin belge kimliği
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com

Döndürülenler

Belgenin dosya akışı

response
DocumentResponse

Sözleşmeden belge alma [KULLANIM DIŞI]

İşlem Kimliği:
GetDocument

Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Sözleşmeden belge al'ı kullanın.

Bu işlem, sözleşmenin belirli bir belgesinin dosya akışını getirir.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Kimliği
 agreementId True string

Belgesi gereken sözleşmenin sözleşme kimliği
Belge Kimliği
 documentId True string

Sözleşmenin belirli bir belgesinin belge kimliği

Döndürülenler

Belgenin dosya akışı

response
DocumentResponse

Sözleşmeden tüm belge kimliklerinin listesini alma

İşlem Kimliği:
GetAllDocumentsofAnAgreement_V2

Bu işlem, bir sözleşmenin tüm belgelerinin ve destekleyici belgelerinin kimliklerini getirir.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Kimliği
 agreementId True string

Belgeleri gereken sözleşmenin sözleşme kimliği
Destekleyici belgeler - İçerik Türü
 supportingDocumentContentFormat string

Sözleşmenin destekleyici belgelerinin içerik türü
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com

Döndürülenler

Hem belgeleri hem de destekleyici belgeleri içeren bir JSON dizi nesneleri

Body
AgreementDocumentsV6

Sözleşmeden tüm belge kimliklerinin listesini alma [KULLANIM DIŞI]

İşlem Kimliği:
GetAllDocumentsofAnAgreement

Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine bir sözleşmedeki tüm belge kimliklerinin listesini alın'ı kullanın.

Bu işlem, bir sözleşmenin tüm belgelerinin ve destekleyici belgelerinin kimliklerini getirir.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Kimliği
 agreementId True string

Belgeleri gereken sözleşmenin sözleşme kimliği
Destekleyici belgeler - İçerik Türü
 supportingDocumentContentFormat string

Sözleşmenin destekleyici belgelerinin içerik türü

Döndürülenler

Hem belgeleri hem de destekleyici belgeleri içeren bir JSON dizi nesneleri

Body
AgreementDocuments

Sözleşmenin denetim kaydının PDF'sini alma

İşlem Kimliği:
GetAgreementAuditTrail

Bu işlem, sözleşme denetim kaydının PDF dosya akışını getirir. Dosya akışının .pdf dosya uzantısıyla biten bir dosya adıyla depolanması gerektiğini unutmayın.

Parametreler

Name Anahtar Gerekli Tür Description
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Sözleşme Kimliği
 agreementId True string

Bilgileri gereken sözleşmenin sözleşme kimliği

Döndürülenler

Sözleşme denetim kaydının dosya akışı

response
AgreementAuditTrailResponse

Sözleşmenin durumunu alma

İşlem Kimliği:
GetAgreementInfo_V2

Bu işlem, durum gibi bir sözleşmenin tüm geçerli bilgilerini getirir.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Kimliği
 agreementId True string

Bilgileri gereken sözleşmenin sözleşme kimliği
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com

Döndürülenler

Tam Sözleşme Ayrıntıları

Body
AgreementInfoV6

Sözleşmenin durumunu alma [KULLANIM DIŞI]

İşlem Kimliği:
GetAgreementInfo

Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Bir sözleşmenin durumunu alın'ı kullanın.

Bu işlem, durum gibi bir sözleşmenin tüm geçerli bilgilerini getirir.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Kimliği
 agreementId True string

Bilgileri gereken sözleşmenin sözleşme kimliği

Döndürülenler

Sözleşme hakkındaki tüm ayrıntılar

Body
AgreementInfo

Sözleşmenin form alanı verilerini alma (Eski) [KULLANIM DIŞI]

İşlem Kimliği:
GetAgreementFormFieldData

Sözleşmenin etkileşimli form alanlarına girilen verileri alır.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Kimliği
 agreementId True string

Bilgileri gereken sözleşmenin sözleşme kimliği

Döndürülenler

response
file

Sözleşmenin form alanı verilerini CSV biçiminde alma

İşlem Kimliği:
GetAgreementFormFieldData_V2

Sözleşmenin etkileşimli form alanlarına girilen verileri alır.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Kimliği
 agreementId True string

Bilgileri gereken sözleşmenin sözleşme kimliği
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com

Döndürülenler

Form Verilerinin içeriği

Form Veri İçeriği
binary

Sözleşmenin form alanı verilerini JSON biçiminde alma

İşlem Kimliği:
GetAgreementFormFieldData_V3

Sözleşmenin etkileşimli form alanlarına girilen verileri alır.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Kimliği
 agreementId True string

Bilgileri gereken sözleşmenin sözleşme kimliği
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com

Döndürülenler

Form Verilerinin içeriği

Form Veri İçeriği
object

Sözleşmeyi iptal etme

İşlem Kimliği:
CancelAgreement

Yolda agreementId ile tanımlanan sözleşmeyi iptal eder.

Parametreler

Name Anahtar Gerekli Tür Description
Sözleşme Kimliği
 agreementId True string

İptal edilecek sözleşmenin sözleşme kimliği.
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Yeşillik Durumu
 state string

Sözleşmenin inmesi gereken eyalet.
Comment
 comment string

Alıcılara iptal nedenini açıklayan isteğe bağlı bir açıklama.
Diğer
 notifyOthers boolean

Alıcıların bilgilendirilmesini isteyip istemediğiniz.

Tüm iş akışlarının listesini alma

İşlem Kimliği:
GetAllWorkflows

Bu işlem, kullanıcının tüm iş akışlarının listesini getirir.

Parametreler

Name Anahtar Gerekli Tür Description
Taslak İş Akışlarını Dahil Et
 includeDraftWorkflows boolean

Taslak iş akışlarını dahil et
Etkin Olmayan İş Akışlarını Dahil Et
 includeInactiveWorkflows boolean

Etkin olmayan iş akışlarını dahil et
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Grup Adı/Kimliği
 groupId string

Grubun kimliği. Bunu kullanmak için , 'Adı'nda' alanının seçilmesi gerekir

Döndürülenler

Kullanıcı iş akışı dizisi nesnesini içeren bir JSON

Body
userWorkflowListV6

Tüm kitaplık şablonlarının listesini alma

İşlem Kimliği:
GetLibraryDocuments_V2

Bu işlem, kullanıcının Adobe Acrobat Sign kitaplığında şablon olarak depolanan tüm belgelerin listesini getirir.

Parametreler

Name Anahtar Gerekli Tür Description
Cursor
 cursor string

Sayfalarda gezinmek için kullanılır. Sağlanmadıysa, ilk sayfayı döndürür.
Sayfa Boyutu
 pageSize integer

Yanıt sayfasındaki öğe sayısı. Varsayılan olarak: 100; Maksimum: 10000
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Grup Adı/Kimliği
 groupId string

Grubun kimliği. Bunu kullanmak için , 'Adı'nda' alanının seçilmesi gerekir

Döndürülenler

Kitaplık şablonu dizi nesnesini içeren bir JSON

Body
LibraryDocuments

Tüm kitaplık şablonlarının listesini alma (Eski) [KULLANIM DIŞI]

İşlem Kimliği:
GetLibraryDocuments

Bu işlem, kullanıcının Adobe Acrobat Sign kitaplığında şablon olarak depolanan tüm belgelerin listesini getirir.

Döndürülenler

Kitaplık şablonu dizi nesnesini içeren bir JSON

Body
DocumentLibraryItems

Tüm sözleşmelerin listesini alma

İşlem Kimliği:
GetAllAgreements_V2

Bu işlem, kullanıcının tüm sözleşmelerinin listesini getirir.

Parametreler

Name Anahtar Gerekli Tür Description
Cursor
 cursor string

Sayfalarda gezinmek için kullanılır. Sağlanmadıysa, ilk sayfayı döndürür.
Sayfa Boyutu
 pageSize integer

Yanıt sayfasındaki öğe sayısı. Varsayılan olarak: 100; Maksimum: 10000
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Grup Adı/Kimliği
 groupId string

Grubun kimliği. Bunu kullanmak için , 'Adı'nda' alanının seçilmesi gerekir

Döndürülenler

Kullanıcı sözleşmesi dizi nesnesini içeren bir JSON

Body
userAgreementListV6

Tüm sözleşmelerin listesini alma (Eski) [KULLANIM DIŞI]

İşlem Kimliği:
GetAllAgreements

Bu işlem, kullanıcının tüm sözleşmelerinin listesini getirir.

Döndürülenler

Kullanıcı sözleşmesi dizi nesnesini içeren bir JSON

Body
UserAgreements

Tüm web formlarının listesini alma

İşlem Kimliği:
GetAllWebForms

Bu işlem, kullanıcının tüm web formlarının listesini getirir.

Parametreler

Name Anahtar Gerekli Tür Description
Cursor
 cursor string

Sayfalarda gezinmek için kullanılır. Sağlanmadıysa, ilk sayfayı döndürür.
Sayfa Boyutu
 pageSize integer

Yanıt sayfasındaki öğe sayısı. Varsayılan olarak: 100; Maksimum: 10000
adıyla
 x-api-user string

API çağıranın biçimindeki e-postası: e-posta:adobesignuser@domain.com
Grup Adı/Kimliği
 groupId string

Grubun kimliği. Bunu kullanmak için , 'Adı'nda' alanının seçilmesi gerekir

Döndürülenler

Kullanıcı web formu dizi nesnesini içeren bir JSON

Body
userWidgetListV6

Tetikleyiciler

Bir grup olayı gerçekleştiğinde

Grup olayı gerçekleştiğinde yeni bir akış tetikler. Tüm Sözleşme, Mega sign ve Web Formu olaylarını kapsar.
Bir katılımcıya sözleşme gönderildiğinde

Bir katılımcıya sözleşme gönderildiğinde yeni bir akış tetikler.
Bir olay oluştuğunda

Bir olay gerçekleştiğinde yeni bir akış tetikler. Tüm Sözleşme, Mega sign ve Web Formu olaylarını kapsar.
Bir sözleşme iş akışı başarıyla tamamlandığında

Sözleşme iş akışı başarıyla tamamlandığında yeni bir akışı tetikler
Bir sözleşmenin durumu değiştiğinde

Sözleşmenin durumu değiştiğinde yeni bir akış tetikler. Oluşturma, tamamlama vb. gibi en yaygın Sözleşme olaylarını kapsar.
Web formu sözleşmesi olayı gerçekleştiğinde

Web formu sözleşmesi olayı gerçekleştiğinde yeni bir akış tetikler. Oluşturma, tamamlama vb. gibi en yaygın Sözleşme olaylarını kapsar.
Yeni bir sözleşme oluşturulduğunda

Yeni bir anlaşma oluşturulduğunda yeni bir akış tetikler.

Bir grup olayı gerçekleştiğinde

İşlem Kimliği:
CreateWebhookForGroupEvent

Grup olayı gerçekleştiğinde yeni bir akış tetikler. Tüm Sözleşme, Mega sign ve Web Formu olaylarını kapsar.

Parametreler

Name Anahtar Gerekli Tür Description
İsim
 name True string

Tetikleyicinin adı
Grup Adı/Kimliği
 resourceId string

Grubun kimliği
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

Akışın tetiklenmesi gereken olaylar
Sözleşme Bilgileri eklensin mi?
 includeDetailedInfo boolean

Ayrıntılı sözleşme bilgileri bildirimde gönderilmeli mi?
Sözleşme KatılımcıSı Bilgileri eklensin mi?
 includeParticipantsInfo boolean

Sözleşme katılımcısı bilgileri bildirimde gönderilmeli mi?
Sözleşme Belge Bilgileri eklensin mi?
 includeDocumentsInfo boolean

Sözleşme belgesi bilgileri bildirimde gönderilsin mi?
Sözleşme İmzalı Belge Bilgileri eklensin mi?
 includeSignedDocuments boolean

Sözleşme tamamlandıktan sonra imzalanan belgenin son kopyası bildirimde gönderilmeli mi?
MegaSign Bilgileri eklensin mi?
 includeDetailedInfo boolean

Ayrıntılı mega işareti bilgileri bildirimde gönderilmeli mi?
Web Formu Bilgileri eklensin mi?
 includeDetailedInfo boolean

Ayrıntılı web formu bilgileri bildirimde gönderilsin mi?
Web Formu Katılımcı Bilgileri eklensin mi?
 includeParticipantsInfo boolean

Web formu katılımcı bilgileri bildirimde gönderilsin mi?
Web Formu Belgeleri Bilgileri eklensin mi?
 includeDocumentsInfo boolean

Web formu belge bilgileri bildirimde gönderilsin mi?

Döndürülenler

Body
GroupWebhookEventPayload

Bir katılımcıya sözleşme gönderildiğinde

İşlem Kimliği:
CreateWebhookForAgreementSignatureRequestedEvent

Bir katılımcıya sözleşme gönderildiğinde yeni bir akış tetikler.

Parametreler

Name Anahtar Gerekli Tür Description
İsim
 name True string

Tetikleyicinin adı
Scope
 scope True string

Tetikleyicinin kapsamı
Sözleşme Adı/Kimliği
 resourceId string

Yalnızca "Kapsam" "Belirli bir sözleşme" olduğunda belirtin. Listeden bir sözleşme seçin veya sözleşme kimliğini girin.
Subscription
 webhookSubscriptionEvents True array of string

Akışın tetiklenmesi gereken olaylar
Sözleşme Bilgileri eklensin mi?
 includeDetailedInfo boolean

Ayrıntılı sözleşme bilgileri bildirimde gönderilmeli mi?
Sözleşme KatılımcıSı Bilgileri eklensin mi?
 includeParticipantsInfo boolean

Sözleşme katılımcısı bilgileri bildirimde gönderilmeli mi?
Sözleşme Belge Bilgileri eklensin mi?
 includeDocumentsInfo boolean

Sözleşme belgesi bilgileri bildirimde gönderilsin mi?

Döndürülenler

Body
WebhookPayload

Bir olay oluştuğunda

İşlem Kimliği:
CreateWebhookGeneric

Bir olay gerçekleştiğinde yeni bir akış tetikler. Tüm Sözleşme, Mega sign ve Web Formu olaylarını kapsar.

Parametreler

Name Anahtar Gerekli Tür Description
İsim
 name True string

Tetikleyicinin adı
Scope
 scope True string

Tetikleyicinin kapsamı
Kaynak Türü
 resourceType string

Yalnızca "Kapsam" "Belirli bir kaynak" olduğunda belirtin. Akışın tetiklenmesi gereken kaynak türünü seçin.
Kaynak Kimliği
 resourceId string

Yalnızca "Kapsam" "Belirli bir kaynak" olduğunda belirtin. Akışın tetiklenmesi gereken sözleşmeyi veya mega işareti, web formu veya grup kimliğini girin.
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

Akışın tetiklenmesi gereken olaylar
Sözleşme Bilgileri eklensin mi?
 includeDetailedInfo boolean

Ayrıntılı sözleşme bilgileri bildirimde gönderilmeli mi?
Sözleşme KatılımcıSı Bilgileri eklensin mi?
 includeParticipantsInfo boolean

Sözleşme katılımcısı bilgileri bildirimde gönderilmeli mi?
Sözleşme Belge Bilgileri eklensin mi?
 includeDocumentsInfo boolean

Sözleşme belgesi bilgileri bildirimde gönderilsin mi?
Sözleşme İmzalı Belge Bilgileri eklensin mi?
 includeSignedDocuments boolean

Sözleşme tamamlandıktan sonra imzalanan belgenin son kopyası bildirimde gönderilmeli mi?
MegaSign Bilgileri eklensin mi?
 includeDetailedInfo boolean

Ayrıntılı mega işareti bilgileri bildirimde gönderilmeli mi?
Web Formu Bilgileri eklensin mi?
 includeDetailedInfo boolean

Ayrıntılı web formu bilgileri bildirimde gönderilsin mi?
Web Formu Katılımcı Bilgileri eklensin mi?
 includeParticipantsInfo boolean

Web formu katılımcı bilgileri bildirimde gönderilsin mi?
Web Formu Belgeleri Bilgileri eklensin mi?
 includeDocumentsInfo boolean

Web formu belge bilgileri bildirimde gönderilsin mi?

Döndürülenler

Body
WebhookPayloadGeneric

Bir sözleşme iş akışı başarıyla tamamlandığında

İşlem Kimliği:
CreateWebhookForAgreementSignedEvent

Sözleşme iş akışı başarıyla tamamlandığında yeni bir akışı tetikler

Parametreler

Name Anahtar Gerekli Tür Description
İsim
 name True string

Tetikleyicinin adı
Scope
 scope True string

Tetikleyicinin kapsamı
Sözleşme Adı/Kimliği
 resourceId string

Yalnızca "Kapsam" "Belirli bir sözleşme" olduğunda belirtin. Listeden bir sözleşme seçin veya sözleşme kimliğini girin.
Subscription
 webhookSubscriptionEvents True array of string

Akışın tetiklenmesi gereken olaylar
Sözleşme Bilgileri eklensin mi?
 includeDetailedInfo boolean

Ayrıntılı sözleşme bilgileri bildirimde gönderilmeli mi?
Sözleşme KatılımcıSı Bilgileri eklensin mi?
 includeParticipantsInfo boolean

Sözleşme katılımcısı bilgileri bildirimde gönderilmeli mi?
Sözleşme Belge Bilgileri eklensin mi?
 includeDocumentsInfo boolean

Sözleşme belgesi bilgileri bildirimde gönderilsin mi?
Sözleşme İmzalı Belge Bilgileri eklensin mi?
 includeSignedDocuments boolean

Sözleşme tamamlandıktan sonra imzalanan belgenin son kopyası bildirimde gönderilmeli mi?

Döndürülenler

Body
WebhookPayloadWithSignedDocument

Bir sözleşmenin durumu değiştiğinde

İşlem Kimliği:
CreateWebhookForAgreementStatusUpdated

Sözleşmenin durumu değiştiğinde yeni bir akış tetikler. Oluşturma, tamamlama vb. gibi en yaygın Sözleşme olaylarını kapsar.

Parametreler

Name Anahtar Gerekli Tür Description
İsim
 name True string

Tetikleyicinin adı
Scope
 scope True string

Tetikleyicinin kapsamı
Sözleşme Adı/Kimliği
 resourceId string

Yalnızca "Kapsam" "Belirli bir sözleşme" olduğunda belirtin. Listeden bir sözleşme seçin veya sözleşme kimliğini girin.
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

Akışın tetiklenmesi gereken olaylar
Sözleşme Bilgileri eklensin mi?
 includeDetailedInfo boolean

Ayrıntılı sözleşme bilgileri bildirimde gönderilmeli mi?
Sözleşme KatılımcıSı Bilgileri eklensin mi?
 includeParticipantsInfo boolean

Sözleşme katılımcısı bilgileri bildirimde gönderilmeli mi?
Sözleşme Belge Bilgileri eklensin mi?
 includeDocumentsInfo boolean

Sözleşme belgesi bilgileri bildirimde gönderilsin mi?
Sözleşme İmzalı Belge Bilgileri eklensin mi?
 includeSignedDocuments boolean

İmzalanan belgenin son kopyası, sözleşmenin tamamlanmasının bildiriminde gönderilmeli mi?

Döndürülenler

Body
WebhookPayloadWithSignedDocumentForStatusChange

Web formu sözleşmesi olayı gerçekleştiğinde

İşlem Kimliği:
CreateWebhookForWebFormAgreementEvent

Web formu sözleşmesi olayı gerçekleştiğinde yeni bir akış tetikler. Oluşturma, tamamlama vb. gibi en yaygın Sözleşme olaylarını kapsar.

Parametreler

Name Anahtar Gerekli Tür Description
İsim
 name True string

Tetikleyicinin adı
Web Forms Sayfa Boyutu
 pageSize integer

Açılan listede görüntülenecek web formlarının sayısını seçin
Web Formu Adı/Kimliği
 resourceId True string

Listeden web formu seçin veya web formu kimliğini girin.
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

Akışın tetiklenmesi gereken olaylar
Sözleşme Bilgileri eklensin mi?
 includeDetailedInfo boolean

Ayrıntılı sözleşme bilgileri bildirimde gönderilmeli mi?
Sözleşme KatılımcıSı Bilgileri eklensin mi?
 includeParticipantsInfo boolean

Sözleşme katılımcısı bilgileri bildirimde gönderilmeli mi?
Sözleşme Belge Bilgileri eklensin mi?
 includeDocumentsInfo boolean

Sözleşme belgesi bilgileri bildirimde gönderilsin mi?
Sözleşme İmzalı Belge Bilgileri eklensin mi?
 includeSignedDocuments boolean

İmzalanan belgenin son kopyası, sözleşmenin tamamlanmasının bildiriminde gönderilmeli mi?

Döndürülenler

Body
WebFormWebhookAgreementEventPayload

Yeni bir sözleşme oluşturulduğunda

İşlem Kimliği:
CreateWebhookForAgreementCreatedEvent

Yeni bir anlaşma oluşturulduğunda yeni bir akış tetikler.

Parametreler

Name Anahtar Gerekli Tür Description
İsim
 name True string

Tetikleyicinin adı
Scope
 scope True string

Tetikleyicinin kapsamı
Subscription
 webhookSubscriptionEvents True array of string

Akışın tetiklenmesi gereken olaylar
Sözleşme Bilgileri eklensin mi?
 includeDetailedInfo boolean

Ayrıntılı sözleşme bilgileri bildirimde gönderilmeli mi?
Sözleşme KatılımcıSı Bilgileri eklensin mi?
 includeParticipantsInfo boolean

Sözleşme katılımcısı bilgileri bildirimde gönderilmeli mi?

Döndürülenler

Body
WebhookPayloadWithoutNextParticipantSet

Tanımlar

AgreementCreationResponse

Yeni oluşturulan sözleşmenin kimliğini içeren bir JSON

Name Yol Tür Description
Sözleşme Kimliği
 agreementId string

Durumu sorgulamak ve imzalı belgeleri indirmek için kullanılabilecek sözleşmenin benzersiz kimliği

AgreementCreationResponseV6

Yeni oluşturulan sözleşmenin kimliğini içeren bir JSON

Name Yol Tür Description
Sözleşme Kimliği
 id string

Durumu sorgulamak ve imzalı belgeleri indirmek için kullanılabilecek sözleşmenin benzersiz kimliği

Sözleşme Belgeleri

Hem belgeleri hem de destekleyici belgeleri içeren bir JSON dizi nesneleri

Name Yol Tür Description
Documents
 documents array of Document

Belgeleri temsil eden nesnelerin listesi
Destekleyici Belgeler
 supportingDocuments array of SupportingDocument

Destekleyici belgelerin listesi. Bu, yalnızca sözleşmede herhangi bir destekleyici belge varsa döndürülür

AgreementDocumentsV6

Hem belgeleri hem de destekleyici belgeleri içeren bir JSON dizi nesneleri

Name Yol Tür Description
Documents
 documents array of DocumentV6

Belgeleri temsil eden nesnelerin listesi
Destekleyici Belgeler
 supportingDocuments array of SupportingDocumentV6

Destekleyici belgelerin listesi. Bu, yalnızca sözleşmede herhangi bir destekleyici belge varsa döndürülür

AgreementInfo

Sözleşme hakkındaki tüm ayrıntılar

Name Yol Tür Description
Sözleşme Kimliği
 agreementId string

Sözleşmeyi benzersiz olarak tanımlamak için kullanılabilecek benzersiz bir kimlik
Events
 events array of DocumentHistoryEvent

Bu belgenin denetim izindeki olayların sıralı listesi
Bitiş Tarihi
 expiration date

Sözleşmenin imzalanamayacakları tarih
En Son Sürüm Kimliği
 latestVersionId string

Sözleşmenin geçerli sürümünü benzersiz olarak tanımlayan benzersiz bir kimlik
Message
 message string

Gönderenin sağladığı sözleşmeyle ilişkili ileti
Sözleşme Adı
 name string

Gönderen tarafından belirtilen sözleşmenin adı
Sonraki Katılımcı Kümeleri
 nextParticipantSetInfos array of NextParticipantSetInfo

Bu sözleşme için bir sonraki eylemi kimin yapması gerektiği hakkında bilgi
Katılımcı Kümeleri
 participantSetInfos array of ParticipantSetInfo

Bu belgenin tüm katılımcı kümeleri hakkında bilgi
İmza Türü
 signatureType string

İstenen İmza türünü belirtir - E-imza veya Yazılı
Belge Koruması
 securityOptions string

Belgeyi görüntülemek ve imzalamak için parola gerekip gerekmediğini belirten güvenlik bilgileri
Statü
 status string

Sözleşmenin geçerli durumu

AgreementInfoV6

Tam Sözleşme Ayrıntıları

Name Yol Tür Description
Sözleşme Kimliği
 id string

Sözleşmeyi benzersiz olarak tanımlamak için kullanılabilecek benzersiz bir kimlik
Oluşturulma Tarihi
 createdDate date

Sözleşmenin oluşturulduğu tarih
İlk Anımsatıcı Gecikmesi
 firstReminderDelay integer

İlk anımsatıcıyı göndermeden önce saat cinsinden gecikmeyi belirten tamsayı.
Anımsatıcı Sıklığı
 reminderFrequency string

Anımsatıcıları ne sıklıkta göndermek istiyorsunuz?
Bitiş Tarihi
 expiration date

Sözleşmenin imzalanamayacakları tarih
Locale
 locale string

Bu sözleşmeyle ilişkilendirilmiş yerel ayar ; örneğin, en_US veya fr_FR
Message
 message string

Gönderenin sağladığı sözleşmeyle ilişkili ileti
Sözleşme Adı
 name string

Gönderen tarafından belirtilen sözleşmenin adı
Belge Görünürlüğü mü?
 documentVisibilityEnabled boolean

Belge görünürlüğü etkinleştirildi mi?
Katılımcı Kümeleri
 participantSetsInfo array of ParticipantSetInfoV6

Bu belgenin tüm katılımcı kümeleri hakkında bilgi
İmza Türü
 signatureType string

İstenen İmza türünü belirtir - E-imza veya Yazılı
Güvenlik Seçenekleri
 securityOptions string

Belgeyi görüntülemek ve imzalamak için parola gerekip gerekmediğini belirten güvenlik bilgileri
Statü
 status string

Sözleşmenin geçerli durumu
Gönderen E-postası
 senderEmail string

Gönderenin e-postası
İş Akışı Kimliği
 workflowId string

Bir sözleşmenin yönlendirme yolunu tanımlayan özel iş akışının kimliği.
Ccs
 ccs array of CcInfo

Sözleşme işleminde kopyalanacak bir veya daha fazla CC'nin listesi.
Grup Kimliği
 groupId string

Sözleşmenin ait olduğu grubun benzersiz tanımlayıcısı.

CombinedDocumentResponse

Belgenin dosya akışı

Belgenin dosya akışı

Dosya İçeriği
binary

AgreementAuditTrailResponse

Sözleşme denetim kaydının dosya akışı

Sözleşme denetim kaydının dosya akışı

Sözleşme Denetim İzi İçeriği
binary

DisplayUserInfo

Name Yol Tür Description
Şirket
 company string

Varsa, kullanıcının şirketinin adını görüntüler
E-posta
 email string

Kullanıcının e-postasını görüntüler
Adı ve Soyadı
 fullName string

Varsa kullanıcının tam adını görüntüler.

DisplayUserSetInfo

Name Yol Tür Description
Kullanıcı Kümesi Bilgilerini Görüntüle
 displayUserSetMemberInfos array of DisplayUserInfo

Kullanıcı kümesi hakkındaki bilgileri görüntüler
Kullanıcı Kümesi Adını Görüntüle
 displayUserSetName string

Belge

Belge hakkındaki bilgiler

Name Yol Tür Description
Belge Kimliği
 documentId string

Belgenin benzersiz kimliği
Mime Türü
 mimeType string

Belgenin Mime türü
İsim
 name string

Belgenin adı
Sayı Sayfaları
 numPages integer

Belgedeki sayfa sayısı

DocumentV6

Belge hakkındaki bilgiler

Name Yol Tür Description
Belge Kimliği
 id string

Belgenin benzersiz kimliği
Mime Türü
 mimeType string

Belgenin Mime türü
İsim
 name string

Belgenin adı
Sayı Sayfaları
 numPages integer

Belgedeki sayfa sayısı

DocumentHistoryEvent

Name Yol Tür Description
Olay Başlatıcısı
 actingUserEmail string

Olayı başlatan kullanıcının e-posta adresi
Olay Tarihi
 date date

Denetim olayının tarihi
Etkinlik Açıklaması
 description string

Denetim olayının açıklaması
Katılımcı E-postası
 participantEmail string

Olayı başlatan kullanıcının e-posta adresi
Olay Türü
 type string

Sözleşme olayının türü

DocumentLibraryItem

Name Yol Tür Description
Kitaplık Şablonu Kimliği
 libraryDocumentId string

İmzalanacak belge gönderilirken kullanılan kitaplık belgesinin benzersiz kimliği
Kitaplık Şablonu Türleri
 libraryTemplateTypes array of string

Bir veya daha fazla kitaplık şablonu türünün listesi
Değiştirme Tarihi
 modifiedDate date

Kitaplık şablonunun en son değiştirildiği gün
Kitaplık Şablonu Adı
 name string

Kitaplık şablonunun adı
Şablon Paylaşım Modu
 scope string

Kitaplık şablonunun görünürlüğünün kapsamı

DocumentLibraryItems

Kitaplık şablonu dizi nesnesini içeren bir JSON

Name Yol Tür Description
Kitaplık Şablonları Listesi
 libraryDocumentList array of DocumentLibraryItem

Kitaplık şablonu öğelerinin listesi

DocumentResponse

Belgenin dosya akışı

Belgenin dosya akışı

Dosya İçeriği
binary

LibraryDocumentCreationResponse

Kitaplık şablonunu açıklayan bir JSON nesnesi

Name Yol Tür Description
Kitaplık Şablonu Kimliği
 libraryDocumentId string

Kitaplık şablonuna başvurmak için kullanılabilecek benzersiz kimlik

NextParticipantInfo

Name Yol Tür Description
E-posta
 email string

Sonraki katılımcının e-posta adresi
İsim
 name string

Varsa, sonraki katılımcının adı
O zamandan beri bekleniyor
 waitingSince date

Belgenin katılımcının işlem gerçekleştirmesini beklediği tarih

NextParticipantSetInfo

Name Yol Tür Description
Sonraki Katılımcı Kümesi Üye Bilgileri
 nextParticipantSetMemberInfos array of NextParticipantInfo

Sonraki katılımcı kümesinin üyeleri hakkında bilgi

ParticipantInfo

Name Yol Tür Description
Şirket
 company string

Varsa katılımcının şirketi
E-posta
 email string

Katılımcının e-posta adresi
İsim
 name string

Varsa katılımcının adı
Katılımcı Kimliği
 participantId string

Katılımcının benzersiz kimliği
Güvenlik Seçenekleri
 securityOptions array of string

Katılımcı için geçerli olan güvenlik seçenekleri
Başlık
 title string

Varsa katılımcının başlığı

ParticipantSetInfo

Name Yol Tür Description
Katılımcı Kümesi Kimliği
 participantSetId string

Katılımcı kümesinin benzersiz kimliği
Katılımcı Kümesi Üye Bilgileri
 participantSetMemberInfos array of ParticipantInfo

Alıcı kümesinin üyeleri hakkında bilgi
Özel İleti
 privateMessage string

Kümedeki katılımcılar için özel ileti
Rol
 roles array of string

Katılımcı kümesinin geçerli rolleri. Katılımcı kümesinin bir veya daha fazla rolü olabilir
securityOptions
 securityOptions array of string

Katılımcı için geçerli olan güvenlik seçenekleri
İmzalama Sırası
 signingOrder integer

1 ile başlayan ve bu alıcının imzaladığı sırayı belirten dizin
Katılımcı Kümesi Durumu
 status string

Katılımcı, belgeyle ilgili olarak durumu ayarlar

ParticipantSetInfoV6

Name Yol Tür Description
Katılımcı Kümesi Üye Bilgileri
 memberInfos array of MemberInfosV6

Alıcı kümesinin üyeleri hakkında bilgi
Sipariş
 order integer

İmzalama grubunun imzalaması gereken konumu gösteren dizin.
Rol
 role string

Katılımcı kümesinin geçerli rolleri (imzalayan, onaylayan vb.).
Katılımcı Kümesi Adı
 name string

Katılımcı kümesinin adı
Katılımcı Kümesi Özel Dağınıklığı
 privateMessage string

Kümedeki katılımcılar için özel ileti
Katılımcı Kümesi Görünür Sayfalar
 visiblePages array of string

Katılımcı kümesi tarafından görülebilen sayfalar

MemberInfosV6

Name Yol Tür Description
E-posta
 email string

Katılımcının e-posta adresi
Authentication
 securityOption.authenticationMethod string

Varsayılan kimlik doğrulaması: e-posta (Yok)
Şifre
 securityOption.password string

Katılımcı için gereken parola
Ülke Kodu
 securityOption.phoneInfo.countryCode string

Belgeyi görüntülemek ve imzalamak için gereken alıcının telefon ülke kodu
Telefon No.
 securityOption.phoneInfo.phone string

Sözleşmeyi görüntülemek ve imzalamak için gereken alıcının telefon numarası
Sağlayıcı Kimliği
 securityOption.digAuthInfo.providerId string

Dijital Kimlik Ağ Geçidi Sağlayıcı Kimliği.

SigningUrl

Name Yol Tür Description
İmza URL'si için e-posta
 email string

Bu imzalama URL'si ile ilişkili imzalayanın e-posta adresi
İMZA URL'si
 esignUrl string

Bu imzalama URL'si ile ilişkili imzalayanın URL adresi

SigningUrlResponse

Name Yol Tür Description
İmzalayan kümeleri için URL dizisi
 signingUrlSetInfos array of SigningUrlSetInfo

bu sözleşmede yer alan imzalayan kümeleri için bir url dizisi

SigningUrlSetInfo

Name Yol Tür Description
- İmzalama URL Dizisi
 signingUrls array of SigningUrl

Geçerli imzalayan kümesi için url dizisi
- İMZA URL'si kümesi adı
 signingUrlSetName string

Geçerli imzalayan kümesinin adı

Destekleyici Belge

Destekleyici belge hakkındaki bilgiler

Name Yol Tür Description
Destekleyici Belge Adı
 displayLabel string

Destekleyici belgenin görünen adı
Destekleyici Belge Alan Adı
 fieldName string

Destekleyici belge alanının adı
Destekleyici Belge Mime Türü
 mimeType string

Destekleyici belgenin Mime türü
Belge Sayfalarını Destekleme
 numPages integer

Destekleyici belgedeki sayfa sayısı
Destekleyici Belge Kimliği
 supportingDocumentId string

Destekleyici belgeyi temsil eden benzersiz kimlik

SupportingDocumentV6

Destekleyici belge hakkındaki bilgiler

Name Yol Tür Description
Destekleyici Belge Adı
 displayLabel string

Destekleyici belgenin görünen adı
Destekleyici Belge Alan Adı
 fieldName string

Destekleyici belge alanının adı
Destekleyici Belge Mime Türü
 mimeType string

Destekleyici belgenin Mime türü
Belge Sayfalarını Destekleme
 numPages integer

Destekleyici belgedeki sayfa sayısı
Destekleyici Belge Kimliği
 id string

Destekleyici belgeyi temsil eden benzersiz kimlik

TransientDocumentResponse

Karşıya yüklenen belgenin kimliğini içeren bir JSON

Name Yol Tür Description
Belge Kimliği
 transientDocumentId string

Karşıya yüklenen belgenin belge kimliği

UserAgreement

Name Yol Tür Description
Sözleşme Kimliği
 agreementId string

Sözleşmeyi benzersiz olarak tanımlamak için kullanılabilecek benzersiz bir kimlik
Kullanıcı Kümesi Bilgilerini Görüntüle
 displayUserSetInfos array of DisplayUserSetInfo

Sözleşme için en uygun kullanıcı kümesi. Sözleşme geçerli kullanıcıdan geliyorsa genellikle bir sonraki imzalayandır veya başka bir kullanıcıdan alınmışsa gönderendir
Görüntüleme Tarihi
 displayDate date

Sözleşmenin görüntüleme tarihi
Esign
 esign boolean

Bu bir e-imza belgesiyse True
En Son Sürüm Kimliği
 latestVersionId string

Sözleşmenin geçerli sürümünü benzersiz olarak tanımlayan sürüm kimliği
İsim
 name string

Sözleşmenin Adı
Statü
 status string

Sözleşmenin geçerli durumu

UserAgreements

Kullanıcı sözleşmesi dizi nesnesini içeren bir JSON

Name Yol Tür Description
Sözleşme Listesi
 userAgreementList array of UserAgreement

Sözleşme öğeleri dizisi

UserAgreementV6

Name Yol Tür Description
Kullanıcı Kümesi Bilgilerini Görüntüle
 displayParticipantSetInfos array of DisplayUserSetInfo

Sözleşme için en uygun kullanıcı kümesi. Sözleşme geçerli kullanıcıdan geliyorsa genellikle bir sonraki imzalayandır veya başka bir kullanıcıdan alınmışsa gönderendir
Görüntüleme Tarihi
 displayDate string

Sözleşmenin görüntüleme tarihi
Esign
 esign boolean

Bu bir e-imza belgesiyse True
Gizli
 hidden boolean

Kullanıcı için sözleşme gizliyse true
Grup Kimliği
 groupId string

Grubun benzersiz tanımlayıcısı
En Son Sürüm Kimliği
 latestVersionId string

Sözleşmenin geçerli sürümünü benzersiz olarak tanımlayan sürüm kimliği
İsim
 name string

Sözleşmenin Adı
Üst Kimlik
 parentId string

MegaSign alt öğesinin üst kimliği VEYA web formu sözleşmesi örneğinin kaynak kimliği
Sözleşme Kimliği
 id string

Sözleşmenin benzersiz tanımlayıcısı
Statü
 status string

Sözleşmenin geçerli durumu
Türü
 type string

Sözleşme türü

userAgreementListV6

Kullanıcı sözleşmesi dizi nesnesini içeren bir JSON

Name Yol Tür Description
page
 page page

Yanıtta gezinmek için sayfalandırma bilgileri
Sözleşme Listesi
 userAgreementList array of UserAgreementV6

Sözleşme öğeleri dizisi

page

Yanıtta gezinmek için sayfalandırma bilgileri

Name Yol Tür Description
nextCursor
 nextCursor string

Sonraki sayfaya gitmek için kullanılır. Döndürülmezse başka sayfa yoktur.

Web KancasıPayload

Name Yol Tür Description
Event
 event string

Kaynakta gerçekleşen olay.
Olay Tarihi
 eventDate date

Olayın tarihi. Biçim yyyy-MM-dd'T'HH:mm:ssZ olacaktır. Örneğin, örneğin 2016-02-25T18:46:19Z UTC saatini temsil eder
Olay Kaynak Türü
 eventResourceType string

Olayın gerçekleştiği kaynak.
Sözleşme Üst Türü
 eventResourceParentType string

Sözleşmenin oluşturulduğu kaynakla ilgili bilgiler. Olası değerler: Web Formu veya Mega İşaret
Sözleşme Üst Kimliği
 eventResourceParentId string

Bu sözleşmenin oluşturulduğu kaynağın Benzersiz Kimliği
Olay Katılımcısı Rolü
 participantRole string

Etkinlik katılımcısının rolü.
Olay Katılımcısı Kimliği
 participantUserId string

Etkinliğin katılımcısının kimliği.
Olay Katılımcısı E-postası
 participantUserEmail string

Katılımcının etkinlik için e-posta adresi.
Olay EylemLi Kullanıcı Kimliği
 actingUserId string

Olayı oluşturan kullanıcının kimliği.
Olay Eylemli Kullanıcı E-postası
 actingUserEmail string

Olayı oluşturan kullanıcının e-postası.
Olay EylemLi Kullanıcı IP Adresi
 actingUserIpAddress string

Olayı oluşturan kullanıcının IP adresi
Kullanıcı Kimliği Başlatan Olay
 initiatingUserId string

Olayı eyleme geçen kullanıcı adına başlatan kullanıcının kimliği.
Kullanıcı E-postası Başlatma Olayı
 initiatingUserEmail string

Olayı yürüten kullanıcı adına başlatan kullanıcının e-postası.
Bildirime Uygun Kullanıcılar
 webhookNotificationApplicableUsers array of ApplicableUsers

Bu bildirimin geçerli olduğu kullanıcıların listesi
Agreement
 agreement WebhookAgreementInfo

Sözleşmenin tam bilgileri

ApplicableUsers

Bu bildirimin geçerli olduğu kullanıcılar hakkındaki bilgiler

Name Yol Tür Description
Bildirime Uygun Kullanıcı Kimliği
 id string

Bu bildirimin geçerli olduğu kullanıcının benzersiz kimliği
Bildirime Uygun Kullanıcı E-postası
 email string

Bu bildirimin geçerli olduğu kullanıcının e-posta adresi
Bildirime Uygun Kullanıcı Rolü
 role string

Bu bildirimin oluşturulduğu iş akışındaki kullanıcının rolü
Yük Geçerli Kullanıcı mı?
 payloadApplicable boolean

Bu bildirimde sağlanan verilerin bu kullanıcı için geçerli olup olmadığı

WebhookPayloadWithoutNextParticipantSet

Name Yol Tür Description
Event
 event string

Kaynakta gerçekleşen olay.
Olay Tarihi
 eventDate date

Olayın tarihi. Biçim yyyy-MM-dd'T'HH:mm:ssZ olacaktır. Örneğin, örneğin 2016-02-25T18:46:19Z UTC saatini temsil eder
Olay Kaynak Türü
 eventResourceType string

Olayın gerçekleştiği kaynak.
Sözleşme Üst Türü
 eventResourceParentType string

Sözleşmenin oluşturulduğu kaynakla ilgili bilgiler. Olası değerler: Web Formu veya Mega İşaret
Sözleşme Üst Kimliği
 eventResourceParentId string

Bu sözleşmenin oluşturulduğu kaynağın Benzersiz Kimliği
Olay Katılımcısı Kimliği
 participantUserId string

Etkinliğin katılımcısının kimliği.
Olay Katılımcısı E-postası
 participantUserEmail string

Katılımcının etkinlik için e-posta adresi.
Olay EylemLi Kullanıcı Kimliği
 actingUserId string

Olayı oluşturan kullanıcının kimliği.
Olay Eylemli Kullanıcı E-postası
 actingUserEmail string

Olayı oluşturan kullanıcının e-postası.
Olay EylemLi Kullanıcı IP Adresi
 actingUserIpAddress string

Olayı oluşturan kullanıcının IP adresi
Kullanıcı Kimliği Başlatan Olay
 initiatingUserId string

Olayı eyleme geçen kullanıcı adına başlatan kullanıcının kimliği
Kullanıcı E-postası Başlatma Olayı
 initiatingUserEmail string

Olayı yürüten kullanıcı adına başlatan kullanıcının e-postası.
Bildirime Uygun Kullanıcılar
 webhookNotificationApplicableUsers array of ApplicableUsers

Bu bildirimin geçerli olduğu kullanıcıların listesi
Agreement
 agreement WebhookAgreementInfoWithoutNextParticipantSet

Sözleşmenin tam bilgileri

WebhookPayloadWithSignedDocumentForStatusChange

Name Yol Tür Description
Event
 event string

Kaynakta gerçekleşen olay.
Olay Tarihi
 eventDate date

Olayın tarihi. Biçim yyyy-MM-dd'T'HH:mm:ssZ olacaktır. Örneğin, örneğin 2016-02-25T18:46:19Z UTC saatini temsil eder
Alt Olay
 subEvent string

Bir kaynakta gerçekleşen alt olay.
Sözleşme Üst Türü
 eventResourceParentType string

Sözleşmenin oluşturulduğu kaynakla ilgili bilgiler. Olası değerler: Web Formu veya Mega İşaret
Sözleşme Üst Kimliği
 eventResourceParentId string

Bu sözleşmenin oluşturulduğu kaynağın Benzersiz Kimliği
Olay Katılımcısı Kimliği
 participantUserId string

Etkinliğin katılımcısının kimliği.
Olay Katılımcısı E-postası
 participantUserEmail string

Katılımcının etkinlik için e-posta adresi.
Olay EylemLi Kullanıcı Kimliği
 actingUserId string

Olayı oluşturan kullanıcının kimliği.
Olay Eylemli Kullanıcı E-postası
 actingUserEmail string

Olayı oluşturan kullanıcının e-postası.
Olay EylemLi Kullanıcı IP Adresi
 actingUserIpAddress string

Olayı oluşturan kullanıcının IP adresi
Eylem Türü
 actionType string

Olayın gerçekleştiği eylem.
Kullanıcı Kimliği Başlatan Olay
 initiatingUserId string

Olayı eyleme geçen kullanıcı adına başlatan kullanıcının kimliği
Kullanıcı E-postası Başlatma Olayı
 initiatingUserEmail string

Olayı yürüten kullanıcı adına başlatan kullanıcının e-postası.
Olay Kaynak Türü
 eventResourceType string

Olayın gerçekleştiği kaynak.
Olay Katılımcısı Rolü
 participantRole string

Etkinlik katılımcısının rolü.
Bildirime Uygun Kullanıcılar
 webhookNotificationApplicableUsers array of ApplicableUsers

Bu bildirimin geçerli olduğu kullanıcıların listesi
Agreement
 agreement WebhookAgreementInfoWithSignedDocument

Sözleşmenin tam bilgileri

WebhookPayloadWithSignedDocument

Name Yol Tür Description
Event
 event string

Kaynakta gerçekleşen olay.
Olay Tarihi
 eventDate date

Olayın tarihi. Biçim yyyy-MM-dd'T'HH:mm:ssZ olacaktır. Örneğin, örneğin 2016-02-25T18:46:19Z UTC saatini temsil eder
Sözleşme Üst Türü
 eventResourceParentType string

Sözleşmenin oluşturulduğu kaynakla ilgili bilgiler. Olası değerler: Web Formu veya Mega İşaret
Sözleşme Üst Kimliği
 eventResourceParentId string

Bu sözleşmenin oluşturulduğu kaynağın Benzersiz Kimliği
Olay Kaynak Türü
 eventResourceType string

Olayın gerçekleştiği kaynak.
Olay Katılımcısı Rolü
 participantRole string

Etkinlik katılımcısının rolü.
Olay Katılımcısı Kimliği
 participantUserId string

Etkinliğin katılımcısının kimliği.
Olay Katılımcısı E-postası
 participantUserEmail string

Katılımcının etkinlik için e-posta adresi.
Olay EylemLi Kullanıcı Kimliği
 actingUserId string

Olayı oluşturan kullanıcının kimliği.
Olay Eylemli Kullanıcı E-postası
 actingUserEmail string

Olayı oluşturan kullanıcının e-postası.
Olay EylemLi Kullanıcı IP Adresi
 actingUserIpAddress string

Olayı oluşturan kullanıcının IP adresi
Kullanıcı Kimliği Başlatan Olay
 initiatingUserId string

Olayı eyleme geçen kullanıcı adına başlatan kullanıcının kimliği
Kullanıcı E-postası Başlatma Olayı
 initiatingUserEmail string

Olayı yürüten kullanıcı adına başlatan kullanıcının e-postası.
Bildirime Uygun Kullanıcılar
 webhookNotificationApplicableUsers array of ApplicableUsers

Bu bildirimin geçerli olduğu kullanıcıların listesi
Agreement
 agreement WebhookAgreementInfoWithSignedDocument

Sözleşmenin tam bilgileri

Web KancasıPayloadGeneric

Name Yol Tür Description
Event
 event string

Kaynakta gerçekleşen olay.
Olay Tarihi
 eventDate date

Olayın tarihi. Biçim yyyy-MM-dd'T'HH:mm:ssZ olacaktır. Örneğin, örneğin 2016-02-25T18:46:19Z UTC saatini temsil eder
Alt Olay
 subEvent string

Bir kaynakta gerçekleşen alt olay.
Sözleşme Üst Türü
 eventResourceParentType string

Sözleşmenin oluşturulduğu kaynakla ilgili bilgiler. Olası değerler: Web Formu veya Mega İşaret
Sözleşme Üst Kimliği
 eventResourceParentId string

Bu sözleşmenin oluşturulduğu kaynağın Benzersiz Kimliği
Olay Kaynak Türü
 eventResourceType string

Olayın gerçekleştiği kaynak.
Olay Katılımcısı Rolü
 participantRole string

Etkinlik katılımcısının rolü.
Olay Katılımcısı Kimliği
 participantUserId string

Etkinliğin katılımcısının kimliği.
Olay Katılımcısı E-postası
 participantUserEmail string

Katılımcının etkinlik için e-posta adresi.
Olay EylemLi Kullanıcı Kimliği
 actingUserId string

Olayı oluşturan kullanıcının kimliği.
Olay Eylemli Kullanıcı E-postası
 actingUserEmail string

Olayı oluşturan kullanıcının e-postası.
Kullanıcı Kimliği Başlatan Olay
 initiatingUserId string

Olayı eyleme geçen kullanıcı adına başlatan kullanıcının kimliği
Kullanıcı E-postası Başlatma Olayı
 initiatingUserEmail string

Olayı yürüten kullanıcı adına başlatan kullanıcının e-postası.
Eylem Türü
 actionType string

Olayın gerçekleştiği eylem.
Olay EylemLi Kullanıcı IP Adresi
 actingUserIpAddress string

Olayı oluşturan kullanıcının IP adresi
Bildirime Uygun Kullanıcılar
 webhookNotificationApplicableUsers array of ApplicableUsers

Bu bildirimin geçerli olduğu kullanıcıların listesi
Agreement
 agreement WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

Sözleşmenin tam bilgileri
Mega İşareti
 megaSign WebhookMegaSignInfo

Mega işaretinin tam bilgileri
Web Formu
 widget WebhookWidgetInfo

Web formunun tam bilgileri

WebFormWebhookAgreementEventPayload

Name Yol Tür Description
Event
 event string

Web formunda gerçekleşen sözleşme olayı.
Olay Tarihi
 eventDate date

Olayın tarihi. Biçim yyyy-MM-dd'T'HH:mm:ssZ olacaktır. Örneğin, örneğin 2016-02-25T18:46:19Z UTC saatini temsil eder
Alt Olay
 subEvent string

Web formunda gerçekleşen alt olay.
Sözleşme Üst Türü - Web Formu
 eventResourceParentType string

Bir sözleşmenin web formundan oluşturulduğunu gösteren değer.
Web Formu Kimliği
 eventResourceParentId string

Bu sözleşmenin oluşturulduğu web formunun benzersiz kimliği
Olay Kaynak Türü - Sözleşme
 eventResourceType string

Olayın gerçekleştiği kaynak.
Olay Katılımcısı Rolü
 participantRole string

Etkinlik katılımcısının rolü.
Olay Katılımcısı Kimliği
 participantUserId string

Etkinliğin katılımcısının kimliği.
Olay Katılımcısı E-postası
 participantUserEmail string

Katılımcının etkinlik için e-posta adresi.
Olay EylemLi Kullanıcı Kimliği
 actingUserId string

Olayı oluşturan kullanıcının kimliği.
Olay Eylemli Kullanıcı E-postası
 actingUserEmail string

Olayı oluşturan kullanıcının e-postası.
Kullanıcı Kimliği Başlatan Olay
 initiatingUserId string

Olayı eyleme geçen kullanıcı adına başlatan kullanıcının kimliği
Kullanıcı E-postası Başlatma Olayı
 initiatingUserEmail string

Olayı yürüten kullanıcı adına başlatan kullanıcının e-postası.
Eylem Türü
 actionType string

Olayın gerçekleştiği eylem.
Olay EylemLi Kullanıcı IP Adresi
 actingUserIpAddress string

Olayı oluşturan kullanıcının IP adresi
Bildirime Uygun Kullanıcılar
 webhookNotificationApplicableUsers array of ApplicableUsers

Bu bildirimin geçerli olduğu kullanıcıların listesi
Agreement
 agreement WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

Sözleşmenin tam bilgileri

GroupWebhookEventPayload

Name Yol Tür Description
Event
 event string

Bir grup için gerçekleşen olay.
Olay Tarihi
 eventDate date

Olayın tarihi. Biçim yyyy-MM-dd'T'HH:mm:ssZ olacaktır. Örneğin, örneğin 2016-02-25T18:46:19Z UTC saatini temsil eder
Alt Olay
 subEvent string

Bir grup için gerçekleşen alt olay.
Sözleşme Üst Türü - Web Formu
 eventResourceParentType string

Sözleşmenin oluşturulduğu grup hakkındaki bilgiler.
Web Formu Kimliği
 eventResourceParentId string

Bu sözleşmenin oluşturulduğu grubun benzersiz kimliği
Olay Kaynak Türü - Sözleşme
 eventResourceType string

Olayın gerçekleştiği grup.
Olay Katılımcısı Rolü
 participantRole string

Etkinlik katılımcısının rolü.
Olay Katılımcısı Kimliği
 participantUserId string

Etkinliğin katılımcısının kimliği.
Olay Katılımcısı E-postası
 participantUserEmail string

Katılımcının etkinlik için e-posta adresi.
Olay EylemLi Kullanıcı Kimliği
 actingUserId string

Olayı oluşturan kullanıcının kimliği.
Olay Eylemli Kullanıcı E-postası
 actingUserEmail string

Olayı oluşturan kullanıcının e-postası.
Kullanıcı Kimliği Başlatan Olay
 initiatingUserId string

Olayı eyleme geçen kullanıcı adına başlatan kullanıcının kimliği
Kullanıcı E-postası Başlatma Olayı
 initiatingUserEmail string

Olayı yürüten kullanıcı adına başlatan kullanıcının e-postası.
Eylem Türü
 actionType string

Olayın gerçekleştiği eylem.
Olay EylemLi Kullanıcı IP Adresi
 actingUserIpAddress string

Olayı oluşturan kullanıcının IP adresi
Bildirime Uygun Kullanıcılar
 webhookNotificationApplicableUsers array of ApplicableUsers

Bu bildirimin geçerli olduğu kullanıcıların listesi
Agreement
 agreement WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

Sözleşmenin tam bilgileri
Mega İşareti
 megaSign WebhookMegaSignInfo

Mega işaretinin tam bilgileri
Web Formu
 widget WebhookWidgetInfo

Web formunun tam bilgileri

WebhookAgreementInfo

Sözleşmenin tam bilgileri

Name Yol Tür Description
Kimlik
 id string

Sözleşmenin benzersiz kimliği
İsim
 name string

Sözleşmenin adı
İmza Türü
 signatureType string

İstenen İmza türünü belirtir - E-imza veya Yazılı
Statü
 status string

Sözleşmenin geçerli durumu
Ccs
 ccs array of CcInfo

Sözleşme işleminde kopyalanacak bir veya daha fazla CC'nin listesi.
Oluşturma Tarihi
 createdDate date

Sözleşmenin oluşturulduğu tarih
Süre Sonu Süresi
 expirationTime string

Sözleşmenin sona erdiği ve imzalanması gereken süre
Dış Kimlik
 externalId.id string

Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir
Dış Grup
 externalId.group string

Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir
İlk Anımsatıcı Gecikmesi
 firstReminderDelay integer

İlk anımsatıcıyı göndermeden önce saat cinsinden gecikmeyi belirten tamsayı.
Locale
 locale string

Bu sözleşmeyle ilişkili yerel ayar
Message
 message string

Katılımcılara gönderilenleri veya imzalarının neden gerekli olduğunu açıklayan isteğe bağlı bir ileti
Anımsatıcı Sıklığı
 reminderFrequency string

Katılımcılara ne sıklıkta anımsatıcı göndermek istediğinizi ayarlayan isteğe bağlı parametre. Belirtilmezse, hesap için ayarlanan varsayılan sıklık kullanılır
Gönderen E-postası
 senderEmail string

Sözleşme gönderenin e-postası
Kasa Etkinleştirildi mi?
 vaultingInfo.enabled boolean

Belge kasası için ayarlanan hesaplar ve sözleşmeye göre etkinleştirme seçeneği için bu, belgenin kasaya alınıp alınmayacağını belirler
Belge Görünürlüğü mü?
 documentVisibilityEnabled boolean

Belge görünürlüğü etkin mi?
İş Akışı Kimliği
 workflowId string

Bir sözleşmenin yönlendirme yolunu tanımlayan özel iş akışının kimliği.
İmza Sonrası Yeniden Yönlendirme Url'si
 postSignOption.redirectUrl string

İmzalama işlemi başarıyla tamamlandıktan sonra kullanıcının gönderileceği genel olarak erişilebilir bir URL
Katılımcı Kümeleri
 participantSetsInfo.participantSets array of WebhookParticipantSets

Katılımcı bilgileri ayarlar
Sonraki Katılımcı Kümeleri
 participantSetsInfo.nextParticipantSets array of WebhookParticipantSets

Sonraki katılımcı bilgileri ayarlar
Documents
 documentsInfo.documents array of WebhookDocument

Belgeleri temsil eden nesnelerin listesi
Destekleyici Belgeler
 documentsInfo.supportingDocuments array of WebhookSupportingDocument

Destekleyici belgelerin listesi

WebhookAgreementInfoWithoutNextParticipantSet

Sözleşmenin tam bilgileri

Name Yol Tür Description
Kimlik
 id string

Sözleşmenin benzersiz kimliği
İsim
 name string

Sözleşmenin adı
İmza Türü
 signatureType string

İstenen İmza türünü belirtir - E-imza veya Yazılı
Statü
 status string

Sözleşmenin geçerli durumu
Ccs
 ccs array of CcInfo

Sözleşme işleminde kopyalanacak bir veya daha fazla CC'nin listesi.
Oluşturma Tarihi
 createdDate date

Sözleşmenin oluşturulduğu tarih
Belge Görünürlüğü mü?
 documentVisibilityEnabled boolean

Belge görünürlüğü etkin mi?
Süre Sonu Süresi
 expirationTime string

Sözleşmenin sona erdiği ve imzalanması gereken süre
Dış Kimlik
 externalId.id string

Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir
Dış Grup
 externalId.group string

Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir
İlk Anımsatıcı Gecikmesi
 firstReminderDelay integer

İlk anımsatıcıyı göndermeden önce saat cinsinden gecikmeyi belirten tamsayı.
Locale
 locale string

Bu sözleşmeyle ilişkili yerel ayar
Message
 message string

Katılımcılara gönderilenleri veya imzalarının neden gerekli olduğunu açıklayan isteğe bağlı bir ileti
Anımsatıcı Sıklığı
 reminderFrequency string

Katılımcılara ne sıklıkta anımsatıcı göndermek istediğinizi ayarlayan isteğe bağlı parametre. Belirtilmezse, hesap için ayarlanan varsayılan sıklık kullanılır
Gönderen E-postası
 senderEmail string

Sözleşme gönderenin e-postası
Kasa Etkinleştirildi mi?
 vaultingInfo.enabled boolean

Belge kasası için ayarlanan hesaplar ve sözleşmeye göre etkinleştirme seçeneği için bu, belgenin kasaya alınıp alınmayacağını belirler
İmza Sonrası Yeniden Yönlendirme Url'si
 postSignOption.redirectUrl string

İmzalama işlemi başarıyla tamamlandıktan sonra kullanıcının gönderileceği genel olarak erişilebilir bir URL
İş Akışı Kimliği
 workflowId string

Bir sözleşmenin yönlendirme yolunu tanımlayan özel iş akışının kimliği.
Katılımcı Kümeleri
 participantSetsInfo.participantSets array of WebhookParticipantSets

Katılımcı bilgileri ayarlar

WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

Sözleşmenin tam bilgileri

Name Yol Tür Description
Kimlik
 id string

Sözleşmenin benzersiz kimliği
İsim
 name string

Sözleşmenin adı
İmza Türü
 signatureType string

İstenen İmza türünü belirtir - E-imza veya Yazılı
Statü
 status string

Sözleşmenin geçerli durumu
Ccs
 ccs array of CcInfo

Sözleşme işleminde kopyalanacak bir veya daha fazla CC'nin listesi.
Oluşturma Tarihi
 createdDate date

Sözleşmenin oluşturulduğu tarih
Süre Sonu Süresi
 expirationTime string

Sözleşmenin sona erdiği ve imzalanması gereken süre
Dış Kimlik
 externalId.id string

Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir
Dış Grup
 externalId.group string

Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir
İlk Anımsatıcı Gecikmesi
 firstReminderDelay integer

İlk anımsatıcıyı göndermeden önce saat cinsinden gecikmeyi belirten tamsayı.
Locale
 locale string

Bu sözleşmeyle ilişkili yerel ayar
Message
 message string

Katılımcılara gönderilenleri veya imzalarının neden gerekli olduğunu açıklayan isteğe bağlı bir ileti
Anımsatıcı Sıklığı
 reminderFrequency string

Katılımcılara ne sıklıkta anımsatıcı göndermek istediğinizi ayarlayan isteğe bağlı parametre. Belirtilmezse, hesap için ayarlanan varsayılan sıklık kullanılır
İmza Sonrası Yeniden Yönlendirme Url'si
 postSignOption.redirectUrl string

İmzalama işlemi başarıyla tamamlandıktan sonra kullanıcının gönderileceği genel olarak erişilebilir bir URL
İş Akışı Kimliği
 workflowId string

Bir sözleşmenin yönlendirme yolunu tanımlayan özel iş akışının kimliği.
Gönderen E-postası
 senderEmail string

Sözleşme gönderenin e-postası
Belge Görünürlüğü mü?
 documentVisibilityEnabled boolean

Belge görünürlüğü etkin mi?
Kasa Etkinleştirildi mi?
 vaultingInfo.enabled boolean

Belge kasası için ayarlanan hesaplar ve sözleşmeye göre etkinleştirme seçeneği için bu, belgenin kasaya alınıp alınmayacağını belirler
Katılımcı Kümeleri
 participantSetsInfo.participantSets array of WebhookParticipantSets

Katılımcı bilgileri ayarlar
Sonraki Katılımcı Kümeleri
 participantSetsInfo.nextParticipantSets array of WebhookParticipantSets

Sonraki katılımcı bilgileri ayarlar
Documents
 documentsInfo.documents array of WebhookDocument

Belgeleri temsil eden nesnelerin listesi
Destekleyici Belgeler
 documentsInfo.supportingDocuments array of WebhookSupportingDocument

Destekleyici belgelerin listesi Bu, yalnızca sözleşmede herhangi bir destekleyici belge varsa döndürülür
İmzalı Belge Bilgileri
 signedDocumentInfo.document string

İmzalanan belgenin base64 kodlanmış dizesi

WebhookAgreementInfoWithSignedDocument

Sözleşmenin tam bilgileri

Name Yol Tür Description
Kimlik
 id string

Sözleşmenin benzersiz kimliği
İsim
 name string

Sözleşmenin adı
İmza Türü
 signatureType string

İstenen İmza türünü belirtir - E-imza veya Yazılı
Statü
 status string

Sözleşmenin geçerli durumu
Ccs
 ccs array of CcInfo

Sözleşme işleminde kopyalanacak bir veya daha fazla CC'nin listesi
Oluşturma Tarihi
 createdDate date

Sözleşmenin oluşturulduğu tarih
Belge Görünürlüğü mü?
 documentVisibilityEnabled boolean

Belge görünürlüğü etkin mi?
Süre Sonu Süresi
 expirationTime string

Sözleşmenin sona erdiği ve imzalanması gereken süre
Dış Kimlik
 externalId.id string

Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir
Dış Grup
 externalId.group string

Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir
İlk Anımsatıcı Gecikmesi
 firstReminderDelay integer

İlk anımsatıcıyı göndermeden önce saat cinsinden gecikmeyi belirten tamsayı.
Locale
 locale string

Bu sözleşmeyle ilişkili yerel ayar
Message
 message string

Katılımcılara gönderilenleri veya imzalarının neden gerekli olduğunu açıklayan isteğe bağlı bir ileti
Anımsatıcı Sıklığı
 reminderFrequency string

Katılımcılara ne sıklıkta anımsatıcı göndermek istediğinizi ayarlayan isteğe bağlı parametre. Belirtilmezse, hesap için ayarlanan varsayılan sıklık kullanılır
Gönderen E-postası
 senderEmail string

Sözleşme gönderenin e-postası
Kasa Etkinleştirildi mi?
 vaultingInfo.enabled boolean

Belge kasası için ayarlanan hesaplar ve sözleşmeye göre etkinleştirme seçeneği için bu, belgenin kasaya alınıp alınmayacağını belirler
İmza Sonrası Yeniden Yönlendirme Url'si
 postSignOption.redirectUrl string

İmzalama işlemi başarıyla tamamlandıktan sonra kullanıcının gönderileceği genel olarak erişilebilir bir URL
İş Akışı Kimliği
 workflowId string

Bir sözleşmenin yönlendirme yolunu tanımlayan özel iş akışının kimliği.
Katılımcı Kümeleri
 participantSetsInfo.participantSets array of WebhookParticipantSets

Katılımcı bilgileri ayarlar
Documents
 documentsInfo.documents array of WebhookDocument

Belgeleri temsil eden nesnelerin listesi
Destekleyici Belgeler
 documentsInfo.supportingDocuments array of WebhookSupportingDocument

Destekleyici belgelerin listesi Bu, yalnızca sözleşmede herhangi bir destekleyici belge varsa döndürülür
İmzalı Belge Bilgileri
 signedDocumentInfo.document string

İmzalanan belgenin base64 kodlanmış dizesi

WebhookMegaSignInfo

Mega işaretinin tam bilgileri

Name Yol Tür Description
Kimlik
 id string

Megasign'ın benzersiz kimliği
İsim
 name string

Megasign'ın adı
Statü
 status string

Megasign'ın durumu
Ccs
 ccs array of MegaSignCcInfo

Bu megasign üzerinde kopyalamak istediğiniz bir veya daha fazla e-posta adresinin listesi.
Dış Kimlik
 externalId.id string

Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir
İlk Anımsatıcı Gecikmesi
 firstReminderDelay integer

İlk anımsatıcıyı göndermeden önce saat cinsinden gecikmeyi belirten tamsayı.
Locale
 locale string

Bu sözleşmeyle ilişkili yerel ayar
Message
 message string

Katılımcılara gönderilenleri veya imzalarının neden gerekli olduğunu açıklayan isteğe bağlı bir ileti
İmza Sonrası Yeniden Yönlendirme Url'si
 postSignOption.redirectUrl string

İmzalama işlemi başarıyla tamamlandıktan sonra kullanıcının gönderileceği genel olarak erişilebilir bir URL
Gönderen E-postası
 senderEmail string

Megasign oluşturucusunun e-posta adresi
İmza Türü
 signatureType string

İstenen İmza türünü belirtir - E-imza veya Yazılı
Kasa Etkinleştirildi mi?
 vaultingInfo.enabled boolean

Belge kasası için ayarlanan hesaplar ve sözleşmeye göre etkinleştirme seçeneği için bu, belgenin kasaya alınıp alınmayacağını belirler
Çocuk Sözleşmeleri Dosya Bilgileri
 childAgreementsInfo.fileInfo MegaSignChildAgreementsFileInfo

MegaSign'ın çocuk sözleşmesine göre bilgilerini içeren dosya bilgileri.

WebhookWidgetInfo

Web formunun tam bilgileri

Name Yol Tür Description
Kimlik
 id string

Web formunun benzersiz kimliği
İsim
 name string

Web formunun adı
Statü
 status string

Web formunun durumu
Kimlik Doğrulama Hatası Bilgileri
 authFailureInfo AuthFailureWidgetRedirectionInfo

Web formu imzalayanın kimlik doğrulaması başarısız olduktan sonra alınacağı hata sayfasının URL'si ve ilişkili özellikleri
Ccs
 ccs array of WidgetCcInfo

Bu web formunda kopyalamak istediğiniz bir veya daha fazla e-posta adresinin listesi.
Oluşturma Tarihi
 createdDate date

Web formunun oluşturulduğu tarih
Tamamlama Bilgileri
 completionInfo WidgetCompletionRedirectionInfo

Web formunda istenen eylem gerçekleştirildikten sonra web formu imzalayanın gerçekleştirileceği başarı sayfasının URL'si ve ilişkili özellikleri
Oluşturucu E-postası
 creatorEmail string

Web formunu oluşturanın e-postası
Kasa Etkinleştirildi mi?
 vaultingInfo.enabled boolean

Belge kasası için ayarlanan hesaplar ve sözleşmeye göre etkinleştirme seçeneği için bu, belgenin kasaya alınıp alınmayacağını belirler
Ek Katılımcı Kümeleri Bilgileri
 participantSetsInfo.additionalParticipantSets array of WidgetParticipantSetInfo

Web formu imzalayan dışında web formundaki tüm katılımcıların listesi
İlk Katılımcı Kümesi Rolü
 participantSetsInfo.widgetParticipantSet.role string

Rol, kümedeki tüm katılımcılar tarafından varsayılır (imzalayan, onaylayan vb.)
İlk Katılımcı Kümesi Sırası
 participantSetsInfo.widgetParticipantSet.order integer

Sıralı imzalama grubunu gösteren dizin (karma yönlendirme için belirtilir)
Documents
 documentsInfo.documents array of WidgetWebhookDocument

Belgeleri temsil eden nesnelerin listesi

AuthFailureWidgetRedirectionInfo

Web formu imzalayanın kimlik doğrulaması başarısız olduktan sonra alınacağı hata sayfasının URL'si ve ilişkili özellikleri

Name Yol Tür Description
Kimlik Doğrulama Hatası Yeniden Yönlendirme Gecikmesi
 delay integer

Kullanıcının sonuç sayfasına alınmasından önceki gecikme (saniye olarak)
Kimlik Doğrulama Hatası Yeniden Yönlendirme Çerçevesini Kaldırma
 deframe boolean

Çerçeveyi kaldırma yanlışsa, sonuçta elde edilen sayfa web formu çerçevesi içinde gösterilir
Kimlik Doğrulama Hatası Yeniden Yönlendirme URL'si
 url string

Web formunu başarıyla tamamladıktan sonra kullanıcının gönderileceği genel olarak erişilebilir bir URL

WidgetCompletionRedirectionInfo

Web formunda istenen eylem gerçekleştirildikten sonra web formu imzalayanın gerçekleştirileceği başarı sayfasının URL'si ve ilişkili özellikleri

Name Yol Tür Description
Tamamlama Yeniden Yönlendirme Gecikmesi
 delay integer

Kullanıcının sonuç sayfasına alınmasından önceki gecikme (saniye olarak)
Tamamlama Yeniden Yönlendirme Çerçevesini Kaldırma
 deframe boolean

Çerçeveyi kaldırma yanlışsa, sonuçta elde edilen sayfa web formu çerçevesi içinde gösterilir
Tamamlama Yeniden Yönlendirme Url'si
 url string

Web formunu başarıyla tamamladıktan sonra kullanıcının gönderileceği genel olarak erişilebilir bir URL

WebhookParticipantSets

Name Yol Tür Description
Üye Bilgileri
 memberInfos array of MemberInfos

Katılımcı üyeleri hakkındaki bilgiler
Sipariş
 order integer

İmzalama grubunun imzalaması gereken konumu gösteren dizin.
Rol
 role string

Rol, kümedeki tüm katılımcılar tarafından varsayılır (imzalayan, onaylayan vb.)
Statü
 status string

Kullanıcının bakış açısından sözleşmenin geçerli durumu
Kimlik
 id string

Katılımcı kümesinin kimliği
İsim
 name string

Katılımcı kümesinin adı
Özel İleti
 privateMessage string

Kümedeki katılımcılar için özel ileti

MegaSignChildAgreementsFileInfo

MegaSign'ın çocuk sözleşmesine göre bilgilerini içeren dosya bilgileri.

Name Yol Tür Description
Alt Sözleşmeler Dosya Kimliği
 childAgreementsInfoFileId string

megaSign'ın mevcut childAgreementsInfo değeri hakkında bilgi içeren dosyanın kimliği.

Pencere ÖğesiWebhookDocument

Web formunun belgesi hakkındaki bilgiler

Name Yol Tür Description
Kimlik
 id string

Belgenin benzersiz kimliği
İsim
 name string

Belgenin adı

Web KancasıDocument

Sözleşme belgesiyle ilgili bilgiler

Name Yol Tür Description
Kimlik
 id string

Belgenin benzersiz kimliği
İsim
 name string

Belgenin adı

Web KancasıSupportingDocument

Destekleyici belge hakkındaki bilgiler

Name Yol Tür Description
İsim
 displayLabel string

Destekleyici belgenin görünen adı
Alan Adı
 fieldName string

Destekleyici belge alanının adı
Kimlik
 id string

Destekleyici belgeyi temsil eden benzersiz kimlik

WidgetCcInfo

Web formunun BILGI bilgileri

Name Yol Tür Description
E-posta
 email string

Web formunun BILGI katılımcısının e-postası

MegaSignCcInfo

Mega işaretinin BILGI bilgileri

Name Yol Tür Description
E-posta
 email string

Megasign'ın CC katılımcısının e-postası

CcInfo

Sözleşmenin BILGI bilgileri

Name Yol Tür Description
E-posta
 email string

Sözleşmenin BILGI e-postası
Etiket
 label string

İş akışı açıklamasında döndürülen BILGI listesinin etiketi
Görünür Sayfalar
 visiblePages array of string

CC'ye görünen sayfalar

WidgetParticipantSetInfo

Name Yol Tür Description
Rol
 role string

Rol, kümedeki tüm katılımcılar tarafından varsayılır (imzalayan, onaylayan vb.)
Kimlik
 id string

Katılımcı kümesinin benzersiz tanımlayıcısı
Üye Bilgileri
 memberInfos array of MemberInfos

Katılımcı üyeleri hakkındaki bilgiler
Sipariş
 order integer

Sıralı imzalama grubunu gösteren dizin (karma yönlendirme için belirtilir)

MemberInfos

Name Yol Tür Description
Kimlik
 id string

Katılımcının benzersiz kimliği
E-posta
 email string

Katılımcının e-posta adresi
Şirket
 company string

Katılımcının şirketi
İsim
 name string

Katılımcının adı
Özel İleti
 privateMessage string

Katılımcının özel iletisi
Statü
 status string

Katılımcının durumu

LibraryDocumentCreationResponseV6

Kitaplık şablonunu açıklayan bir JSON nesnesi

Name Yol Tür Description
Kitaplık Şablonu Kimliği
 id string

Kitaplık şablonuna başvurmak için kullanılabilecek benzersiz kimlik

LibraryDocument

Name Yol Tür Description
Kitaplık Şablonu Kimliği
 id string

Kitaplık şablonuna başvurmak için kullanılan benzersiz tanımlayıcı
Gizli
 hidden boolean

Kitaplık Belgesi gizliyse True
Şablon Türleri
 templateTypes array of string

Bir veya daha fazla kitaplık şablonu türünün listesi
Değiştirme Tarihi
 modifiedDate date

Kitaplık şablonunun en son değiştirildiği gün
Kitaplık Şablonu Adı
 name string

Kitaplık şablonunun adı
Şablon Paylaşım Modu
 sharingMode string

Kitaplık şablonunun görünürlüğünün kapsamı
Oluşturucu E-postası
 creatorEmail string

Kitaplık belge oluşturucusunun e-posta adresi.
Grup Kimliği
 groupId string

Kitaplık şablonunun ait olduğu grubun benzersiz tanımlayıcısı.
Statü
 status string

Kitaplık belgesinin durumu

Kitaplık Belgeleri

Kitaplık şablonu dizi nesnesini içeren bir JSON

Name Yol Tür Description
page
 page page

Yanıtta gezinmek için sayfalandırma bilgileri
Kitaplık Şablonları Listesi
 libraryDocumentList array of LibraryDocument

Kitaplık şablonu öğelerinin listesi

UserWidgetV6

Name Yol Tür Description
Web Formu Kimliği
 id string

Web formunun benzersiz tanımlayıcısı
Değiştirme Tarihi
 modifiedDate string

Web formunun en son değiştirildiği tarih
Gizli
 hidden boolean

Kullanıcı için sözleşme gizliyse true
Grup Kimliği
 groupId string

Grubun benzersiz tanımlayıcısı
İsim
 name string

Web formunun adı
Statü
 status string

Web formu durumu
Bağlantı
 url string

Web formunun barındırılan URL'si
Javascript
 javascript string

Web formunun eklenmiş javascript kodu

userWidgetListV6

Kullanıcı web formu dizi nesnesini içeren bir JSON

Name Yol Tür Description
page
 page page

Yanıtta gezinmek için sayfalandırma bilgileri
Web Formu Listesi
 userWidgetList array of UserWidgetV6

Web formu öğeleri dizisi

UserWorkflowV6

Name Yol Tür Description
İş Akışı Kimliği
 id string

İş akışının benzersiz tanımlayıcısı
Description
 description string

Bu iş akışı için oluşturulduğu sırada sağlanan açıklama
Oluşturulma Tarihi
 created string

İş akışının oluşturulduğu tarih. Biçim yyyy-MM-dd'T'HH:mm:ssZ olur
Değiştirme Tarihi
 modified string

İş akışının değiştirildiği tarih. Biçim yyyy-MM-dd'T'HH:mm:ssZ olur
İsim
 name string

İş akışının adı
Görüntü adı
 displayName string

İş akışının görünen adı
Statü
 status string

İş akışı durumu
Scope
 scope string

İş akışı kapsamı
Kaynak Kimliği
 originatorId string

İş akışının ilk kaynağı
Kapsam Kimliği
 scopeId string

Kapsamın tanımlayıcısı. Şu anda yalnızca GROUP kapsamı için geçerlidir ve değer groupId olacaktır.

userWorkflowListV6

Kullanıcı iş akışı dizisi nesnesini içeren bir JSON

Name Yol Tür Description
İş Akışı Listesi
 userWorkflowList array of UserWorkflowV6

İş akışı öğeleri dizisi

WorkflowDefaultParamsV6

İş akışı varsayılan params nesnesi içeren bir JSON

Name Yol Tür Description
Varsayılan Değer
 defaultValue string

Bu alan için giriş sağlanmazsa ve bu alan gerekliyse alanın varsayılan değeri
Düzenlenebilir
 editable boolean

Geçerli alanın düzenlenip düzenlenemeyeceği. Bu alanın düzenlenebilir özniteliği false ise, bu alan sözleşme oluşturma isteğinde sağlanmamalıdır ve bu alanın varsayılan değeri sözleşme oluşturma işleminde kullanılır
Gerekli
 required boolean

Bu alanın gerekli mi yoksa isteğe bağlı mı olduğu
Görünür
 visible boolean

Geçerli alanın görünür olup olmadığı. Bu alanın görünür özniteliği false ise, bu alan kullanıcıya bu iş akışını kullanan sözleşme oluşturma kullanıcı arabiriminde görünmemelidir

CCsListInfoDescriptionV6

İş akışı hakkında ayrıntılı bilgi içeren bir JSON

Name Yol Tür Description
Varsayılan Değerler
 defaultValues array of string

Bu liste öğesi için giriş sağlanmazsa kullanılacak varsayılan e-posta dizisi
Düzenlenebilir
 editable boolean

Geçerli alanın düzenlenip düzenlenemeyeceği. Bu alanın düzenlenebilir özniteliği false ise, bu alan sözleşme oluşturma isteğinde sağlanmamalıdır ve bu alanın varsayılan değeri sözleşme oluşturma işleminde kullanılır
Etiket
 label string

İş akışı kullanıcısı için geçerli BILGI listesi için kullanılabilecek bir görüntüleme metni
En fazla CC girdisi
 maxListCount integer

Geçerli BILGI listesinde izin verilen en fazla girdi sayısı
En az BILGI girişi
 minListCount integer

Geçerli BILGI listesinde izin verilen en az girdi sayısı
BILGI Listesi Adı
 name string

Geçerli BILGI listesinin adı
Gerekli
 required boolean

Bu alanın gerekli mi yoksa isteğe bağlı mı olduğu
Görünür
 visible boolean

Geçerli alanın görünür olup olmadığı. Bu alanın görünür özniteliği false ise, bu alan bu iş akışı kullanılarak sözleşme oluşturma sayfasında gösterilmemelidir

ExpirationFieldInfoDescriptionV6

Süre sonu hakkında bilgi içeren bir JSON

Name Yol Tür Description
Varsayılan Değer
 defaultValue string

Bu alan için giriş sağlanmazsa ve bu alan gerekliyse alanın varsayılan değeri
Düzenlenebilir
 editable boolean

Geçerli alanın düzenlenip düzenlenemeyeceği. Bu alanın düzenlenebilir özniteliği false ise, bu alan sözleşme oluşturma isteğinde sağlanmamalıdır ve bu alanın varsayılan değeri sözleşme oluşturma işleminde kullanılır
Sözleşme Son Kullanma Tarihi En Fazla Gün
 maxDays integer

Sözleşmenin sona ermesi için en fazla gün sayısı
Gerekli
 required boolean

Bu alanın gerekli mi yoksa isteğe bağlı mı olduğu
Görünür
 visible boolean

Geçerli alanın görünür olup olmadığı. Bu alanın görünür özniteliği false ise, bu alan bu iş akışı kullanılarak sözleşme oluşturma sayfasında gösterilmemelidir

FileInfosDescriptionV6

Dosyalar hakkında bilgi içeren bir JSON

Name Yol Tür Description
Etiket
 label string

Dış kullanıcılar için bu alanın etiketini görüntüle
İsim
 name string

fileInfo öğesinin adı
Gerekli
 required boolean

Bu alanın gerekli mi yoksa isteğe bağlı mı olduğu
İş Akışı Kitaplığı Belgeleri
 workflowLibraryDocumentSelectorList array of WorkflowLibraryDocumentV6

Bu fileInfo nesnesiyle bir iş akışı kitaplığı belgesinin seçilebileceği iş akışı kitaplığı belgelerinin listesi

WorkflowLibraryDocumentV6

İş akışı kitaplığı belgesi hakkında bilgi içeren bir JSON

Name Yol Tür Description
Etiket
 label string

İş akışı kullanıcıları için bu formun görüntüleme metni
Değiştirme Tarihi
 modifiedDate string

Kitaplık belgesinin en son değiştirildiği tarih. Biçim yyyy-MM-dd'T'HH:mm:ssZ olacaktır. Örneğin, örneğin 2016-02-25T18:46:19Z UTC saatini temsil eder
Paylaşım Modu
 sharingMode string

Bu kitaplık belgesine kimlerin erişimi olması gerektiğini belirtir. GENEL paylaşım kısıtlanmış bir işlemdir
Şablon Türleri
 templateTypes array of

Bir veya daha fazla kitaplık şablonu türünün listesi
İş Akışı Kitaplığı Belge Kimliği
 workflowLibDoc string

Özel iş akışı sözleşmesi oluşturma isteğinde giriş dosyası olarak sağlanabilen iş akışı kitaplığı belgesinin kimliği

LocaleFieldInfoDescriptionV6

İş akışı yerel ayarı hakkında ayrıntılı bilgi içeren bir JSON

Name Yol Tür Description
Kullanılabilir Yerel Ayarlar
 availableLocales array of string

Bu iş akışı için hangi yerel ayarlar seçilebilir?
Varsayılan Değer
 defaultValue string

Bu alan için giriş sağlanmazsa ve bu alan gerekliyse alanın varsayılan değeri
Düzenlenebilir
 editable boolean

Geçerli alanın düzenlenip düzenlenemeyeceği. Bu alanın düzenlenebilir özniteliği false ise, bu alan sözleşme oluşturma isteğinde sağlanmamalıdır ve bu alanın varsayılan değeri sözleşme oluşturma işleminde kullanılır
Gerekli
 required boolean

Bu alanın gerekli mi yoksa isteğe bağlı mı olduğu
Görünür
 visible boolean

Geçerli alanın görünür olup olmadığı. Bu alanın görünür özniteliği false ise, bu alan kullanıcıya bu iş akışını kullanan sözleşme oluşturma kullanıcı arabiriminde görünmemelidir

MergeFieldInfoDescriptionV6

Birleştirme alanı hakkında ayrıntılı bilgi içeren bir JSON

Name Yol Tür Description
Varsayılan Değer
 defaultValue string

Bu alan için giriş sağlanmazsa ve bu alan gerekliyse alanın varsayılan değeri
Görüntü adı
 displayName string

Bu özel alan için gösterilebilen görüntüleme metni
Düzenlenebilir
 editable boolean

Geçerli alanın düzenlenip düzenlenemeyeceği. Bu alanın düzenlenebilir özniteliği false ise, bu alan sözleşme oluşturma isteğinde sağlanmamalıdır ve bu alanın varsayılan değeri sözleşme oluşturma işleminde kullanılır
Özel Alan Adı
 fieldName string

Bu iş akışındaki özel alanın adı
Gerekli
 required boolean

Bu alanın gerekli mi yoksa isteğe bağlı mı olduğu
Görünür
 visible boolean

Geçerli alanın sözleşme oluşturma sayfasında görünür olması gerekip gerekmediği. Bu alanın görünür özniteliği false ise, bu alan bu iş akışı kullanılarak sözleşme oluşturma sayfasında gösterilmemelidir

PasswordFieldInfoDescriptionV6

Parola hakkında ayrıntılı bilgi içeren bir JSON

Name Yol Tür Description
Şifre
 defaultValue string

Parola bilgisi alanının varsayılan değeri
Düzenlenebilir
 editable boolean

Geçerli alanın düzenlenip düzenlenemeyeceği. Bu alanın düzenlenebilir özniteliği false ise, bu alan sözleşme oluşturma isteğinde sağlanmamalıdır ve bu alanın varsayılan değeri sözleşme oluşturma işleminde kullanılır
Etiket
 label string

Parola alanı etiketi
İsim
 name string

Parola alanının adı
Gerekli
 required boolean

Bu alanın gerekli mi yoksa isteğe bağlı mı olduğu
Görünür
 visible boolean

Parola bilgileri alanının sözleşme oluşturma sayfasında görünür olup olmadığı

RecipientsListInfoDescriptionV6

Alıcılar listesi hakkında ayrıntılı bilgi içeren bir JSON

Name Yol Tür Description
Gönderene İzin Ver
 allowSender boolean

Gönderene alıcı olarak izin verilip verilmeyeceği
Gönderene İzin Ver
 allowfax boolean

Faksa izin verilip verilmeyeceği
Kimlik Doğrulama Yöntemi
 authenticationMethod string

Geçerli alıcı listesinin belgeyi görüntüleme ve imzalama erişimine sahip olması için kimlik doğrulama yöntemi,
Varsayılan E-posta/Faks Değeri
 defaultValue string

Varsayılan e-posta veya faks numarası
Düzenlenebilir
 editable boolean

Geçerli alanın düzenlenip düzenlenemeyeceği. Bu alanın düzenlenebilir özniteliği false ise, bu alan sözleşme oluşturma isteğinde sağlanmamalıdır ve bu alanın varsayılan değeri sözleşme oluşturma işleminde kullanılır
Etiket
 label string

İş akışı kullanıcısı için geçerli alıcılar listesi için kullanılabilecek bir görüntüleme metni
En fazla alıcı sayısı
 maxListCount integer

Geçerli alıcı listesinde izin verilen en fazla girdi sayısı
En düşük alıcılar
 minListCount integer

Geçerli alıcı listesinde izin verilen en az girdi sayısı
Alıcı Bilgi Listesinin Adı
 name string

Geçerli Alıcı Bilgileri listesinin adı
Katılımcı Rolü
 role string

Katılımcının geçerli rolü
Görünür
 visible boolean

Geçerli alanın görünür olup olmadığı. Bu alanın görünür özniteliği false ise, bu alan kullanıcıya bu iş akışını kullanan sözleşme oluşturma kullanıcı arabiriminde gösterilmemelidir

WorkflowDescriptionV6

İş akışı hakkında ayrıntılı bilgi içeren bir JSON

Name Yol Tür Description
agreementNameInfo
 agreementNameInfo WorkflowDefaultParamsV6

İş akışı varsayılan params nesnesi içeren bir JSON
authoringInfo
 authoringInfo WorkflowDefaultParamsV6

İş akışı varsayılan params nesnesi içeren bir JSON
CC Liste Bilgileri
 ccsListInfo array of CCsListInfoDescriptionV6

Sözleşme oluşturma isteğindeki BILGI listesi giriş alanı hakkında bilgi
İş Akışı Oluşturma Tarihi
 created string

İş akışının oluşturulduğu gün
İş Akışı Açıklaması
 description string

Bu iş akışı için oluşturulduğu sırada sağlanan açıklama
İş Akışı Görünen Adı
 displayName string

İş akışının görünen adı
expirationInfo
 expirationInfo ExpirationFieldInfoDescriptionV6

Süre sonu hakkında bilgi içeren bir JSON
Dosya Bilgileri
 fileInfos array of FileInfosDescriptionV6

Sözleşme oluşturma isteğindeki dosya bilgileri giriş alanı hakkında bilgi
localeInfo
 localeInfo LocaleFieldInfoDescriptionV6

İş akışı yerel ayarı hakkında ayrıntılı bilgi içeren bir JSON
Alanları Birleştir Bilgileri
 mergeFieldsInfo array of MergeFieldInfoDescriptionV6

Sözleşme oluşturma isteğindeki özel bilgi girişi alanı hakkında bilgi
messageInfo
 messageInfo WorkflowDefaultParamsV6

İş akışı varsayılan params nesnesi içeren bir JSON
Değiştirme Tarihi
 modified string

İş akışının son değiştirildiği gün
İş Akışı Adı
 name string

İş akışının adı
passwordInfo
 passwordInfo PasswordFieldInfoDescriptionV6

Parola hakkında ayrıntılı bilgi içeren bir JSON
Alıcı Listesi Bilgileri
 recipientsListInfo array of RecipientsListInfoDescriptionV6

Sözleşme oluşturma isteğindeki reseptör bilgileri giriş alanı hakkında bilgi
İş Akışı Kapsamı
 scope string

İş akışı kapsamı
İş Akışı Durumu
 status string

İş akışı durumu
İş Akışı Kaynak Kimliği
 originatorId string

İş akışının ilk kaynağı
İş Akışı Kapsam Kimliği
 scopeId string

Kapsamın tanımlayıcısı. Şu anda yalnızca GRUP kapsamı için geçerlidir ve değer groupId olur

BooleanSettingInfoV6

Name Yol Tür Description
Değer
 value boolean

Ayarın değeri
Devralınan
 inherited boolean

Ayarın grup veya hesap değerinden devralınmış olması durumunda True

AyarlarBilgiV6

Name Yol Tür Description
libaryDocumentCreationVisible
 libaryDocumentCreationVisible BooleanSettingInfoV6
sendRestrictedToWorkflows
 sendRestrictedToWorkflows BooleanSettingInfoV6
userCanSend
 userCanSend BooleanSettingInfoV6
widgetCreationVisible
 widgetCreationVisible BooleanSettingInfoV6

UserGroupInfoV6

Name Yol Tür Description
Grup Kimliği
 id string

Grubun benzersiz tanımlayıcısı
Grup Yöneticisi
 isGroupAdmin boolean

Kullanıcı grup yöneticisiyse True
Birincil Grup
 isPrimaryGroup boolean

Grup kullanıcının birincil grubuysa True
Statü
 status string

Grup üyeliğinin durumu
Oluşturulma Tarihi
 createdDate date

Tarih grubu oluşturuldu
Grup Adı
 name string

Grubun adı
settings
 settings SettingsInfoV6

UserGroupsInfoV6

Belirli bir kullanıcı için grupların listesini içeren bir JSON

Name Yol Tür Description
Kullanıcı Grupları Listesi
 groupInfoList array of UserGroupInfoV6

Kullanıcı grubu bilgi öğeleri dizisi

AgreementViews

Sözleşme görünümlerinin listesi

Name Yol Tür Description
Sözleşme Görünüm Listesi
 agreementViewList array of AgreementView

Sözleşme Görünümleri

AgreementView

Gerekli görünümün adı ve istenen yapılandırma.

Name Yol Tür Description
URL'yi görüntüle
 url string

Kaynak konumunun url'si
Ekli Kod
 embeddedCode string

Kaynağın URL'sinin eklenmiş kodu
Süre Sonu
 expiration string

Kullanıcı url'sinin süre sonu
Geçerli Görünümdür
 isCurrent boolean

Bu görünüm geçerli görünümse True

ikili

Bu, 'ikili' temel veri türüdür.

object

Bu , 'object' türüdür.

file

Bu, 'file' temel veri türüdür.