Şablon API Genel Bakış

Şablonlar, analiz iş akışlarını tanımlayan yeniden kullanılabilir defter yapılandırmalarıdır. Şablon API'sini kullanarak defter şablonlarını programlı olarak listeleyebilir, alabilir, oluşturabilir ve yönetebilirsiniz.

Temel Kavramlar

Şablonlar Nedir?

Şablonlar önceden yapılandırılmış defter tanımlarını içerir:

  • Bloklar: Filtreler, hesaplayıcılar, içgörüler ve diğer analiz bileşenleri
  • MCL Metni: Defter yapısını tanımlayan yapılandırma metni
  • Meta Veriler: İsim, açıklama, kategori ve süreç bağlamı

Bir şablondan defter oluşturduğunuzda, tüm bloklar ve yapılandırmalar otomatik olarak uygulanır.

Şablon Türleri

Tür Kapsam API aracılığıyla Oluşturulabilir mi? API aracılığıyla Silinebilir mi?
Global Tüm kiracılar Hayır Hayır
Kiracıya Özel Tek bir kiracı Evet Evet

Global şablonlar sistem genelindedir ve yönetici arayüzünden yönetilir. Kiracıya özel şablonlar bu API aracılığıyla oluşturulabilir ve yönetilebilir.

Şablon Kategorileri

Şablonlar kategorilere ayrılmıştır:

Kategori Açıklama
Templates Standart analiz şablonları
Custom Kullanıcı tarafından oluşturulan özel şablonlar
BaseKnowledge Temel bilgi şablonları

Kimlik Doğrulama

Tüm Şablon API uç noktaları için Global API Anahtarı gereklidir. Kiracı API anahtarları şablon işlemlerine erişemez.

curl -H "Authorization: Bearer YOUR_GLOBAL_API_KEY" \
  https://your-mindzie-instance.com/api/templates

Global olmayan bir API anahtarı kullanırsanız şunu alırsınız:

{
  "error": "This endpoint requires a Global API key.",
  "hint": "Global API keys can be created at /admin/global-api-keys"
}

API Uç Noktaları

Yöntem Uç Nokta Açıklama
GET /api/templates Tüm global şablonları listele
GET /api/templates/tenant/{tenantId} Bir kiracı için şablonları listele (global + kiracıya özel)
GET /api/templates/category/{category} Kategoriye göre şablonları listele
GET /api/templates/{templateId} Şablon detaylarını MCL metni ile al
GET /api/templates/{templateId}/thumbnail Şablon küçük resim görüntüsünü al
POST /api/templates/tenant/{tenantId} Kiracıya özel bir şablon oluştur
PUT /api/templates/{templateId} Bir şablonu güncelle
DELETE /api/templates/{templateId} Bir şablonu sil

Hızlı Başlangıç

Bir Kiracı İçin Tüm Şablonları Listele

curl -X GET "https://your-mindzie-instance.com/api/templates/tenant/12345678-1234-1234-1234-123456789012" \
  -H "Authorization: Bearer YOUR_GLOBAL_API_KEY"

Şablon Detaylarını Al

curl -X GET "https://your-mindzie-instance.com/api/templates/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" \
  -H "Authorization: Bearer YOUR_GLOBAL_API_KEY"

Şablondan Defter Oluştur

Şablondan defter oluşturmak için Notebook API'sini kullanın:

curl -X POST "https://your-mindzie-instance.com/api/{tenantId}/{projectId}/notebook/investigation/{investigationId}/from-template" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "templateId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "name": "My Analysis"
  }'

Yanıt Yapısı

Şablon Liste Yanıtı

{
  "templates": [
    {
      "templateId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "Process Discovery",
      "description": "Standard process discovery workflow",
      "category": "Templates",
      "processName": "Order to Cash",
      "tenantId": null,
      "isGlobal": true,
      "hasThumbnail": true,
      "autoAddedDefaultSortOrder": 100,
      "dateModified": "2024-01-15T10:30:00Z"
    }
  ],
  "totalCount": 1
}

Şablon Detay Yanıtı

{
  "templateId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "name": "Process Discovery",
  "description": "Standard process discovery workflow",
  "category": "Templates",
  "processName": "Order to Cash",
  "mclText": "// MCL configuration text here...",
  "tenantId": null,
  "isGlobal": true,
  "hasThumbnail": true,
  "autoAddedDefaultSortOrder": 100,
  "originatingNotebookId": null,
  "dateCreated": "2024-01-01T00:00:00Z",
  "dateModified": "2024-01-15T10:30:00Z",
  "createdBy": null,
  "createdByName": "System",
  "modifiedBy": null,
  "modifiedByName": "System"
}

Sonraki Adımlar?