conductor APIs

タスクとワークフローのメタデータ
エンドポイント
説明
入力GET /metadata/taskdefs
すべてのタスク定義の取得
N/A GET /metadata/taskdefs/{taskType}
タスク定義の取得
タスク名POST /metadata/taskdefs
新規タスク定義の登録
タスクリストPUT /metadata/taskdefs
タスク定義の更新
タスク定義DELETE /metadata/taskdefs/{taskType}
タスク定義の削除
タスク名
 
 
  GET /metadata/workflow
すべてのワークフロー定義の取得
N/A POST /metadata/workflow
新しいワークフローの登録
ワークフロー定義PUT /metadata/workflow
新しいワークフローの登録/更新
ワークフロー定義リストGET /metadata/workflow/{name}?version=
ワークフロー定義の取得
ワークフロー名、バージョン(オプション)
 
 
 
ワークフローの開始
入力のみ使用

POST /workflow/{name}?version=&correlationId=
{
   //JSON payload for workflow
}

パラメータ
説明
版
オプション.最新バージョンのワークフローが指定されていない場合
のcorrelationID
ユーザが提供するワークフローの取得に使用できるId
入力
JSONペイロードワークフローを開始します.強制的.ワークフローが入力を望まない場合は、空のJSON {}を渡す必要があります.
生産高
ワークフローID(GUID)
入力フィールドとタスクフィールドの使用

POST /workflow
{
   //JSON payload for Start workflow request } 

ワークフロー要求の開始
JSONワークフローリクエストの開始

{
  "name": "myWorkflow", // Name of the workflow
  "version": 1, // Version “correlatond”: “corr1” // correlation Id "input": { // Input map. }, "taskToDomain": { // Task to domain map } } 

生産高
ワークフローID(GUID)
ワークフローの取得
エンドポイント
説明GET /workflow/{workflowId}?includeTasks=true|false
ワークフローIDを使用してワークフローステータスを取得します.includeTasksが設定されている場合は、実行およびスケジュールされたすべてのタスクも含まれます.GET /workflow/running/{name}
特定のタイプの実行中のすべてのワークフローを取得GET /workflow/running/{name}/correlated/{correlationId}?includeClosed=true|false&includeTasks=true|false
実行中のすべての関連IDフィルタのワークフローを取得します.includeClosedが設定されている場合は、実行を完了するワークフローも含まれます.GET /workflow/search
ワークフローを検索します.以下を参照.
 
 
ワークフローの検索
指揮機関は、Elasticsearchを使用してワークフロー実行をインデックス化し、APIを検索して使用する.GET /workflow/search?start=&size=&sort=&freeText=&query=
パラメータ
説明
スタート
ページ番号デフォルトは0
サイズ
返される結果の数
ぶんかつ
を選択します.フォーマットは、ASC:またはDESC:フィールドごとに昇順または降順にソートされます.
FREETEXT
Elasticsearchはクエリーをサポートします.例えばworkflowType:「name_of_workflow」
に尋ねる
SQL like where句.例えばworkflowType='name_of_workflow'.freeTextが指定されている場合は、オプションです.
生産高
検索結果は次のとおりです.

{
  "totalHits": 0,
  "results": [ { "workflowType": "string", "version": 0, "workflowId": "string", "correlationId": "string", "startTime": "string", "updateTime": "string", "endTime": "string", "status": "RUNNING", "input": "string", "output": "string", "reasonForIncompletion": "string", "executionTime": 0, "event": "string" } ] } 

ワークフローの管理
エンドポイント
説明PUT /workflow/{workflowId}/pause
一時停止.リカバリまで、さらなる作業は手配されません.現在実行中のタスクは一時停止されません.PUT /workflow/{workflowId}/resume
一時停止後、正常な動作に戻ります.POST /workflow/{workflowId}/rerun
以下を参照.POST /workflow/{workflowId}/restart
最初からワークフロー実行を再起動します.現在の実行履歴が消去されます.POST /workflow/{workflowId}/retry
最後の失敗したタスクを再試行します.PUT /workflow/{workflowId}/skiptask/{taskReferenceName}
以下を参照.DELETE /workflow/{workflowId}
実行中のワークフローを終了します.DELETE /workflow/{workflowId}/remove
システムからワークフローを削除します.慎重に使う.
再実行
完了したワークフローを特定のタスクから再実行します.POST /workflow/{workflowId}/rerun

{
  "reRunFromWorkflowId": "string",
  "workflowInput": {}, "reRunFromTaskId": "string", "taskInput": {} } 

タスクをスキップtaskReferenceNameは、実行中のワークフローにおいて、タスク実行(パラメータとして指定)をスキップし、続行する.オプションとして、ペイロードで指定したように、タスクの入力と出力を更新します.  PUT /workflow/{workflowId}/skiptask/{taskReferenceName}?workflowId=&taskReferenceName=

{
  "taskInput": {},
  "taskOutput": {}
}

タスクの管理
エンドポイント
説明GET /tasks/{taskId}
タスクの詳細を取得します.GET /tasks/queue/all
処理するタスクのサイズをリストします.GET /tasks/queue/all/verbose
上記と同様に、各スライスの大きさを含むGET /tasks/queue/sizes?taskType=&taskType=&taskType
指定したタスク・タイプの処理対象タスクのサイズを返します.
 
 
タスクのポーリング、確認、更新
これらはタスクをポーリングするためのキーエンドポイントであり、ack(ポーリング後)を送信し、最後にスタッフがタスク結果を更新します.
エンドポイント
説明GET /tasks/poll/{taskType}?workerid=&domain=
投票タスクworkeridは、ジョブポーリングの作業者として識別され、domainは、ポーリング器が特定のドメイン内のタスクをポーリングすることを可能にするGET /tasks/poll/batch/{taskType}?count=&timeout=&workerid=&domain
指定されたロット内のタスクに対してcountをポーリングする.これは、timeoutまたは少なくとも1つの利用可能なアイテム(先行者基準)まで接続される長いポーリングです.workeridは、ジョブポーリングの作業者として識別され、domainは、ポーリング器が特定のドメイン内のタスクをポーリングすることを可能にするPOST /tasks
タスク実行の結果を更新します.以下のパターンを参照してください.POST /tasks/{taskId}/ack
スタッフが投票して受け取った任務を認める.
タスク結果の更新モード

{
    "workflowInstanceId": "Workflow Instance Id",
    "taskId": "ID of the task to be updated", "reasonForIncompletion" : "If failed, reason for failure", "callbackAfterSeconds": 0, "status": "IN_PROGRESS|FAILED|COMPLETED", "outputData": { //JSON document representing Task execution output } } 

ポーリング後にタスクを承認
スタッフがポーリング後にタスクを確認できない場合は、タスクを再キューしてキューに戻し、後続のポーリングで使用できます.
 
runningのworkflowcurl-X GET--header'Accept:アプリケーション/json'を取得http://192.168.9.137:8080/api/workflow/running/?version=1'workflowcurl-X DELETE--header'Accept:アプリケーション/json'を終了します.http://192.168.9.137:8080/api/workflow/'
ワークフローの開始

curl -X POST --header 'Content-Type: application/json' --header 'Accept: text/plain' -d '{}' 'http://localhost:8080/api/workflow/'

転載先:https://www.cnblogs.com/mhc-fly/p/7011553.html