İş Akışları
Temel platformworkflow_definitions_readİş AkışlarıBir tesisin iş akışı otomasyonlarını okur: iş akışları, tek bir iş akışının tam grafiği, bir grafiğin kullanabileceği düğüm türleri ve seçilmiş şablonlar. Her türün ve parametrenin tesiste geçerli olması için bir grafik oluşturmadan veya düzenlemeden önce node_types okuyun.
Eylemler:
- list: İş akışlarını listeleyin. Her iş akışı; canlı olup olmadığı, yayımlanmış sürümü, çalıştırma sayısı, son çalıştırması ve düğümleriyle (id, name, type) birlikte. Marka ve organizasyon iş akışları listelenmez.
- get: İş akışını alın. Tam taslak grafik (düğümler, bağlantılar, notlar, ayarlar) ve meta: active, publishedVersionId ve yayımlandıktan sonra publishedWorkflow, yani şu anda canlı olan grafik. Yalnızca bu tesisin iş akışları. Gerekli: workflowId.
- node_types: Düğüm türleri. type, label, category, outputs (dallar) ve inputSchema (doldurulacak parametreler) içeren palet girdileri. Tesiste düğümün ihtiyaç duyduğu bir modül yoksa available, nedeniyle birlikte false olur. MCP araçları mcp.
. düğümleri olarak görünür. - templates: Şablonlar. Yaygın otomasyonlar için başlangıç noktaları; risk ve riskNote (dikkatsizce yayımlanırsa neyin ters gidebileceği), düğüm türleri, gerekli modüller, bu tesisteki kullanılabilirlik ve bir önizleme grafiğiyle birlikte. Bir şablonu workflow_definitions_write instantiate_template ile grafiğe dönüştürün.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
action* | "list" | "get" | "node_types" | "templates" | Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır. |
limit | integer | Sayfa başına öğe (varsayılan 25, en fazla 100) (list, node_types, templates) |
cursor | string | Önceki sayfadan nextCursor (list, node_types, templates) |
facilityId | string | Tesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır. |
workflowId | string | workflow_definitions_read list sonucundaki iş akışı kimliği (get) |
query | string | Tür, etiket, açıklama veya arama terimlerinde bulunacak kelimeler (node_types) |
category | string | Yalnızca bu kategori: trigger, action, logic veya ai (node_types) |
types | array | Açıklanacak tam türler, ör. düzenlediğiniz bir iş akışındakiler. Paletin artık göstermediği kullanımdan kaldırılmış türleri de içerir; query ve category yok sayılır. (node_types) |
workflow_definitions_writeİş AkışlarıBir tesisin iş akışı otomasyonlarını oluşturur, düzenler, yayımlar, durdurur ve siler. Oluşturma döngüsü: workflow_definitions_read ile node_types okuyun, grafiği oluşturun (veya instantiate_template ile başlayın), taslak olarak oluşturun, workflow_runs_write test ile deneyin (simüle edilmiş), ardından yayımlayın. Bir taslakta yapılan düzenlemeler, taslak yayımlanana kadar canlı olanı asla değiştirmez.
Eylemler:
- create: İş akışı oluşturun. En az bir düğüm içeren tam bir grafikten yeni, etkin olmayan bir taslak kaydeder; name varsayılan olarak "Untitled workflow" olur. Doğrulama sorunları düğüm ayrıntılarıyla errors içinde döner. Gerekli: nodes.
- update: Taslağı kaydedin. Taslağın tamamının yerini alır: yalnızca değişiklikleri değil, her düğümü ve bağlantıyı gönderin. Canlı olan, siz yayımlayana kadar çalışmaya devam eder. Doğrulama sorunları düğüm ayrıntılarıyla errors içinde döner. Gerekli: workflowId, nodes.
- patch_meta: Yeniden adlandırın. Yalnızca adı veya açıklamayı değiştirir; grafik ve canlı olan olduğu gibi kalır. İkisi de zaten eşleşiyorsa changed false olur. Gerekli: workflowId.
- duplicate: Çoğaltın. Bir iş akışını yeni düğüm kimlikleriyle "
(copy)" adlı yeni bir taslağa kopyalar; bu taslak hiçbir zaman yayımlanmış veya etkin değildir. Orijinale dokunulmaz. Gerekli: workflowId. - delete: Silin. İş akışını kalıcı olarak siler: taslak, yayımlanmış sürümler, çalıştırma geçmişi ve tetikleyici yönlendirmesi. set_active false iş akışını durdurur ama korur; discard_draft yalnızca taslak düzenlemelerini sıfırlar. Gerekli: workflowId. Onay ister.
- discard_draft: Taslak düzenlemelerini atın. Taslağı son yayımlanan sürüme sıfırlar ve o zamandan beri yapılan düzenlemeleri atar. Canlı sürüm asla etkilenmez; yayımlanmış bir sürüm gerektirir. Gerekli: workflowId. Onay ister.
- publish: Yayımlayın. Taslağı doğrular, canlı sürüm olarak kaydeder ve iş akışını açar; böylece tetikleyicileri çalışır ve eylemleri gerçekten yürütülür. Devam eden çalıştırmalar eski sürümle tamamlanır. Bekleyen Delay adımlarının zamanlaması yeniden ayarlanacaksa sonuç WAIT_RETARGET_CONFIRMATION_REQUIRED kodunu ve impacts değerini içerir: confirmWaitRetargets ve bu impacts ile yeniden çağırın. Gerekli: workflowId. Onay ister.
- set_active: Açın veya kapatın. active true, yayımlanmış bir iş akışını yeniden açar. active false iş akışını durdurur: tetikleyiciler çalışmayı bırakır ve bekleyen Delay adımları iptal edilir, böylece asla tamamlanmaz. Hiçbir şey silinmez. Zaten o durumda değilse önce onay ister. Gerekli: workflowId, active. Onay isteyebilir.
- instantiate_template: Şablondan grafik. Bir şablonu yeni düğüm kimlikleriyle create için hazır bir grafiğe dönüştürür: { name, description, nodes, connections }. Şablonlar alıcıları, kapıları ve saatleri bilerek boş bırakır; önce bunları doldurun. Hiçbir şey kaydetmez. Gerekli: templateId.
- generate: Grafik oluşturun. Tesisin yapay zekasıyla düz dilde yazılmış bir istemden grafik oluşturur ve yalnızca geçerli düğüm türlerini kullanarak { name, description, nodes, connections } döndürür. Bir iş akışını revize etmek için workflow gönderin; revize edilmiş tam grafik geri döner. Hiçbir şey kaydetmez ancak tesisin yapay zeka kredilerini harcar. Gerekli: prompt. Onay ister.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
action* | "create" | "update" | "patch_meta" | "duplicate" | "delete" | "discard_draft" | "publish" | "set_active" | "instantiate_template" | "generate" | Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır. |
name | string | İş akışı adı (create, update, patch_meta) |
description | string | İş akışının ne yaptığı (create, update, patch_meta) |
nodes | array | Her düğüm: { id, name, type, position, parameters }. Türler ve parametreler workflow_definitions_read node_types sonucundan gelir. (create, update) |
connections | object | Kaynak düğüm adına göre anahtarlanmış bağlantılar; tek bir düğüm için boş olabilir (create, update) |
notes | array | Tuval notları (create, update) |
settings | object | İş akışı ayarları (create, update) |
facilityId | string | Tesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır. |
workflowId | string | workflow_definitions_read list sonucundaki iş akışı kimliği (update, patch_meta, duplicate, delete, discard_draft, publish, set_active) |
confirmWaitRetargets | boolean | Önceki sonucun impacts değerinde listelenen bekleyen Delay adımlarının zamanlamasını yeniden ayarlar (publish) |
confirmedWaitRetargets | array | WAIT_RETARGET_CONFIRMATION_REQUIRED sonucundaki impacts, değiştirilmeden geri gönderilir (publish) |
active | boolean | Açmak için true, durdurmak için false (set_active) |
templateId | string | workflow_definitions_read templates sonucundaki şablon kimliği (instantiate_template) |
prompt | string | İş akışının ne yapması gerektiği (generate) |
workflow | object | Sıfırdan başlamak yerine revize edilecek, workflow_definitions_read get sonucundaki tam iş akışı (generate) |
confirm | boolean | Yalnızca kullanıcı ilk çağrının döndürdüğü önizlemeyi onayladıktan sonra ayarlayın |
workflow_runs_readİş AkışlarıBir iş akışının en yeniden eskiye çalıştırma geçmişi ve tek bir çalıştırmanın adım adım ayrıntıları. Bir otomasyonun çalışıp çalışmadığını kontrol etmek, workflow_runs_write ile başlatılan bir çalıştırmayı izlemek veya hangi düğümün neden başarısız olduğunu bulmak için kullanın.
Eylemler:
- list: Çalıştırmaları listeleyin. Her çalıştırma; durum, mod (live veya test), yan etkiler, tetikleyici, başlatan kişi, zamanlar, adım sayısı, beklediği düğüm ve varsa hatayla birlikte. Gerekli: workflowId.
- get: Çalıştırmayı alın. Çalıştırmanın durumu ve sırasıyla her adım; her düğümün girdisi, çıktısı, notu ve hatasıyla birlikte. Çalıştırmalar eşzamansızdır: Delay içeren bir çalıştırma, devamının zamanı gelene kadar bekler. Gerekli: workflowId, executionId.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
action* | "list" | "get" | Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır. |
workflowId | string | workflow_definitions_read list sonucundaki iş akışı kimliği |
limit | integer | Sayfa başına öğe (varsayılan 25, en fazla 100) (list) |
cursor | string | Önceki sayfadan nextCursor (list) |
facilityId | string | Tesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır. |
executionId | string | workflow_runs_read list sonucundaki çalıştırma kimliği (get) |
workflow_runs_writeİş Akışlarıİş akışı çalıştırmalarını başlatır, test amaçlı çalıştırır, iptal eder ve yeniden oynatır. Taslağı yan etkileri simüle ederek çalıştıran test eylemini tercih edin; run, yayımlanmış iş akışını gerçekten yürütür. Çalıştırmalar eşzamansızdır: workflow_runs_read get ile izleyin.
Eylemler:
- run: Şimdi çalıştırın. Yayımlanmış iş akışını manuel tetikleyicisinden (custom.manualTrigger) gerçek yan etkilerle çalıştırır. Zamanlanmış, webhook ve olay tetikleyicileri kendiliğinden çalışır. Çalıştırmanın executionId değerini ve ilk durumunu döndürür. Gerekli: workflowId. Onay ister.
- test: Taslağı test edin. Kaydedilmiş taslağı yayımlamadan çalıştırır ve test çalıştırması olarak kaydeder. Yan etkiler varsayılan olarak simüle edilir: hiçbir şey gönderilmez veya değiştirilmez ve her düğüm ne yapacağını bildirir. sideEffects live önce onay ister. Gerekli: workflowId. Onay isteyebilir.
- cancel: Bekleyen çalıştırmayı iptal edin. Bir Delay üzerinde bekleyen bir çalıştırmayı iptal eder: bekleyen beklemeleri kapanır ve sonraki adımlar asla çalışmaz. Tamamlanmış çalıştırmalar ve bir adımın ortasındaki çalıştırmalar iptal edilemez. Gerekli: workflowId, executionId. Onay ister.
- retry: Çalıştırmayı yeniden oynatın. Tamamlanmış bir çalıştırmayı, retryOf üzerinden geri bağlanarak kaydedilmiş tetikleyici girdisinden yeniden oynatır. published (varsayılan), kullandığı sürümü gerçekten yeniden çalıştırır ve önce onay ister; draft-test mevcut taslağı simüle ederek çalıştırır ve bir hatayı düzeltirken doğru seçimdir. Gerekli: workflowId, executionId. Onay isteyebilir.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
action* | "run" | "test" | "cancel" | "retry" | Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır. |
workflowId | string | workflow_definitions_read list sonucundaki iş akışı kimliği |
nodeId | string | Başlatılacak tetikleyici düğüm kimliği; manuel tetikleyici için göndermeyin (run, test) |
payload | object | Tetikleyiciden sonraki düğümler için girdi, ör. { "visitorName": "Ada" } (run, test) |
facilityId | string | Tesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır. |
sideEffects | "simulate" | "live" | Düğüm eylemlerinin gerçekten gerçekleşip gerçekleşmeyeceği (test) |
executionId | string | workflow_runs_read list sonucundaki çalıştırma kimliği (cancel, retry) |
mode | "published" | "draft-test" | Neye karşı yeniden oynatılacağı (retry) |
confirm | boolean | Yalnızca kullanıcı ilk çağrının döndürdüğü önizlemeyi onayladıktan sonra ayarlayın |