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.

Delegation.postman_collection.json

İçerdiği Metotlar

1) /api/delegation/ 

Logo Flow üzerinde tanımlanmış olan vekaletlerin 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
  • 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)
           }

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 vekalet listesidir. Kullanıcının vermiş olduğu tüm vekaletler listelenir.              
 Swagger

 Postman

2) /api/delegation/delete

Logo Flow üzerinde tanımlanmış olan vekaletlerden herhangi biri silinmek istendiğinde kullanılması gereken metottur

Input Parameters

  • Authorization(Headers): Login metotlarından herhangi biri kullanılarak alınan token bilgisi geçilir. bknz: Authentication
  • id(query): Silinecek olan vekaletin idsidir. Id bilgisi; vekaletleri listeleyen metot içerisindeki Id kolonundan elde edilir.

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. 

 Swagger

 Postman

3) /api/delegation/save

Logo Flow üzerinde yeni bir vekalet tanımlamak istendiğinde kullanılması gereken metottur.

Input Parameters

  • Authorization(Headers): Login metotlarından herhangi biri kullanılarak alınan token bilgisi geçilir. bknz: Authentication
  • delegationinfo(body): Vekalet işlemi için gerekli olan parametreleri içerir.

           {
               "SsoId": "string", : Vekaleti verecek kişinin id bilgisidir. USERS tablosundaki USERID kolonundan id bilgisine ulaşılabilir.
               "DlgSsoId": "string", : Vekaleti alacak kişinin id bilgisidir. USERS tablosundaki USERID kolonundan id bilgisine ulaşılabilir.
               "StorageId": 0, : Vekalet verilecek akışın id bilgisidir. NWFSTORAGE tablosundaki Id kolonundan akışın id bilgisine ulaşılabilir.
               "InstanceGuid": "string", : Vekalet iş bazında indirgenmiş bir şekilde verilecekse işin id bilgisidir. NWFLOGMASTER tablosundaki INSTANCEID kolonundan işin instanceid bilgisine ulaşılabilir.
               "StartFrom": "string", : Vekalet başlangıç tarihidir.
               "ValidUntil": "string", Vekalet bitiş tarihidir.
               "InstanceDesc": "string" : Vekalet verilecek işin açıklamasıdır.
           }

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. 

 Swagger

 Postman