İnceleme API

mindzieStudio projeleri içinde incelemeleri yönetin. İncelemeler, analitik iş akışlarını tanımlayan not defterlerine veri setlerini bağlayan, süreç madenciliği analizleri için birincil kapsayıcılardır.

Özellikler

İnceleme Yönetimi

İncelemeler oluşturun, alın, güncelleyin ve silin. Sayfalama desteği ile bir projedeki tüm incelemeleri listeleyin.

Yönetim API'sini Görüntüle

Not Defteri Erişimi

Bir inceleme içindeki not defterlerini alın; bu not defterleri, her inceleme ile otomatik olarak oluşturulan ana not defteri de dahil olmak üzere.

Not Defterlerini Görüntüle API

Kullanılabilir Uç Noktalar

Bağlantı Testi

Yöntem Uç Nokta Açıklama
GET /api/{tenantId}/{projectId}/investigation/unauthorized-ping Genel bağlantı testi
GET /api/{tenantId}/{projectId}/investigation/ping Yetkilendirilmiş bağlantı testi

İnceleme CRUD

Yöntem Uç Nokta Açıklama
GET /api/{tenantId}/{projectId}/investigation Tüm incelemeleri listele
GET /api/{tenantId}/{projectId}/investigation/{investigationId} İnceleme detaylarını al
POST /api/{tenantId}/{projectId}/investigation Yeni bir inceleme oluştur
PUT /api/{tenantId}/{projectId}/investigation/{investigationId} Bir incelemeyi güncelle
DELETE /api/{tenantId}/{projectId}/investigation/{investigationId} Bir incelemeyi sil

Not Defteri Erişimi

Yöntem Uç Nokta Açıklama
GET /api/{tenantId}/{projectId}/investigation/{investigationId}/notebooks Tüm not defterlerini listele
GET /api/{tenantId}/{projectId}/investigation/{investigationId}/main-notebook Ana not defterini al

Kimlik Doğrulama

Bütün Investigation API uç noktaları geçerli bir Tenant API anahtarı gerektirir. API anahtarını Authorization başlığına ekleyin.

API anahtarı türleri ve kullanımı hakkında detaylar için Kimlik Doğrulama sayfasına bakınız.

Hızlı Başlangıç

# Bir projedeki tüm incelemeleri listele
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/{projectId}/investigation" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Yeni bir inceleme oluştur
curl -X POST "https://your-mindzie-instance.com/api/{tenantId}/{projectId}/investigation" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"investigationName": "Order Analysis", "datasetId": "your-dataset-guid"}'

Önemli Notlar

  • Veri Seti Gereklidir: Her inceleme mevcut bir veri seti ile bağlanmalıdır
  • Ana Not Defteri: Bir inceleme oluşturulduğunda otomatik olarak ana not defteri oluşturulur
  • Önbellek Gereklidir: Not defterlerine not defterleri uç noktası aracılığıyla erişmeden önce projeyi önbelleğe yükleyin
  • KASKAD Silme: Bir incelemenin silinmesi tüm not defterlerini ve analiz geçmişini kalıcı olarak siler
  • Operasyon Merkezi: Gerçek zamanlı izleme için kullanılan incelemelerde isUsedForOperationCenter değerini true olarak ayarlayın