Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip
iconfalse
titlePostman 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.

Image Added

Info
iconfalse
titleİç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) 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. 
  • 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

3) /api/workflow/{instanceid}/{currentbookmark}-

Delete

Get

Logo Flow üzerinde ilgili instance idli id li işi iptal ederdö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. 

3) /api/workflow/

4) /api/workflow/count 

Logo Flow üzerinde devam eden işlerin sayısını döner.

Input Parameters

  • Authorization(Headers): Login metotlarından herhangi biri kullanılarak alınan token bilgisi geçilir. 
  • keyFilter(body): Veriyi filtreli bir şekilde getirmek için kullanılır.

           {
             "KeyFilters": [
              {
                  "Operator": "string" : eq,neq,gt,lt,lte,contains,doesnotcontain
                  "Field": "string", : filtre uygulanacak alan
                  "Value": {} : filtre uygulanacak alanın değeri
              }
              ],
              "Logic": "string" : birden fazla filtre içeren requestlerde filtrelerin bağlaçları. (and,or)
           }

5) /api/workflow/file 

Logo Flow üzerinde akışa eklenen doküman bilgisini ve indirme linkini döner.

Input Parameters

  • Authorization(Headers): Login metotlarından herhangi biri kullanılarak alınan token bilgisi geçilir. 
  • fileid(query): İşe eklenen doküman id bilgisidir.

6) /api/workflow/resume/externalapi 

Logo Flow üzerinde iş akışını devam ettir ve sonraki adıma ait bilgileri döner.

Input Parameters

  • Authorization(Headers): Login metotlarından herhangi biri kullanılarak alınan token bilgisi geçilir. 
  • latitude(query): Mobil uygulamadan ilerletilen iş için konum bilgisidir.(enlem)
  • longitude(query): Mobil uygulamadan ilerletilen iş için konum bilgisidir.(boylam)
  • resumeparameters(body): Devam ettirilecek işe ait bilgiler parametre geçilir.

{
"storageid": 0,
"instanceid": "string",
"currentbookmark": "string",
"NextButtonName": "string",
"ResumeParameters": [
"string"
],
"RequestLocationType": "0",
"CommentList": [
{
"Id": {},
"Comment": "string",
"OperationType": "0"
}
],
"FileList": [
{
"FileId": {},
"FileData": "string",
"FileName": "string",
"OperationType": "0"
}
],
"ValidateFilesAndComments": true
}

7) /api/workflow/start

Logo Flow üzerinde akış başlatmak için kullanılır.

Input Parameters

  • Authorization(Headers): Login metotlarından herhangi biri kullanılarak alınan token bilgisi geçilir. 
  • storageid(query): Başlatılmak istenen akış id bilgisidir.
  • description(query): Akış başlatılırken açıklama eklenmek istenirse girilir.
  • publishtype(query): Akışın yayın modu başlatılmak isteniyorsa 1, geliştirim modu başlatılmak isteniyorsa 0 gönderilir.
  • latitude(query): Mobil uygulamadan başlatılan iş için konum bilgisidir.(enlem)
  • longitude(query): Mobil uygulamadan başlatılan iş için konum bilgisidir.(boylam)

8) /api/workflow/start/withparams

Logo Flow üzerinde detay parametreler ile akış başlatmak için kullanılır. 

Input Parameters

  • Authorization(Headers): Login metotlarından herhangi biri kullanılarak alınan token bilgisi geçilir. 
  • startupParameters(body): Akış başlatırken kullanılabilecek parametreler gönderilir.

{
"storageid": 0,
"description": "string",
"storagePublishType": "0",
"StartupParameters": [
"string"
],
"CommentList": [-- yorum
{
"Id": {},
"Comment": "string",
"OperationType": "0"
}
],
"FileList": [ --dosya
{
"FileId": {},
"FileData": "string",
"FileName": "string",
"OperationType": "0"
}
]
}

9) /api/workflow/status

Logo Flow üzerinde başlatılan işlerin durumunu döner.

Input Parameters

  • Authorization(Headers): Login metotlarından herhangi biri kullanılarak alınan token bilgisi geçilir. 

10) /api/workflow/validate/{instanceid}/{currentbookmark}

- Get

Logo Flow üzerinde ilgili instance id li işi işin validasyon bilgilerini 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 Sorgulanacak işin akış idsidir. 
  • instanceid(path): Slinecek Sorgulanacak işin guid id bilgisidir. Format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (UID).
  • currentbookmark(path): Silinecek Sorgulanacak 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. 

  • incluefileandcomment(query): Sorgulanacak işte dosya ve yorum zorunluğunun bulunup bulunmadığının bilgisini döner.

11) /api/workflow/withcriteria

Logo Flow üzerinde belirtilen kriterlerde devam eden işlerin listesini döner.

Input Parameters

  • Authorization(Headers): Login metotlarından herhangi biri kullanılarak alınan token bilgisi geçilir.
  • 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.
  • keyFilter(body): Veriyi filtreli bir şekilde getirmek için kullanılır.

           {
             "KeyFilters": [
              {
                  "Operator": "string" : eq,neq,gt,lt,lte,contains,doesnotcontain
                  "Field": "string", : filtre uygulanacak alan
                  "Value": {} : filtre uygulanacak alanın değeri
              }
              ],
              "Logic": "string" : birden fazla filtre içeren requestlerde filtrelerin bağlaçları. (and,or)
           }

12) /api/workflow/withcustomcolumn

Logo Flow üzerinde devam eden işlerin listesini tanımlı özel alanları ile birlikte döner.

Input Parameters

  • Authorization(Headers): Login metotlarından herhangi biri kullanılarak alınan token bilgisi geçilir.
  • firstversionid(query): İlgili akışın fisrtversionid bilgisi geçilir.
  • publishType(query): Akışın yayın modu başlatılmak isteniyorsa 1, geliştirim modu başlatılmak isteniyorsa 0 gönderilir.
  • 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.
  • keyFilter(body): Veriyi filtreli bir şekilde getirmek için kullanılır.

           {
             "KeyFilters": [
              {
                  "Operator": "string" : eq,neq,gt,lt,lte,contains,doesnotcontain
                  "Field": "string", : filtre uygulanacak alan
                  "Value": {} : filtre uygulanacak alanın değeri
              }
              ],
              "Logic": "string" : birden fazla filtre içeren requestlerde filtrelerin bağlaçları. (and,or)
           }