Servis Tanımları

21 Jan 2025
16 Minutes to read

Dark
Light

Servis Tanımları

Updated on 21 Jan 2025
16 Minutes to read

Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Servis Tanımları

Servis Tanımları ekranı, PaperWork arayüzünü kullanmadan -SDK (Software Development Kit) fonksiyonları ile- seçilen metota göre kayıt oluşturmaya (Listelerin değerlerini getirir) olanak sağlamaktadır.

"Servis Metodu" listesinden metot seçilir ve parametre seçiminize göre link üretilir.

Detay

Adı : Girilecek servis tanımı adıdır.

Durumu : Üretilecek linkin aktifliğini belirler.

Tasarım Yetki Seti : Oluşturulan tanıma ait yetki seti seçimidir.

Başlatan Kullanıcı : Yapılacak işlemin hangi kullanıcı tarafından yapılacağını belirler. Yapılacak işlemin takibi için önemlidir. Seçilen kullanıcının session süresi üzerinden takip edilebilir.

Süreli/Süresiz Anahtar : Linki süreli veya süresiz olacak şekilde oluşturabilirsiniz. Süreli seçilmesi halinde "Son Geçerlilik Tarihi" alanı aktif hale gelecektir.

Son Geçerlilik Tarihi : Süreli Anahtar seçilmesi durumunda, linkin hangi tarihe kadar geçerli olacağını belirleyebilirsiniz.

Servis Metotu : Metot seçim listedir.

Açıklama : Tanımla ilgili not ekleyebileceğiniz alandır.

Kayıt İşleminin Ardından Değiştirilemeyen Alanlar

Kaydet tuşunun tıklanmasıyla birlikte "Başlatan Kullanıcı", "Süreli/Süresiz Anahtar", "Son Geçerlilik Tarihi" ve "Servis Metodu" alanları salt okunur olacaktır.

Parametreler

Seçilen metota göre "Parametreler" ekranı değişiklik gösterir. Aşağıda sırasıyla bu metotlara göre bilgiler verilecektir.

İstek Oluştur : Girilen parametreler doğrultusunda link üretir. Bütün metot seçimleri için ortaktır.

1) Servis Metodu Yeni Akış Başlat ise;

Süreç ve Eklenti seçimleri gelmektedir. Süreç seçimi zorunludur.

1.1) Eklenti seçilmemesi durumunda;

1.2) Eklenti seçilmesi durumunda;

Eklenti seçimiyle birlikte "Dosya Kartı" ve "Belge" seçimlerine göre de 2 farklı durum mevcuttur.

1.2.1) Eklentisi Dosya Kartı seçilmesi durumunda;

Dosya Kartı : Kullanılacak dosya kartı seçilmelidir. Zorunlu alandır.

Seperatör : Seçilen dosya kartının altındaki klasörleri listeler.

Belge Tipi : Sistem veya Arşiv tipi seçim listesidir. Sistemde var olan bütün arşiv tipleri listelenir.

Kabinet Yolu : Eklentinin oluşacağı klasör yoludur. Seçilen akış tipine ait alanlar da seçilebilir.

1.2.1) Eklentisi Belge seçilmesi durumunda;

"Belge Tipi" ve "Kabinet Yolu" alanları zorunludur.

Yeni Akış Başlat Servis Metodunda, Eklentisi Dosya Kartı veya Belge Seçilmesi Durumunda Belge Tipi Seçimi

Her iki durum için de belge tipi seçilmiş ise, belge verisi oluşacak linkin sonuna eklenmelidir. Belgesiz Form oluşturulamaz.

2) Servis Metodu Yeni Kart Oluştur ise;

"Dosya Kartı" ve "Kabinet Yolu" alanları zorunludur.

"Kabinet Yolu" listesine, seçilen Dosya Kartı taslağının bağlı olduğu tipte yer alan "Yazı", "Tarih" ve "TarihSaat" alanları gelmektedir.

Yeni Kart Servis Metodunda Belge Tipi Seçilmesi Halinde

Belge tipi seçilmesi halinde belge verisi oluşacak linkin sonuna eklenmelidir. Belgesiz Form oluşturulamaz.

3) Servis Metodu Yeni Doküman Oluştur ise;

"Belge Tipi" ve "Kabinet Yolu" alanları zorunludur.

"Kabinet Yolu" listesine, seçilen Dosya Kartı taslağının bağlı olduğu tipte yer alan "Yazı", "Tarih" ve "TarihSaat" alanları gelmektedir.

Yeni Doküman Servis Metodunda Belge Tipi Seçimi Sonrası

Belge tipi seçiminin ardından belge verisi, oluşacak linkin sonuna eklenmelidir. Belgesiz Form oluşturulamaz.

4) Servis Metodu Liste Detayı Getir ise;

"Liste Adı" alanı zorunludur.

5) Servis Metodu Form ile Akış Başlatma ise;

Bu metod ile, üretilen linkin web sayfası üzerinden ya da mobil cihazlardan çalıştırılıp, ilgili akışın başlangıç formuna hızlı ve kolay bir erişim ve sonrasında ise hızlı ve daha kolay bir şekilde akış başlatma işleminin sağlanması amaçlanmıştır.

5) Servis Metodu Kayıt Yönetimi Formu ise;

Bu metot, üretilen link aracılığı ile "Veri Yönetimi" altında oluşturulmuş kayıtların, hızlı ve kolay bir şekilde görüntülenmesi ve düzenlenmesi amacı ile oluşturulmuştur.

Test Ekranı

Detay seçimi ve girilen parametreler doğrultusunda linkin üretildiği ekrandır.

1) "Yeni Akış Oluştur", "Yeni Kart Oluştur", "Yeni Doküman Oluştur" ve "Liste Detayı Getir" metotları için Test ekranı;

Metot seçimlerine göre "Giriş" alanındaki link, Metota göre aksiyon tipi ve isteğin çalıştırılması sonrası "Sonuç" penceresindeki değer değişiklik gösterecektir.

Not : Test ekranındaki herhangi bir değer kaydedilemez.

İstek Oluştur tuşunun tıklanmasıyla karşımıza şöyle bir ekran gelecektir;

Çalıştır tuşunun tıklanmasıyla link çalışacaktır ve "Sonuç" alanına linkten dönen değer yansıyacaktır.

Giriş : Parametreler ekranında girilen değerlere göre "İstek Oluştur" tuşu ile istek oluşturulur ve istek şablonu "Giriş" alanına yansıtılır. Akış, Dosya Kartı ve Doküman tip alanlarına atanması istenen değerler, bu link içerisindeki “data” parametresinde düzenlenmelidir.

Sonuç : "Çalıştır" tuşu ile linkin çalıştırılması sonucu dönen değer bu alana yansıtılır.

Örnek C# Kod için Tıklayınız : Oluşacak linkin parametre olarak verilmesi ile "Sonuç" penceresindeki değeri döndürecek kod parçasıdır. Tüm metotlar için aynı kod parçası gelir ve geçerlidir. Linke tıklanıldığı an bir pop-up açılır ve içerisinde ilgili kod parçası görülür. Pop-up içerisindeki "Panoya Kopyala" tuşu ile kodun tamamı kopyalanabilir.

Aksiyon Tipi : Başlığı yoktur. [HttpPost] ve [HttpGet] şeklinde 2 tane değeri vardır. "Liste Detayı Getir" için [HttpGet], diğer metodlar için [HttpPost] değeri gelmelidir.

Çalıştır : Parametreler sekmesinde girilen değerler sonrası oluşturulan istek URL adresini çalıştırmak için kullanılır.

Belge Seç : Parametreler ekranında girilen değerler ile oluşturulan link test edilmek istenirse, belge eklemenin gerektiği kısımlar için bu tuş kullanılabilir. Tuşun tıklanması sonrasında çıkan pop-up’dan belge seçilir ve elde edilen değer otomatik olarak linkin sonuna, verinin verilmesi gereken attachment parametresinin karşılığı olarak eklenir.

2) "Form ile Akış Başlatma" ve "Kayıt Yönetimi Formu" metotları için Test ekranı;

"Form ile Akış Başlatma" metotu ve "Kayıt Yönetimi Formu" metotu için "Test" ekranındaki tek fark, iframe kod örneği linkidir.

Bu link "Form ile Akış Başlatma" metotunda bulunurken "Kayıt Yönetimi Formu" metotunda bulunmamaktadır.

Giriş : Oluşturulan linkin gösterildiği alandır. Linkin açılması başlatılması istenen akışın başlangıç formunu ekrana getirecektir.

Çalıştır : Çalıştır tuşu ile Giriş kutucuğunda yazan link yeni bir tarayıcı sekmesinde açılacaktır.

QRCode : Oluşturulmuş olan linkin QRCode’a çevirilmiş halidir. Mobil cihazlardan okutma sonrası, cihazın tarayıcısı ile başlatılması istenen akışın başlangıç formu görüntülenecektir.

Resim Olarak Kaydet: Oluşmuş olan QRCode’u png formatta kaydetmek için kullanılır.

“Web sayfası içerisinde iframe kullanımı örneği için tıklayınız.” Linki: Bir pop-up içerisinde, giriş kutucuğunda yazan linkin iframe kullanılarak bir web sayfası içerisine nasıl gömüleceği ile ilgili kısa bir örnek gösterir.

Bu örnekle beraber iframe kullanımı ile ilgili dikkat edilmesi gereken durumlar ve uygulamanın web.config dosyasında konfigüre edilmesi gereken kısımlar belirtilmiştir.

Örnek İstek Linkleri

1) Örnek olarak dosya kartı eklentili ve belgeli oluşturulmak istenen akışın linki şu şekildedir;

https://PWARGDEVNXT.g-gsoft.com/External/CreateWorkflowWithAttachments?token=VXh5SHpTbllQSk1pWGRBWVBDNUl2Z3ZicVk1Nkp5ZU1ZZ2s1NnhnZXFEZDlHM0JHVGE0R0dpQkRNNkhOdFF0RFYrL1pJQ2ppdUUvN3BEaUp5TDB4d2xYYmxqa2dmYVNtOUhKdjg2dHBTT3BFVG8yM2FNQkhnZkpqVGVQSzJ6ek91OGQxVVdvYjgwTXBxVFkvR2dYaFpBPT0=&key=4LcVF1lris6VLD1cHboDkReGg2HsbxevsdfcQ11yRn0My6qB3vEC4o8s24pGWTUP&aName=Bug bildirim test ayse&aMasterId=5098910000000142&cabinet=abercinKabinetTest\2024\{AD_SOYAD}&docType=T_SENTEGRATOR&data={"Flow":{"Name":"Bug Bildirim Süreci","Description":"Description","TypeName":"T_BUG_BILDIRIM_AKIS_TIPI","MasterId":"5098910000000142","DocumentData":"","DocumentPath":"","Priority":0,"Owner":"abercin","AttachmentId":"","FileName":"file.txt","Path":"","TypeData":{"AD_SOYAD":null,"TALEP_TARIHI":null,"_TALEP_TARIHI":null,"TALEP_SAATI":null,"_TALEP_SAATI":null,"TALEP_TARIH_SAATI":null,"_TALEP_TARIH_SAATI":null,"TALEP_ADET":0,"TALEP_FIYAT":0.0,"MANTIS_BILGILERI":[{"MANTIS_ADET":0,"MANTIS_ACIKLAMA":null,"MANTIS_TARIH":null,"_MANTIS_TARIH":null,"MANTIS_SAAT":null,"_MANTIS_SAAT":null,"MANTIS_TARIH_SAAT":null,"_MANTIS_TARIH_SAAT":null,"AKIS_ONCELIGI":null}],"OBJECT_ID":"","OBJECT_TYPE":"","CONTENT_TYPE":"DOC","PARENT_ID":"","FOLDER_ID":"","IS_VIRTUAL_

DOC":false,"ACL_ID":"","FILE_FORMAT":"","FORM_NAME":"Base","FORM_VERSION":"1","VIRTUAL_DOC_ID":"","OBJECT_DESCR":""}},"Doc":{"FATURA_ETTN":null,"FATURA_NO":null,"FATURA_TARIHI":null,"_FATURA_TARIHI":null,"FATURA_TIPI":null,"SATICI_ADI":null,"SATICI_VKN":null,"OBJECT_ID":"","OBJECT_TYPE":"","CONTENT_TYPE":"DOC","PARENT_ID":"","FOLDER_ID":"","IS_VIRTUAL_DOC":false,"ACL_ID":"","FILE_FORMAT":"","FORM_NAME":"Base","FORM_VERSION":"1","VIRTUAL_DOC_ID":"","OBJECT_DESCR":""}}&attachment={"filename":"test.txt","fileContent":"YXnFn2UgdGVzdA=="}

Yukarıdaki linki detaylı incelersek;

Tüm metodlar için sabit kalacak kısım, https://PWARGDEVNXT.g-gsoft.com/External/ şeklindedir. Bu PaperWork’ün adresidir. Ortam adresi ne ise External öncesi bu adres olacaktır. Eğer ayrıca port varsa External öncesi port da yazacaktır.

Token parametresine kadar olan kısım metodun ismidir, bu örnekte “CreateWorkflowWithAttachments” şeklindedir.

? sonrası gelecek değerler metodun parametrelerini ifade eder.

CreateWorkflowWithAttachments için Parametreler:

Bu metod eklentili akışlar için kullanılır. Başlatılacak akışlara eklenti olarak sadece bir tane belge eklenebilir.

token: Yeni tanım oluşturulup ilk kaydetme işlemi sonrası arka planda token oluşturulur. Bu token arka planda tutulur, ekranlarda gösterilmez. Linklerin oluşturulacağı ve çalıştırılacağı sırada arka plandan çekilir ve parametreye eklenerek kullanılır. Zorunludur.

key: Müşterilere özel bir anahtar değeridir. Parametreler ekranındaki social key alanından alınır. Zorunludur.

aName: Akış başlatma metodu seçilmiş ise linkte bulunacak parametredir. Başlatılacak akışa verilecek isimdir. Zorunludur.

aMasterId: Akış başlatma metodu seçilmiş ise linkte bulunacak parametredir. Başlatılacak akışın master id değeridir. Zorunludur.

data: Akış, dosya kartı ve arşiv için tip alanlarının değerlerini tutan bir json nesnesidir. Akışların eklenti çeşidine, eklentili olup olmamasına göre içerisindeki değerler değişecektir. Akış alanları için json veri içerisinde Flow, dosya kartı alanları için Card, doküman alanları için de Doc adında bir nesne içerir. Zorunludur.

cabinet: Oluşturulacak akış eklentili ise, eklentinin kaydedileceği kabinet ve alt klasör yolunu ifade eder. Kabinet yolu alanından, kabinet ve altında hali hazırda bulunan klasörlerden alt klasör yolu seçilebilir. İstenirse akışın bağlı olduğu tip alanları kullanılarak klasör yolu devam ettirilebilir. Tip alanında bulunan değere sahip isimde bir klasör yoksa oluşturulur, var ise oluşturulmaz. Zorunludur.

cardName: Oluşturulacak akışın eklentisi dosya kartı ise, oluşturulması istenen dosya kartının taslak adı verilmelidir. Opsiyoneldir. Eklenti arşiv olacaksa ve akışın eklentisi olmayacaksa gönderilmez.

seperator: Eklenti olarak dosya kartı oluşturuluyor ve bu dosya kartı içerisine belge eklenmek isteniyorsa, bu belgenin dosya kartı içerisinde kaydedilmek istendiği seperatör ismi verilmelidir. Opsiyoneldir. Akışın eklentisi dosya kartı olmayacaksa ya da dosya kartına belge eklenmeyecekse gönderilmez.

docType: Eklentiye eklenecek belgenin tip adı verilmelidir. Opsiyoneldir. Akışa belge eklenmeyecekse gönderilmez.

attachment: Akışa eklenecek belgenin json verisidir. Opsiyoneldir. Belge tipi seçilmemiş ise gönderilmez. Json veri alanları filename ve fileContent’dir. Filename alanında belgenin formatı ile ismi yazar. fileContent alanında ise belgenin base64 verisi yazar.

2) Örnek dosya kartı ve belge eklentisine sahip akış isteği;

https://PWARGDEVNXT.g-gsoft.com/External/CreateWorkflowWithAttachments?token=OGxxMHJESXVjVTNQTGtwSmRiZlExSGZjeVhWRmMyc2xteWRZdURORTFLKzIxelIxcHczanBENWNpblJQVy81TVNMYUZuRUxaNjRFVTcxMXI4b0haTzBmWXd3Y2IwVzYzc0FvZUdIOWhEQlg0Tis5Mi9SUnZDaDF1aUxEMXo1a3BwWm9jTFNQSVhHckwrVEFCdmlEbDlBPT0=&key=4LcVF1lris6VLD1cHboDkReGg2HsbxevsdfcQ11yRn0My6qB3vEC4o8s24pGWTUP&aName=02-12-2024 10:12:03 - Proje Yönetimi Süreci&aMasterId=5098910000000157&cabinet=Proje Yönetimi&cardName=DOSYA_KARTI_FF98910000003A54&seperator=Genel&docType=T_PROJE_DOKUMANLARI&data={"Flow":{"Name":"Proje Yönetimi Süreci","Description":"Description","TypeName":"T_PROJE_YONETIM_AKIS_TIPI","MasterId":"5098910000000157","DocumentData":"","DocumentPath":"","Priority":0,"Owner":"abercin","AttachmentId":"","FileName":"file.txt","Path":"","TypeData":{"ACIKLAMA":null,"AD_SOYAD":null,"ONAY_SAATI":null,"_ONAY_SAATI":null,"TALEP_TARIHI":null,"_TALEP_TARIHI":null,"URUN_BILGILERI":[{"URUN_ADI":null,"URUN_GONDERIM_SAATI":null,"_URUN_GONDERIM_SAATI":null,"URUN_GONDERIM_TARIHI":null,"_URUN_GONDERIM_TARIHI":null}],"OBJECT_ID":"","OBJECT_TYPE":"","CONTENT_TYPE":"DOC","PARENT_ID":"","FOLDER_ID":"","IS_VIRTUAL_DOC":false,"ACL_ID":"","FILE_FORMAT":"","FORM_NAME":"Base","FORM_VERSION":"1","VIRTUAL_DOC_ID":"","OBJECT_DESCR":""}},"Card":{"AD_SOYAD":null,"OBJECT_ID":"","OBJECT_TYPE":"","CONTENT_TYPE":"DOC","PARENT_ID":"","FOLDER_ID":"","IS_VIRTUAL_DOC":false,"ACL_ID":"","FILE_FORMAT":"","FORM_NAME":"Base","FORM_VERSION":"1","VIRTUAL_DOC_ID":"","OBJECT_DESCR":""},"Doc":{"AD_SOYAD":null,"OBJECT_ID":"","OBJECT_TYPE":"","CONTENT_TYPE":"DOC","PARENT_ID":"","FOLDER_ID":"","IS_VIRTUAL_DOC":false,"ACL_ID":"","FILE_FORMAT":"","FORM_NAME":"Base","FORM_VERSION":"1","VIRTUAL_DOC_ID":"","OBJECT_DESCR":""}}&attachment={"filename":"test.txt","fileContent":"YXnFn2UgdGVzdA=="}

Örnek sonuç:

{"Result":"AB9891000000018E","ErrorCode":0,"Message":"","UserData":null}

Sonuç alanları:

ErrorCode: CreateWorkflowWithAttachments servisinde hata alınması sonucu dönecek hata kodudur. Hata yok ise ErrorCode 0’dır.

Message: CreateWorkflowWithAttachments servisinde hata alınması sonucu dönecek hata mesajıdır. Hata yok ise Message boştur.

Result: CreateWorkflowWithAttachments servisinin dönüş verisini tutan alandır. Servis hata almış ise boştur.

UserData: Paperworkte tanımlı GenericResult class tanımına ait bir alandır. Custom yazılmış metodlar için istenilen değerleri saklar. Bu fonksiyon için herhangi bir senaryoda verisi bulunmayacaktır.

3) Örnek dosya kartı eklentili akış isteği;

https://PWARGDEVNXT.g-gsoft.com/External/CreateWorkflowWithAttachments?token=OGxxMHJESXVjVTNQTGtwSmRiZlExSGZjeVhWRmMyc2xteWRZdURORTFLKzIxelIxcHczanBENWNpblJQVy81TVNMYUZuRUxaNjRFVTcxMXI4b0haTzBmWXd3Y2IwVzYzc0FvZUdIOWhEQlg0Tis5Mi9SUnZDaDF1aUxEMXo1a3BwWm9jTFNQSVhHckwrVEFCdmlEbDlBPT0=&key=4LcVF1lris6VLD1cHboDkReGg2HsbxevsdfcQ11yRn0My6qB3vEC4o8s24pGWTUP&aName=02-12-2024 10:26:44 - Proje Yönetimi Süreci&aMasterId=5098910000000157&cabinet=Proje Yönetimi&cardName=DOSYA_KARTI_FF98910000003A54&data={"Flow":{"Name":"Proje Yönetimi Süreci","Description":"Description","TypeName":"T_PROJE_YONETIM_AKIS_TIPI","MasterId":"5098910000000157","DocumentData":"","DocumentPath":"","Priority":0,"Owner":"abercin","AttachmentId":"","FileName":"file.txt","Path":"","TypeData":{"ACIKLAMA":null,"AD_SOYAD":null,"ONAY_SAATI":null,"_ONAY_SAATI":null,"TALEP_TARIHI":null,"_TALEP_TARIHI":null,"URUN_BILGILERI":[{"URUN_ADI":null,"URUN_GONDERIM_SAATI":null,"_URUN_GONDERIM_SAATI":null,"URUN_GONDERIM_TARIHI":null,"_URUN_GONDERIM_TARIHI":null}],"OBJECT_ID":"","OBJECT_TYPE":"","CONTENT_TYPE":"DOC","PARENT_ID":"","FOLDER_ID":"","IS_VIRTUAL_DOC":false,"ACL_ID":"","FILE_FORMAT":"","FORM_NAME":"Base","FORM_VERSION":"1","VIRTUAL_DOC_ID":"","OBJECT_DESCR":""}},"Card":{"AD_SOYAD":null,"OBJECT_ID":"","OBJECT_TYPE":"","CONTENT_TYPE":"DOC","PARENT_ID":"","FOLDER_ID":"","IS_VIRTUAL_DOC":false,"ACL_ID":"","FILE_FORMAT":"","FORM_NAME":"Base","FORM_VERSION":"1","VIRTUAL_DOC_ID":"","OBJECT_DESCR":""}}

Örnek sonuç tüm eklenti tipleri için aynıdır.

4) Örnek arşiv eklentili akış isteği;

https://PWARGDEVNXT.g-gsoft.com/External/CreateWorkflowWithAttachments?token=OGxxMHJESXVjVTNQTGtwSmRiZlExSGZjeVhWRmMyc2xteWRZdURORTFLKzIxelIxcHczanBENWNpblJQVy81TVNMYUZuRUxaNjRFVTcxMXI4b0haTzBmWXd3Y2IwVzYzc0FvZUdIOWhEQlg0Tis5Mi9SUnZDaDF1aUxEMXo1a3BwWm9jTFNQSVhHckwrVEFCdmlEbDlBPT0=&key=4LcVF1lris6VLD1cHboDkReGg2HsbxevsdfcQ11yRn0My6qB3vEC4o8s24pGWTUP&aName=02-12-2024 10:32:59 - Proje Yönetimi Süreci&aMasterId=5098910000000157&cabinet=Proje Yönetimi&docType=T_PROJE_DOKUMANLARI&data={"Flow":{"Name":"Proje Yönetimi Süreci","Description":"Description","TypeName":"T_PROJE_YONETIM_AKIS_TIPI","MasterId":"5098910000000157","DocumentData":"","DocumentPath":"","Priority":0,"Owner":"abercin","AttachmentId":"","FileName":"file.txt","Path":"","TypeData":{"ACIKLAMA":null,"AD_SOYAD":null,"ONAY_SAATI":null,"_ONAY_SAATI":null,"TALEP_TARIHI":null,"_TALEP_TARIHI":null,"URUN_BILGILERI":[{"URUN_ADI":null,"URUN_GONDERIM_SAATI":null,"_URUN_GONDERIM_SAATI":null,"URUN_GONDERIM_TARIHI":null,"_URUN_GONDERIM_TARIHI":null}],"OBJECT_ID":"","OBJECT_TYPE":"","CONTENT_TYPE":"DOC","PARENT_ID":"","FOLDER_ID":"","IS_VIRTUAL_DOC":false,"ACL_ID":"","FILE_FORMAT":"","FORM_NAME":"Base","FORM_VERSION":"1","VIRTUAL_DOC_ID":"","OBJECT_DESCR":""}},"Doc":{"AD_SOYAD":null,"OBJECT_ID":"","OBJECT_TYPE":"","CONTENT_TYPE":"DOC","PARENT_ID":"","FOLDER_ID":"","IS_VIRTUAL_DOC":false,"ACL_ID":"","FILE_FORMAT":"","FORM_NAME":"Base","FORM_VERSION":"1","VIRTUAL_DOC_ID":"","OBJECT_DESCR":""}}&attachment={"filename":"test.txt","fileContent":"YXnFn2UgdGVzdA=="}

Örnek sonuç tüm eklenti tipleri için aynıdır.

CreateWorkflow için Parametreler:

Eklentisiz akışlar için kullanılır.

key: Müşterilere özel bir anahtar değeridir. Parametreler ekranındaki social key alanından alınır. Zorunludur.

aName: Akış başlatma metodu seçilmiş ise linkte bulunacak parametredir. Başlatılacak akışa verilecek isimdir. Zorunludur.

aMasterId: Akış başlatma metodu seçilmiş ise linkte bulunacak parametredir. Başlatılacak akışın master id değeridir. Zorunludur.

Örnek İstek:

https://PWARGDEVNXT.g-gsoft.com/External/CreateWorkflow?token=M0JHSHhGMjhzRzUwR2I2MUZKRUNSM1VuZWNLLzlGTU8wK0NrSUpVNjRubG5VYmYyTjNvVkdDV01nOHp3MkpML29uY2NiTnZYU1JnR3I0NjVwNFpCVitjbFdDWldBbjdoc2h5NWVxeXArNVdSSHZFL1BkVlFHVnAvVWJMWnZrSFlSOXpma0pDaVYzR3ZUQXdqeG9qQmJRPT0=&key=4LcVF1lris6VLD1cHboDkReGg2HsbxevsdfcQ11yRn0My6qB3vEC4o8s24pGWTUP&aName=Bug bildirim test ayse&aMasterId=5098910000000157&data={ "Name": "Proje Yönetimi Süreci", "Description": "Description", "TypeName": "T_PROJE_YONETIM_AKIS_TIPI", "MasterId": "5098910000000157", "DocumentData": "", "DocumentPath": "", "Priority": 0, "Owner": "abercin", "AttachmentId": "", "FileName": "file.txt", "Path": "", "TypeData": { "ACIKLAMA": null, "AD_SOYAD": null, "ONAY_SAATI": null, "_ONAY_SAATI": null, "TALEP_TARIHI": null, "_TALEP_TARIHI": null, "URUN_BILGILERI": [ { "URUN_ADI": null, "URUN_GONDERIM_SAATI": null, "_URUN_GONDERIM_SAATI": null, "URUN_GONDERIM_TARIHI": null, "_URUN_GONDERIM_TARIHI": null } ], "OBJECT_ID": "", "OBJECT_TYPE": "", "CONTENT_TYPE": "DOC", "PARENT_ID": "", "FOLDER_ID": "", "IS_VIRTUAL_DOC": false, "ACL_ID": "", "FILE_FORMAT": "", "FORM_NAME": "Base", "FORM_VERSION": "1", "VIRTUAL_DOC_ID": "", "OBJECT_DESCR": "" }}

Örnek Sonuç:

{"Result":"AB9891000000018C","ErrorCode":0,"Message":"","UserData":null}

Sonuç alanları:

ErrorCode: CreateWorkflow servisinde hata alınması sonucu dönecek hata kodudur. Hata yok ise ErrorCode 0’dır.

Message: CreateWorkflow servisinde hata alınması sonucu dönecek hata mesajıdır. Hata yok ise Message boştur.

Result: CreateWorkflow servisinin dönüş verisini tutan alandır. Servis hata almış ise boştur.

CreateCard için Parametreler:

Kart oluşturmak için kullanılır. Oluşturulacak dosya kartına sadece bir tane belge eklenebilir.

key: Müşterilere özel bir anahtar değeridir. Parametreler ekranındaki social key alanından alınır. Zorunludur.

cardName: Oluşturulması istenen dosya kartının taslak adı verilir. Zorunludur.

cabinet: Dosya kartının kaydedileceği kabinet ve alt klasör yolunu ifade eder. Kabinet yolu alanından, kabinet ve altında hali hazırda bulunan klasörlerden alt klasör yolu seçilebilir. İstenirse dosya kartının bağlı olduğu tip alanları kullanılarak klasör yolu devam ettirilebilir. Tip alanında bulunan değere sahip isimde bir klasör yoksa oluşturulur, var ise oluşturulmaz. Zorunludur.

seperator: Oluşturulması istenen karta belge eklenecekse, belgenin içerisine ekleneceği seperatörün ismi verilmelidir. Opsiyonel. Belge tipi seçilmemiş ise gönderilmez.

docType: Oluşturulması istenen dosya kartı içerisine belge eklenecekse, eklenecek belgenin tipi seçilmelidir. Tip adı gönderilir. Opsiyoneldir. Belge eklenmeyecek ise gönderilmez.

attachment: Dosya kartına eklenecek belgenin json verisidir. Opsiyoneldir. Belge tipi seçilmemiş ise gönderilmez. Json veri alanları filename ve fileContent’dir. Filename alanında belgenin formatı ile ismi yazar. fileContent alanında ise belgenin base64 verisi yazar.

5) Örnek belgesiz kart isteği;

Örnek sonuç:

{"Result":"FF98910000003A30","ErrorCode":0,"Message":"","UserData":null}

Sonuç alanları:

ErrorCode: CreateCard servisinde hata alınması sonucu dönecek hata kodudur. Hata yok ise ErrorCode 0’dır.

Message: CreateCard servisinde hata alınması sonucu dönecek hata mesajıdır. Hata yok ise Message boştur.

Result: CreateCard servisinin dönüş verisini tutan alandır. Servis hata almış ise boştur.

6) Örnek belgeli kart isteği;

https://PWARGDEVNXT.g-gsoft.com/External/CreateCard?token=NlpLVGJkTkVtZUtUd2w5Vlo0WUpWaWZFV2dPM21UbFduNEFCaGF5d1JmcEJ3M09teXhIUFJYRWgrK05iakpLYXJ6cFNGNWVyOThZNWdYNUhQeWU1OTB1QWQrbUY5cTNJODIxc0VudTU2clVKSVJZWFpiRGVONGZWOFY5Y1VlYUw=&key=4LcVF1lris6VLD1cHboDkReGg2HsbxevsdfcQ11yRn0My6qB3vEC4o8s24pGWTUP&cardName=DOSYA_KARTI_FF00200000006EEB&cabinet=Araç Bilgileri&seperator=Form1&data={"Card":{"ARAC_KODU":"1234","OBJECT_ID":"","OBJECT_TYPE":"","CONTENT_TYPE":"DOC","PARENT_ID":"","FOLDER_ID":"","IS_VIRTUAL_DOC":false,"ACL_ID":"","FILE_FORMAT":"","FORM_NAME":"Base","FORM_VERSION":"1","VIRTUAL_DOC_ID":"","OBJECT_DESCR":""},"Doc":{"ADI_SOYADI":"test kullanıcısı","ARAC_MARKA_LISTESI":null,"ARAC_PLAKA_SECIMI":null,"KIRALAMA_BITIS_TARIHI":null,"_KIRALAMA_BITIS_TARIHI":null,"KIRALAMA_NEDENI":null,"KIRALAMA_TARIHI":null,"_KIRALAMA_TARIHI":null,"OBJECT_ID":"","OBJECT_TYPE":"","CONTENT_TYPE":"DOC","PARENT_ID":"","FOLDER_ID":"","IS_VIRTUAL_DOC":false,"ACL_ID":"","FILE_FORMAT":"","FORM_NAME":"Base","FORM_VERSION":"1","VIRTUAL_DOC_ID":"","OBJECT_DESCR":""}}&docType=T_TALIMAT_BILGILERI_ARSIV&attachment={"filename":"test.txt","fileContent":"YXnFn2UgdGVzdA=="}

Örnek sonuç tüm tipler için aynıdır.

7) Örnek belgeli(sistem tipi) kart isteği;

Örnek sonuç tüm tipler için aynıdır.

CreateDocument için Parametreler:

Yeni doküman kaydı oluşturmak için kullanılır. Sadece bir tane belge eklenebilir.

key: Müşterilere özel bir anahtar değeridir. Parametreler ekranındaki social key alanından alınır. Zorunludur.

cabinet: Doküman kaydının kaydedileceği kabinet ve alt klasör yolunu ifade eder. Kabinet yolu alanından, kabinet ve altında hali hazırda bulunan klasörlerden alt klasör yolu seçilebilir. İstenirse dokümanın bağlı olduğu tip alanları kullanılarak klasör yolu devam ettirilebilir. Tip alanında bulunan değere sahip isimde bir klasör yoksa oluşturulur, var ise oluşturulmaz. Doküman tipi “Sistem” olacaksa alt klasör yolu tip alanlarından alınamaz. Zorunludur.

docType: Eklenecek doküman kaydının bağlı olacağı tiptir. Zorunludur.

attachment: Eklenecek dokümanın json verisidir. Zorunludur. Belgesiz form kaydı oluşturulamaz. Json veri alanları filename ve fileContent’dir. filename alanında belgenin formatı ile ismi yazar. fileContent alanında ise belgenin base64 verisi yazar.

Örnek istek:

https://PWARGDEVNXT.g-gsoft.com/External/CreateDocument?token=VXZqeWQ3U1AzeDhZRktTK09UNGJlUXErcmxQMFV2R3cyVjNJajJtbVlyTEJVbFlEdFVIdzNYeXlYTlNCbHRWQ0NEaDdUYUxaMUhLczExNmtqWUs0YmYxaVdzQUgvc3lKSWcxdnRKTHVrd0IrTmJ6ZFM0Y3VJWWZ5a0E1L0syYUJnVFBVU1V5TlY1YmgzSjJreWVpSVd3PT0=&key=4LcVF1lris6VLD1cHboDkReGg2HsbxevsdfcQ11yRn0My6qB3vEC4o8s24pGWTUP&cabinet=Araç Bilgileri&docType=T_SENTEGRATOR&data={ "FATURA_ETTN": null, "FATURA_NO": null, "FATURA_TARIHI": null, "_FATURA_TARIHI": null, "FATURA_TIPI": null, "SATICI_ADI": null, "SATICI_VKN": null, "OBJECT_ID": "", "OBJECT_TYPE": "", "CONTENT_TYPE": "DOC", "PARENT_ID": "", "FOLDER_ID": "", "IS_VIRTUAL_DOC": false, "ACL_ID": "", "FILE_FORMAT": "", "FORM_NAME": "Base", "FORM_VERSION": "1", "VIRTUAL_DOC_ID": "", "OBJECT_DESCR": ""}&attachment={"filename":"test.txt","fileContent":"YXnFn2UgdGVzdA=="}

Örnek sonuç:

{"Result":"FF989100000039FF","ErrorCode":0,"Message":"","UserData":null}

Sonuç alanları:

ErrorCode: CreateDocument servisinde hata alınması sonucu dönecek hata kodudur. Hata yok ise ErrorCode 0’dır.

Message: CreateDocument servisinde hata alınması sonucu dönecek hata mesajıdır. Hata yok ise Message boştur.

Result: CreateDocument servisinin dönüş verisini tutan alandır. Servis hata almış ise boştur.

8) Sistem tipi için örnek istek;

Örnek sonuç tüm tipler için aynıdır.

9) GetListDetail için Parametreler;

Paperworkte oluşturulmuş listelerin verisini listeler.

key: Müşterilere özel bir anahtar değeridir. Parametreler ekranındaki social key alanından alınır. Zorunludur.

listName: Detayı istenen listenin adıdır. Zorunludur.

Örnek istek:

https://PWARGDEVNXT.g-gsoft.com/External/GetListDetail?token=eFhpYjFwaVpSK1hsLzVjUjV1Ynl6T1NLbjB6UlFybkZZYnJ4SCtITU9pdlpBN0duaG5SM3huV3VGeDhEaVVJUTlHV1M3aFQ5UFpPdnJXeGZ4Z3M3aTRsUXY4SWQzWXUwQ3FsOGVpK0pyQ2s1UDBJbEV2V2szdXZiUmVIcEdFZHBSY3FlZDJXR2NURXIyL0VmZlphVVBRPT0=&key=4LcVF1lris6VLD1cHboDkReGg2HsbxevsdfcQ11yRn0My6qB3vEC4o8s24pGWTUP&listName=SATICI_FIRMALAR

Örnek sonuç:

{

"ErrorCode": 0,

"Message": "",

"Result": [

{

"SATICILAR": "A Firması",

"VKN": "123456789"

{

"SATICILAR": "B Firması",

"VKN": "987654321"

}

]

}

Sonuç alanları:

ErrorCode: GetListDetail servisinde hata alınması sonucu dönecek hata kodudur. Hata yok ise ErrorCode 0’dır.

Message: GetListDetail servisinde hata alınması sonucu dönecek hata mesajıdır. Hata yok ise Message boştur.

Result: GetListDetail servisinin dönüş verisini tutan alandır. Servis hata almış ise boştur.

Data:

{

"Flow": { //Akış nesnesini ifade eden nesnedir.

"Name": "Proje Yönetimi Süreci", //Akış başlığıdır. Değiştirilmez.

"Description": "Description", //Akışın notlar kısmında yazacak açıklamadır. İstenilen değer girilebilir.

"TypeName": "T_PROJE_YONETIM_AKIS_TIPI", //Akışın bağlı olduğu tiptir. Değiştirilmez.

"MasterId": "5098910000000157", //Akışın masterId değeridir. Değiştirilmez.

"Priority": 0, //Akışın önceliğidir. Düzenlenebilir.

"Owner": "abercin", //Akış sahibinin giriş adıdır.

"AttachmentId": "", //Akışa bağlanması istenen eklentinin nesne numarası değeridir. Elimizde eklentinin nesne numarası değeri var ise, bu alana vererek eklentiyi akışa bağlayabiliriz.

"TypeData": { //Akışın tip alanlarının bulunduğu nesnedir. İlgili alanlara atanmak istenen değerler burada verilmelidir.

"ACIKLAMA": null,

"AD_SOYAD": null,

"ONAY_SAATI": null,

"_ONAY_SAATI": null,

"TALEP_TARIHI": null,

"_TALEP_TARIHI": null,

"URUN_BILGILERI": [

{

"URUN_ADI": null,

"URUN_GONDERIM_SAATI": null,

"_URUN_GONDERIM_SAATI": null,

"URUN_GONDERIM_TARIHI": null,

"_URUN_GONDERIM_TARIHI": null

}

"OBJECT_ID": "", //ITypes nesnesinden gelen sabit alandır. Kullanılmaz.

"OBJECT_TYPE": "", //ITypes nesnesinden gelen sabit alandır. Kullanılmaz.

"CONTENT_TYPE": "DOC", //ITypes nesnesinden gelen sabit alandır. Kullanılmaz.

"PARENT_ID": "", //ITypes nesnesinden gelen sabit alandır. Kullanılmaz.

"FOLDER_ID": "", //ITypes nesnesinden gelen sabit alandır. Kullanılmaz.

"IS_VIRTUAL_DOC": false, //ITypes nesnesinden gelen sabit alandır. Kullanılmaz.

"ACL_ID": "", //ITypes nesnesinden gelen sabit alandır. Kullanılmaz.

"FILE_FORMAT": "", //ITypes nesnesinden gelen sabit alandır. Kullanılmaz.

"FORM_NAME": "Base", //ITypes nesnesinden gelen sabit alandır. Kullanılmaz.

"FORM_VERSION": "1", //ITypes nesnesinden gelen sabit alandır. Kullanılmaz.

"VIRTUAL_DOC_ID": "", //ITypes nesnesinden gelen sabit alandır. Kullanılmaz.

"OBJECT_DESCR": "" //ITypes nesnesinden gelen sabit alandır. Kullanılmaz.

}

"Card": { //Kartın bağlı olduğu tipin index alanlarının ve değerlerinin tutulduğu nesnedir.

"AD_SOYAD": null, //Kartın bağlı olduğu tipin alanıdır. Kart üzerinde tutulmak veya gösterilmek istenen değer burada verilmelidir. Kart tipinde ne kadar alan varsa, burada gözükecektir.