Pertanyaan GraphQL (Baca)

Ambil data dengan pertanyaan GraphQL selamat-jenis

5 minit bacaan
Cetak bahagian ini

Titik akhir GraphQL di /api/v1/graphql menyediakan 16 pertanyaan bacaan: whoami, workOrders, workOrder(id | reference), assets, asset(id), assetDowntimes, meters(assetId), parts (dengan penapis lowStock), part (mengikut id atau kod bar), stockMovements, floorPlans(locationId), locations, vendors, customers, purchaseOrders, purchaseOrder(id | reference | erpReference). Setiap senarai boleh dilalui halaman demi halaman hingga ke penghujung dengan limit (1-200) serta offset — kecuali stockMovements, yang dihalamankan dengan afterId.

Titik akhir

POST https://freemaint.com/api/v1/graphql dengan Content-Type: application/json. Setiap pertanyaan menggunakan 1 daripada kuota harian anda.

Contoh: senaraikan arahan kerja

query { workOrders(limit: 10, status: "OPEN") { id title priority status assetId assetName locationId locationName dueDate } } Mengembalikan sehingga 200 baris; had lalai ialah 50.

Ambil satu alat ganti (mengikut id atau barcode)

Dapatkan satu alat ganti mengikut id atau kod bar, dengan part(id: N) atau part(barcode: "CODE"). barcode sepadan dengan kod bar, kod QR, nombor alat ganti dan rujukan (tanpa mengira huruf besar/kecil, alat ganti aktif sahaja) — padanan yang sama digunakan oleh pengimbas dalam aplikasi — dan mengembalikan null apabila tiada yang sepadan. Contoh: query { part(barcode: "ABC-123") { id name description partNumber quantity minQuantity maxStockLevel unitOfMeasure imageUrl area location { name } vendor { name website } } } Alat ganti turut mengembalikan description, minQuantity, maxStockLevel, imageUrl serta location dan vendor bersarang — cukup untuk mengisi skrin kiosk dalam satu pertanyaan. Ia turut sepadan dengan customReference anda sendiri, jadi sesuatu integrasi boleh mencari alat ganti melalui kod yang dibawanya dalam sistem anda.

Penapis yang tersedia

  • workOrders(limit, offset, status, updatedSince) — terbaharu dahulu; halaman dengan limit (1-200, lalai 50) serta offset; penapis rentetan status; updatedSince hanya memulangkan perintah kerja yang berubah sejak masa itu; perintah kerja dalam Tong Kitar Semula tidak sesekali dipulangkan
  • workOrder(id:) / workOrder(reference:) — satu perintah kerja, dicari melalui id atau rujukan yang digunakan pasukan anda (WO-2026-11-016, tidak sensitif huruf besar/kecil); berikan hanya satu daripadanya. Setiap perintah kerja juga memulangkan assetName dan locationName, nama yang dicetak oleh borang atau permit
  • assets(limit, offset, updatedSince) — terbaharu dahulu; halaman dengan limit (1-200, lalai 50) serta offset; updatedSince hanya memulangkan aset yang berubah sejak masa itu
  • assetDowntimes(assetId, openOnly, since, limit, offset) — pemberhentian mesin, terbaharu dahulu; halaman dengan limit (1-200, lalai 50) serta offset; openOnly=true hanya memulangkan pemberhentian yang belum tamat; since (ISO 8601) memulangkan pemberhentian yang BERMULA pada atau selepas satu cap masa, iaitu cara murah untuk memulihkan penghantaran yang terlepas
  • parts(limit, offset, lowStock, updatedSince) — halaman dengan limit (1-200) serta offset; updatedSince hanya memulangkan alat ganti yang berubah sejak masa itu; lowStock=true hanya memulangkan barang berstok pada atau di bawah minQuantity
  • locations, vendors, customers (limit, offset, updatedSince) — tersusun mengikut nama; halaman dengan limit (1-200, lalai 200) serta offset; updatedSince hanya memulangkan baris yang berubah sejak masa itu
  • part(id, barcode) — carian satu alat ganti; barcode sepadan dengan kod bar, kod QR, nombor bahagian, rujukan dan rujukan tersuai — sesuai untuk pengimbas
  • floorPlans(locationId) — pelan lantai sesuatu lokasi berserta penandanya (koordinat x/y dalam peratus); membolehkan kiosk memaparkan di mana alat ganti disimpan
  • meters(assetId, limit, offset) — meter (jam operasi, pembilang, odometer, tolok), terbaharu dahulu; halaman dengan limit (1-200, lalai 50) serta offset; assetId mengehadkan kepada satu mesin; lastReadingValue dan lastReadingDate memberi bacaan terakhir
  • purchaseOrders(limit, offset, status, vendorId, updatedSince) — pesanan belian bersama barisnya (setiap satu dengan receivedQuantity), penghantarannya (receipts) dan pembekalnya, dari yang terbaharu; halaman dengan limit (1-200, lalai 50) serta offset; status ialah PENDING, APPROVED, ORDERED, PARTIALLY_RECEIVED, RECEIVED atau CANCELLED; updatedSince hanya memulangkan pesanan yang diubah sejak saat itu
  • purchaseOrder(id, reference, erpReference) — satu pesanan belian, dicari mengikut id, rujukan FreeMaint (PO-12) atau erpReference yang ditulis semula oleh ERP anda; beri tepat satu
  • stockMovements(limit, afterId, since, partId, workOrderId, type) — lejar stok, terlama dahulu; halaman dengan limit (1-200, lalai 50) dan afterId: hantar id pergerakan terakhir yang anda terima untuk mendapatkan halaman seterusnya, yang kekal tepat walaupun pergerakan baharu sedang ditulis; since (ISO 8601) bermula dari satu tarikh; type ialah ADJUSTMENT, PURCHASE, WORK_ORDER, TRANSFER, RETURN, SCRAP, INITIAL, CORRECTION atau INSPECTION

Introspeksi skema

Introspeksi diaktifkan. Untuk meneroka skema penuh secara interaktif — setiap pertanyaan, mutasi dan jenis input beserta medannya — halakan klien GraphQL desktop (Altair, Insomnia atau Postman) ke POST /api/v1/graphql dengan token Bearer anda. Peneroka yang berjalan dalam pelayar, seperti Apollo Sandbox atau GraphiQL dalam talian, ditolak oleh dasar CORS kami.

Petua

Gabungkan beberapa pertanyaan dalam satu permintaan: { workOrders(limit:5){ id } assets(limit:5){ id } } — dikira sebagai satu panggilan kuota.

Petua

Medan tersuai meter: meters { id name customFields { name label fieldType value } } memulangkan satu entri bagi setiap medan yang ditetapkan untuk meter, mengikut susunan paparan; value ialah teks, atau null jika meter itu tiada nilai. Melalui API, nilai adalah baca sahaja.

Adakah halaman ini membantu?