Ana içeriğe atla
GET

Ne yapar?

Firma kapsamındaki kaydı ve en yeni geçmişten başlayarak page/pageSize ile seçilen dilimi döndürür. Varsayılan 1/25, boyut en fazla 250. Sayfa ilerler; aşan sayfada histories boş döner. total ve historiesTotal geçmiş sayısıdır. İşlemi yapan kullanıcı bilgisi actor alanındadır.

Ön koşullar ve izin

Etkin API anahtarı ve muhasip:todo:read izni gerekir. İlişkili kayıtlar aynı firmaya ait olmalıdır. Erişim ayarları için kimlik ve izinler rehberini inceleyin. İstek ve cevap şemalarını indirin.

İstek örnekleri

Örnekler temsilîdir. Kimlikleri, belge tarihlerini ve iş verisini kendi yetkili kayıtlarınızla değiştirin. Node.js örnekleri Node.js 20 veya üzeri içindir; PHP örnekleri cURL uzantısını kullanır. Hiçbiri otomatik tekrar yapmaz.

Cevabı değerlendirin

Önce HTTP durumunu, ardından bu kaynağın status ve sonuç alanlarını değerlendirin. Bütün uçlar aynı sonuç zarfını veya oluşturma için 201 kodunu kullanmaz. Temsilî başarılı cevap; gerçek hizmet çağrısından alınmamıştır:

Hata durumunda

Ağ kesintisi, zaman aşımı veya JSON olmayan cevap mali etkinin oluşmadığını kanıtlamaz. Ham istek/cevapları genel loglara yazmayın. Hata yönetimi

Sonraki adım

Dönen kimlik ve durumları saklayın; iş akışınızın ilgili detay veya yazma adımında kullanın. Kaynak akışı · İşlem takibi · Kapsam ve sınırlamalar

Yetkilendirmeler

Authorization
string
header
gerekli

Kullanıcı adı apiUserId, parola secretKey. Aktif ve süresi geçmemiş API kullanıcısı ve uygun firma gerekir.

Yol Parametreleri

id
string
gerekli

İşlem yapılacak kayıt kimliği. Kayıt kimliği.

Pattern: ^[a-fA-F0-9]{24}$
Örnek:

"64b000000000000000000001"

Sorgu Parametreleri

page
integer
varsayılan:1

1 tabanlı sayfa.

Gerekli aralık: x >= 1
Örnek:

1

pageSize
integer
varsayılan:25

Pozitif sayfa boyutu; en fazla 250.

Gerekli aralık: 1 <= x <= 250
Örnek:

25

Yanıt

İşlem cevabı. Örnek değerler temsilîdir.

status
boolean
gerekli
Örnek:

true

result
object
total
integer