Actions API

İş akışı eylemlerini programlı olarak yürütün ve yönetin.

Genel Bakış

Actions API, mindzieStudio içindeki iş akışı eylemlerini yönetmek ve yürütmek için uç noktalar sağlar. Eylemler, talep üzerine veya zamanlanmış olarak yürütülebilen otomatik iş akışı bileşenleridir.

Temel URL Yapısı

Tüm Action API uç noktaları şu deseni izler:

/api/{tenantId}/{projectId}/action/...

Yol Parametreleri:

Parametre Tür Açıklama
tenantId GUID Kiracı tanımlayıcınız
projectId GUID Proje tanımlayıcınız

Mevcut Uç Noktalar

Sağlık İzleme

Bağlantıyı test edin ve kimlik doğrulamayı doğrulayın.

  • GET /api/{tenantId}/{projectId}/action/unauthorized-ping - Temel bağlantı testi (kimlik doğrulama gerekmez)
  • GET /api/{tenantId}/{projectId}/action/ping - Kimlik doğrulamalı bağlantı testi

Ping Dokümantasyonunu Görüntüle

Eylem Yönetimi

Eylemleri listeleyin ve detaylarını alın.

  • GET /api/{tenantId}/{projectId}/action - Bir projedeki tüm eylemleri listele
  • GET /api/{tenantId}/{projectId}/action/{actionId} - Belirli bir eylemin detaylarını al

Eylem Yönetimi Dokümantasyonunu Görüntüle

Eylemleri Çalıştırma

Eylem yürütmeyi programlı olarak tetikleyin.

  • GET /api/{tenantId}/{projectId}/action/execute/{actionId} - Bir eylemi çalıştır

Çalıştırma Dokümantasyonunu Görüntüle

Kimlik Doğrulama

Çoğu uç nokta Bearer token veya API anahtarı ile kimlik doğrulaması gerektirir. Tek istisna, kimlik doğrulama olmadan çağrılabilen unauthorized-ping uç noktasıdır.

Örnek kimlik doğrulamalı istek:

GET https://your-mindzie-instance.com/api/{tenantId}/{projectId}/action/ping
Authorization: Bearer {your-access-token}

Yaygın Kullanım Senaryoları

  • Sağlık İzleme: API bağlantısı ve kimlik doğrulamasını doğrulamak için ping uç noktalarını kullanın
  • Otomasyon: Eylemleri ETL boru hatları veya zamanlanmış görevlerin parçası olarak programlı şekilde çalıştırın
  • Entegrasyon: Dış sistemlerden mindzieStudio iş akışlarını tetikleyin
  • İzleme: İş akışı durumunu takip etmek için eylemleri listeleyin ve inceleyin

Hata Yanıtları

Tüm uç noktalar standart HTTP durum kodları döner:

Durum Açıklama
200 Başarılı
401 Yetkisiz - geçersiz veya eksik kimlik doğrulama
404 Bulunamadı - eylem veya kaynak mevcut değil

Başlarken

  1. Bağlantıyı test etmek için Ping Uç Noktaları ile başlayın
  2. Mevcut eylemleri keşfetmek için Eylem Yönetimi kullanın
  3. İş akışlarını tetiklemek için Eylemleri Çalıştır kullanın