İçeriğe geç
Admin API

QueueProcess

Serverhttps://magaza-adiniz.myideasoft.com

QueueProcess LIST

GET
https://magaza-adiniz.myideasoft.com
/admin-api/queue_processes
Bearer
or
OAuth 2.0

Tüm Kuyruk İşlemi (QueueProcess) nesnelerini filtreleyerek ve sayfalandırarak listeler. Sıralama (sort), sayfalama (limit, page), tekil veya çoklu ID (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.

QueueProcess LIST › query Parameters

sort
​string

Sonuçların hangi alana göre sıralanacağını belirler. Artan (ascending) sıralama için alan adını (id), azalan (descending) sıralama için ise başına eksi işareti (-) ekleyin.

limit
​integer · min: 1 · max: 100

Bir sayfada döndürülecek maksimum kayıt adedi.

Default: 20
page
​integer · min: 1

Getirilecek sonuçların sayfa numarası.

Default: 1
id
​integer · min: 1

Tek bir kayıt getirmek için kullanılan benzersiz kimlik değeri (ID).

status
​string · enum

Kuyruk işleminin durumuna göre filtreleme yapar. Seçenekler: | cancelled: İşlem İptal Edildi (Cancelled). | started: İşlem Başlatıldı/İşleniyor (Started/Processing). | created: İşlem Oluşturuldu (Created/Pending). | failed: İşlem Başarısız Oldu (Failed). | in_queue: İşlem Kuyrukta (In Queue/Pending). | completed: İşlem Tamamlandı (Completed).

Enum values:
cancelled
started
created
failed
in_queue
completed
type
​string · enum

Kuyruk işleminin tipine göre filtreleme yapar. Seçenekler: | export: Genel Dışa Aktarma (Export) işlemi. | sitemap: Site Haritası (Sitemap) oluşturma işlemi. | product_bulk_update: Toplu Ürün Güncelleme işlemi. | order_status_bulk_update: Toplu Sipariş Durumu Güncelleme işlemi. | report: Raporlama** işlemi. | kuveyt_turk_shopping_loan_category_export: Kuveyt Türk Alışveriş Kredisi için Kategori Dışa Aktarma işlemi.

Enum values:
export
sitemap
product_bulk_update
order_status_bulk_update
report
kuveyt_turk_shopping_loan_category_export
optimize_product_stock
mail_list_import
startCreatedAt
​string · date · pattern: yyyy-mm-dd

Oluşturulma tarihi (createdAt) için başlangıç zamanı

endCreatedAt
​string · date · pattern: yyyy-mm-dd

Oluşturulma tarihi (createdAt) için bitiş zamanı.

q
​string

Gelişmiş Filtreleme (Query Filter)**. Alan bazlı kesin filtreleme yapmak için kullanılır. Kullanım: q[<alan_adı>]=<değer>

s
​string

Arama Anahtarı Filtresi (Search Keyword). İşlem açıklamalarında veya çıktıda genel arama yapmak için kullanılır.

QueueProcess LIST › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

Kuyruk işlemi objesi (asenkron işlemler için)
id
​integer

Kuyruk işlemi için benzersiz kimlik

Example: 567
type
​string · maxLength: 255

İşlem tipi

Example: product_bulk_update
model
​string · maxLength: 255

İşlenecek model adı

Example: Product
status
​string · enum · maxLength: 255

İşlem durumu

Enum values:
started
created
completed
failed
cancelled
in_queue
Example: processing
output
​string · maxLength: 65535 · writeOnly

output

tooltipType
​string · maxLength: 255
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00

QueueProcess COUNT

GET
https://magaza-adiniz.myideasoft.com
/admin-api/queue_processes/count
Bearer
or
OAuth 2.0

Tüm Kuyruk İşlemi (QueueProcess) nesnelerini filtreleyerek ve sayfalandırarak listeler. Sıralama (sort), sayfalama (limit, page), tekil veya çoklu ID (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.

QueueProcess COUNT › query Parameters

sort
​string

Sonuçların hangi alana göre sıralanacağını belirler. Artan (ascending) sıralama için alan adını (id), azalan (descending) sıralama için ise başına eksi işareti (-) ekleyin.

limit
​integer · min: 1 · max: 100

Bir sayfada döndürülecek maksimum kayıt adedi.

Default: 20
page
​integer · min: 1

Getirilecek sonuçların sayfa numarası.

Default: 1
id
​integer · min: 1

Tek bir kayıt getirmek için kullanılan benzersiz kimlik değeri (ID).

status
​string · enum

Kuyruk işleminin durumuna göre filtreleme yapar. Seçenekler: | cancelled: İşlem İptal Edildi (Cancelled). | started: İşlem Başlatıldı/İşleniyor (Started/Processing). | created: İşlem Oluşturuldu (Created/Pending). | failed: İşlem Başarısız Oldu (Failed). | in_queue: İşlem Kuyrukta (In Queue/Pending). | completed: İşlem Tamamlandı (Completed).

Enum values:
cancelled
started
created
failed
in_queue
completed
type
​string · enum

Kuyruk işleminin tipine göre filtreleme yapar. Seçenekler: | export: Genel Dışa Aktarma (Export) işlemi. | sitemap: Site Haritası (Sitemap) oluşturma işlemi. | product_bulk_update: Toplu Ürün Güncelleme işlemi. | order_status_bulk_update: Toplu Sipariş Durumu Güncelleme işlemi. | report: Raporlama** işlemi. | kuveyt_turk_shopping_loan_category_export: Kuveyt Türk Alışveriş Kredisi için Kategori Dışa Aktarma işlemi.

Enum values:
export
sitemap
product_bulk_update
order_status_bulk_update
report
kuveyt_turk_shopping_loan_category_export
optimize_product_stock
mail_list_import
startCreatedAt
​string · date · pattern: yyyy-mm-dd

Oluşturulma tarihi (createdAt) için başlangıç zamanı

endCreatedAt
​string · date · pattern: yyyy-mm-dd

Oluşturulma tarihi (createdAt) için bitiş zamanı.

q
​string

Gelişmiş Filtreleme (Query Filter)**. Alan bazlı kesin filtreleme yapmak için kullanılır. Kullanım: q[<alan_adı>]=<değer>

s
​string

Arama Anahtarı Filtresi (Search Keyword). İşlem açıklamalarında veya çıktıda genel arama yapmak için kullanılır.

QueueProcess COUNT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

Kayıt sayısı yanıtı.
total_count
​integer · required

Filtrelere uyan toplam kayıt sayısı.