Read Data

Untuk melakukan Read Data melalui API masuk ke tab-menu Integrasi API.

Pada bidang integrasi API pilih/klik '[GET] /list' seperti gambar berikut ini :

Akan muncul informasi dokumentasi penggunaan Endpoint '[GET] /list'

Berikut adalah penjelasan dari setiap bagian:

- Methods: Hanya dapat diakses menggunakan metode GET.

- Headers: Memerlukan dua header, yaitu 'access_key' dan 'app_key', yang harus disertakan dengan nilai kunci akses masing-masing.

- Info: Menyertakan informasi tambahan seperti ID formulir (formId) dan ID aplikasi (appId).

- Url: Struktur URL untuk mengakses endpoint ini, termasuk placeholder untuk 'base_url', 'appId', dan 'formId'.

- Filter (opsional): Filter data yang opsional, dengan contoh filter dapat dilihat di Catatan Skema filter.

- Sort (opsional): Pengurutan data yang opsional, dengan contoh pengurutan dapat dilihat di Catatan Skema sort.

- Search (opsional): Pencarian data yang opsional, dalam contoh ini, ditentukan bahwa query pencarian adalah "*".

- Pagination (opsional): Pengaturan halaman yang opsional, memungkinkan untuk mengatur baris awal dan akhir untuk membatasi jumlah data yang dikembalikan.

Berikut adalah contoh penggunaan skema filter

{
  "nama_field":
  {
    "filterType":"text",
    "type":"equals",
    "filter":"filter_value"
  }
} 

nama_field = field pada formulir, list nama field dapat di lihat di "Daftar Semua Fields"

filterType = jenis filter data dapat berupa (text/number/date/set)

type = mode filter berdasarkan dengan jenis filter:

jika filterType (text) maka type (exists/notExists/equals/notEqual/contains/notContains/startsWith/endsWith)
jika filterType (number) maka type (equals/notEqual/greaterThan/greaterThanOrEqual/lessThan/lessThanOrEqual/inRange)
jika filterType (date) maka type (equals/notEqual/greaterThan/greaterThanOrEqual/lessThan/lessThanOrEqual/inRange)
jika filterType (set) maka type (array)

filter = value yang di filter:

jika filterType=number dan type=inRange harap gunakan filter & filterTo
jika filterType=date dan type=inRange harap gunakan dateFrom & dateTo
jika filterType=set dan type=array harap gunakan values dan isi value dalam format array []

Berikut adalah contoh detail penggunaan Filter Query

#Contoh FilterType "text" dan type "equals":
{
  "status":{
    "filterType":"text",
    "type":"equals",
    "filter":"SELESAI"
  }
} 

#Contoh FilterType "number" dan type "greaterThanOrEqual":
{
  "umur":{
    "filterType":"number",
    "type":"greaterThanOrEqual",
    "filter":1
  }
} 

#Contoh FilterType "number" dan type "inRange":
{
  "umur":{
    "filterType":"number",
    "type":"inRange",
    "filter":1,
    "filterTo":10
  }
} 

#Contoh FilterType "date" dan type "greaterThanOrEqual":
{
  "_meta.createdAt":{
    "filterType":"date",
    "type":"greaterThan",
    "dateFrom":"2022-02-27"
  }
} 

#Contoh FilterType "date" dan type "inRange":
{
  "_meta.createdAt":{
    "filterType":"date",
    "type":"inRange",
    "dateFrom":"2022-02-27",
    "dateTo":"2022-03-04"
  }
} 

#Contoh FilterType "set" dan type "array":
{
  "status":{
    "filterType":"set",
    "type":"array",
    "values":["SELESAI","DIPROSES"]
  }
} 

#Contoh Multiple Filter Fields:
{
  "status":{
    "filterType":"set",
    "type":"array",
    "values":["SELESAI","DIPROSES"]
  },
  "_meta.createdAt":{
    "filterType":"date",
    "type":"inRange",
    "dateFrom":"2022-02-27",
    "dateTo":"2022-03-04"
  },
  "umur":{
    "filterType":"number",
    "type":"inRange",
    "filter":1,
    "filterTo":10
  }
} 

Anda dapat melakukan pengujian API dengan cara mengunduh postman collection yang disediakan seperti pada gambar berikut ini: