Postman Kullanım Örneği
Postmanda input parametrelerini geçerken, swagger üzerindeki 'Parameter Type' alanına dikkat edilmelidir. Parametreler header görünüyorsa header bölümüne, body görünüyorsa body bölümüne yazılmalıdır. Input parameters bölümünde ilgili parametrelerin hangi bölüme dahil olduğu parantez içerisinde belirtilmiştir.
İçerdiği Metotlar
1) /api/workflow/
Logo Flow üzerinde devam eden işlerin listesini döner.
Input Parameters
- Authorization(Headers): Login metotlarından herhangi biri kullanılarak alınan token bilgisi geçilir. bknz: Authentication
- offset(query): Gelen verinin kaçıncı sayfadan itibaren listelenceği bilgisidir.
- limit(query): Gelen verinin verilen offsete göre kaçar kaçar gösterileceği bilgisidir.
- sort(query): Gelen veride sıralama yapmak için kullanılır. asc,desc
- withcount(query): Toplam kayıt sayısını döndürür. Gerekmedikçe kullanmayınız.
Output Parameters
- CallStatus: Yapılan çağrının sonucunu belirtir. (Örneğin; 0- Başarılı, 1- Başarısız)
CallStatusDetailText: Yapılan çağrı başarısız sonuçlandığı takdirde hata detayını belirtir.
CallStatusStr: Yapılan çağrının sonucunu belirtir. (Örneğin; Error- Hatalı İstek, OK- Başarılı İstek)
CallStatusText: Yapılan çağrı başarısız sonuçlandığı takdirde hata detayını belirtir. Burada gelen detay apinin kullanıldığı yerlerde direk alınarak kullanıcıya gösterilebilir. CallStatusDetailText alanına göre daha anlaşılır bir mesajdir.
- Items: Geçilen parametrelere göre dönen devam eden işlerin listesidir.
2) /api/workflow/{instanceid}/{currentbookmark}- Delete
Logo Flow üzerinde ilgili instance idli işi iptal eder.
Input Parameters
- Authorization(Headers): Login metotlarından herhangi biri kullanılarak alınan token bilgisi geçilir. bknz: Authentication
- storageid(query): Silinecek olan işin akış idsidir.
- instanceid(path): Slinecek işin guid id bilgisidir. Format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (UID).
- currentbookmark(path): Silinecek işin bulunduğu adım guid bilgisidir. Format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Output Parameters
- CallStatus: Yapılan çağrının sonucunu belirtir. (Örneğin; 0- Başarılı, 1- Başarısız)
CallStatusDetailText: Yapılan çağrı başarısız sonuçlandığı takdirde hata detayını belirtir.
CallStatusStr: Yapılan çağrının sonucunu belirtir. (Örneğin; Error- Hatalı İstek, OK- Başarılı İstek)
CallStatusText: Yapılan çağrı başarısız sonuçlandığı takdirde hata detayını belirtir. Burada gelen detay apinin kullanıldığı yerlerde direk alınarak kullanıcıya gösterilebilir. CallStatusDetailText alanına göre daha anlaşılır bir mesajdir.
3) /api/workflow/{instanceid}/{currentbookmark}- Get
Logo Flow üzerinde ilgili instance id li işi döner.
Input Parameters
- Authorization(Headers): Login metotlarından herhangi biri kullanılarak alınan token bilgisi geçilir. bknz: Authentication
- storageid(query): Silinecek olan işin akış idsidir.
- instanceid(path): Slinecek işin guid id bilgisidir. Format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (UID).
- currentbookmark(path): Silinecek işin bulunduğu adım guid bilgisidir. Format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Output Parameters
- CallStatus: Yapılan çağrının sonucunu belirtir. (Örneğin; 0- Başarılı, 1- Başarısız)
CallStatusDetailText: Yapılan çağrı başarısız sonuçlandığı takdirde hata detayını belirtir.
CallStatusStr: Yapılan çağrının sonucunu belirtir. (Örneğin; Error- Hatalı İstek, OK- Başarılı İstek)
CallStatusText: Yapılan çağrı başarısız sonuçlandığı takdirde hata detayını belirtir. Burada gelen detay apinin kullanıldığı yerlerde direk alınarak kullanıcıya gösterilebilir. CallStatusDetailText alanına göre daha anlaşılır bir mesajdir.