Ana içeriğe geç

Okuma ve eşitleme

API başvurusu her alanı sayar; burada her listenin ne işe yaradığı var.

Envanter — inventory:read​

GET /inventory, entegrasyonun görebildiği lokasyonları, sistemleri, ekipmanları ve alt ekipmanları son değişikliğe göre listeler. Süzgeçler: type (facility, system, equipment, sub_equipment), parent_id (doğrudan alt düğümler), external_id, updated_since. Her düğümün path'i (lokasyondan aşağı kimlikler) ve parent_id'si vardır; ağacı yeniden kurabilirsiniz. GET /inventory/{id} tek düğümü verir.

İş emirleri — work_orders:read​

GET /work-orders şunlarla süzülür: status (virgüllü kodlar: open, in_progress, on_hold, inspection, inspection_rejected, waiting_sub_work_orders, complete, cancelled), inventory_id (düğüm ve altındaki her şey), changed_since, target_from / target_to, external_id. Bir iş emri durumunu, önceliğini, envanter düğümünü, formunu, yetkililerini (kişilerin adları yalnız people:read ile), hedef ve tamamlanma tarihlerini ve changed_at'i taşır. GET /work-orders/{id} tek iş emrini verir.

GET /work-orders/{id}/answers (forms:read de gerekir) formun sorularını sırasıyla, her birini türü ve cevabıyla (bir seçenek, seçenek listesi, sayı ya da metin) ya da null olarak verir.

Bir kopyayı güncel tutmak​

Listeler changed_at'e göre sıralıdır; iş emriyle ilgili herhangi bir şey değişince ilerler — alanları, durumu, cevapları, yetkilileri, süre kayıtları, bekletme ya da denetim. Bir kopya tutmak için:

  1. İlk seferde her şeyi sayfa sayfa okuyun.
  2. Gördüğünüz en büyük changed_at'i saklayın.
  3. Sonraki seferde GET /work-orders?changed_since=<o zamandan bir dakika önce> isteyin ve geleni (id'ye göre) ekleyin ya da güncelleyin.

Bir dakikalık örtüşme, siz okurken kaydedilmekte olan değişiklikleri kapsar; ekle-ya-da-güncelle tekrarları zararsız yapar. Değişiklikleri olurken almak için webhook'ları kullanın — ve yine de ara ara eşitleyin; webhook'lar gecikebilir ya da iki kez gelebilir.

Geri bildirimler — issues:read​

GET /issues şunlarla süzülür: resolved, inventory_id, changed_since, external_id; her birinin düğümü, çözülüp çözülmediği ve ondan açılan iş emri vardır. GET /issues/{id} tek geri bildirimi verir.

Başvuru listeleri​

  • GET /reference/work-order-statuses, /reference/priorities, /reference/form-types — her token.
  • GET /forms — organizasyonun yayımlanmış formları (forms:read).
  • GET /people, GET /teams — organizasyonun kişileri ve takımları, üyeleriyle (people:read; kişisel veri). Kimlikleri, iş emirlerini atadığınız kimliklerdir.