Parameter Kueri Umum

Endpoint daftar pada WEEGLOO (GET yang mengembalikan koleksi, seperti GET /spaces/{spaceId}/contents) menerima parameter kueri umum. Dengan parameter ini Anda membatasi jumlah item yang diambil dalam satu halaman, menentukan kriteria pengurutan, mengambil resource terkait sekaligus, memilih hanya field yang diperlukan, mempersempit daftar dengan kondisi, dan berpindah ke halaman berikutnya atau sebelumnya.

Parameter ini bekerja dengan cara yang sama tanpa bergantung pada jenis resource. Referensi tiap resource hanya menjelaskan kondisi khusus resource tersebut, dan untuk parameter umum yang dibahas di sini merujuk ke halaman ini.

Parameter

Jenis field sys yang digunakan pada order, select dapat Anda periksa di Properti Sistem (sys).

Filter

Kondisi filter tidak dibungkus dengan filter[], melainkan dikirim langsung sebagai parameter kueri. Formatnya adalah {kolom}[{operator}]={nilai}, dan jika operator dihilangkan maka ditafsirkan sebagai eq. Untuk seluruh operator yang dapat digunakan, lihat Operator di bawah.

{kolom}[{operator}]={nilai}

Misalnya, untuk mengambil hanya item yang name-nya diawali dengan Tumbler, kirim name[prefix]=Tumbler. Aturan dan hal yang perlu diperhatikan adalah sebagai berikut.

• Jangan membungkus kondisi dengan filter[]. Membungkusnya seperti filter[name[prefix]]=Tumbler tidak akan bekerja.
• Beberapa kondisi digabungkan dengan AND. Hanya item yang memenuhi semuanya yang tersisa, dan pencarian OR, yang cukup memenuhi salah satu dari beberapa kondisi, tidak didukung. Untuk mencocokkan salah satu dari beberapa nilai pada satu kolom, gunakan in.
• Kondisi fields. menyertakan Locale. Misalnya, fields.file.ko-KR.mimeGroups=Image hanya menyisakan berkas gambar pada daftar Media, dan sys.createdAt[gte]=2026-06-01T00:00:00Z hanya mengambil item yang dibuat setelah waktu tersebut.
• Saat memfilter atau mengurutkan daftar Content dengan kondisi fields., Content Type juga harus ditentukan. Anda harus mengirim sys.contentType.sys.id bersamaan (khusus daftar /contents), dan contentType= saja tidak dapat menggantikannya. Untuk detailnya, lihat Referensi Content.

Operator

Field RichText dan Json bukan target pencarian sehingga tidak dapat digunakan pada kondisi filter.

Pencarian Lanjutan (Advanced Search)

Operator regex, near, within, dan pencarian teks lengkap hanya bekerja pada pencarian lanjutan. Pencarian lanjutan diaktifkan dengan menambahkan header X-Weegloo-Advanced-Search: true pada permintaan pengambilan daftar, dan header yang sama juga disertakan pada respons.

• Pencarian teks lengkap: Jika Anda menggunakan eq pada field teks (LongText) yang pencarian teks lengkapnya aktif, item yang memuat nilai tersebut pun ikut ditemukan melalui pencocokan parsial atau serupa, bukan hanya nilai yang persis sama. Jika pencarian lanjutan tidak diaktifkan atau paket harga Anda tidak menyediakan pencarian lanjutan, eq yang sama bekerja sebagai pencocokan persis.
• Pencarian Location: near (radius) dan within (poligon) hanya digunakan pada field Location dan hanya bekerja pada pencarian lanjutan.
• Jika Anda mengirim regex, near, atau within pada permintaan yang tidak dapat menggunakan pencarian lanjutan, kondisi tersebut tidak akan diterima.

Paginasi (kursor)

Body respons daftar berisi objek links, dan di dalamnya terdapat next, prev. links.next adalah path lengkap menuju halaman berikutnya.

/v1/spaces/HnQ32YiH/contents?limit=15&next=<kursor>

Ada dua cara untuk mengambil halaman berikutnya. Panggil path links.next apa adanya, atau ambil nilai kursor next dari links.next lalu teruskan sebagai parameter next pada permintaan berikutnya. Jika links.next tidak ada, itu adalah halaman terakhir. Untuk halaman sebelumnya, berpindahlah dengan cara yang sama melalui links.prev.

Jangan menambah skip saat berpindah halaman. Jika item ditambahkan atau dihapus di antara daftar, posisi skip menjadi bergeser sehingga item bisa terlewat atau terduplikasi. Kursor (next, prev) tidak memiliki masalah ini.

Berikut adalah contoh struktur respons daftar. sys.type pada wrapper adalah TotalPageResponse, items berisi array item, dan links berisi path navigasi.

{
  "sys": { "type": "TotalPageResponse" },
  "limit": 15,
  "totalCount": 42,
  "items": [
    {
      "sys": {
        "id": "3trmXRM3RqbgSnifyg7PUl8DzDgDzP",
        "type": "Content",
        "space": { "sys": { "id": "HnQ32YiH", "type": "Refer", "targetType": "Space" } },
        "createdAt": "2026-06-18T09:51:14.597Z",
        "updatedAt": "2026-06-18T09:51:44.128Z",
        "version": 2,
        "status": "Published"
      }
    }
  ],
  "links": {
    "self": "/v1/spaces/HnQ32YiH/contents?limit=15",
    "next": "/v1/spaces/HnQ32YiH/contents?limit=15&next=Q3Vyc29yVmFsdWU"
  }
}

totalCount adalah jumlah total item yang memenuhi kondisi, dan limit adalah ukuran satu halaman yang diterapkan pada respons ini. items hanya memuat item yang sesuai dengan halaman tersebut.

Dokumen Terkait

• Properti Sistem (sys): field sys yang digunakan pada order, select.
• Konvensi: tipe media, JSON Patch, konkurensi.