ワークフロー・ジョブ・テンプレートのワークフロー・ノードのリスト
/api/v2/workflow_job_templates/{id}/workflow_nodes/
ワークフロー・ノードは実行するテンプレートを参照して、実行する順序を定義します。 このワークフローのジョブが終了すると、次のアクションが実行されます。
- ジョブが失敗した場合は、failure_nodesまたはalways_nodesに含まれるノードの実行
- ジョブが成功した場合は、success_nodesまたはalways_nodesに含まれるノードの実行
ワークフロー・ジョブの一部として実行されているすべてのジョブが完了し、ワークフロー・ジョブが取り消されていない場合は、ワークフロー・ジョブがsuccessfulとしてマークされます。 ワークフロー内のジョブが失敗しても、ワークフロー・ジョブは失敗としてマークされません。
ワークフロー・ジョブ・テンプレートのワークフロー・ジョブ・テンプレート・ノードのリスト:
このリソースに対してGETリクエストを行って、選択したワークフロー・ジョブ・テンプレートに関連付けられたワークフロー・ジョブ・テンプレート・ノードのリストを取得します。
結果のデータ構造には次が含まれます。
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
countフィールドは、対象となる問合せで見つかったワークフロー・ジョブ・テンプレート・ノードの合計数を示します。 nextフィールドとpreviousフィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。 resultsリストには、0個以上のワークフロー・ジョブ・テンプレート・ノード・レコードが含まれます。
結果
それぞれのワークフロー・ジョブ・テンプレート・ノード・データ構造には次のフィールドが含まれます。
id: このワークフロー・ジョブ・テンプレート・ノードのデータベースID。(整数)type: このワークフロー・ジョブ・テンプレート・ノードのデータ型。(選択)url: このワークフロー・ジョブ・テンプレート・ノードのURL。(文字列)related: 関連リソースのURLを含むデータ構造。(オブジェクト)summary_fields: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)created: このワークフロー・ジョブ・テンプレート・ノードが作成されたときのタイムスタンプ。(日時)modified: このワークフロー・ジョブ・テンプレート・ノードが最後に変更されたときのタイムスタンプ。(日時)extra_data: (json)inventory: プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリの指定を求めるプロンプトが表示されると仮定する) (id)scm_branch: (文字列)job_type: (選択)None: ---------"": ---------run: 実行check: チェック
job_tags: (文字列)skip_tags: (文字列)limit: (文字列)diff_mode: (ブール)verbosity: (選択)None: ---------0: 0 (標準)1: 1 (詳細)2: 2 (より詳細)3: 3 (デバッグ)4: 4 (接続デバッグ)5: 5 (WinRMデバッグ)
workflow_job_template: (id)unified_job_template: (id)success_nodes: (フィールド)failure_nodes: (フィールド)always_nodes: (フィールド)all_parents_must_converge: 有効にした場合、すべての親ノードがこのノードにアクセスするための基準を満たしている場合にのみノードが実行されます(ブール)identifier: そのワークフロー内で一意のこのノードの識別子。 これはこのノードに対応するワークフロー・ジョブ・ノードにコピーされます。(文字列)
ソート
ワークフロー・ジョブ・テンプレート・ノードが特定の順序で返されるように指定するには、GETリクエストでorder_by問合せ文字列パラメータを使用します。
?order_by=name
フィールド名の先頭にダッシュ-を付けると逆の順序でソートされます。
?order_by=-name
フィールド名をカンマ,で区切ると、複数のソート・フィールドを指定できます。
?order_by=name,some_other_field
ページ区切り
リクエストごとに返される結果の数を変更するには、page_size問合せ文字列パラメータを使用します。 特定のページの結果を取得するには、page問合せ文字列パラメータを使用します。
?page_size=100&page=2
結果で返されるpreviousリンクおよびnextリンクは、これらの問合せ文字列パラメータを自動的に設定します。
検索
モデルのすべての指定テキスト・フィールド内で大/小文字を区別しない検索を実行するには、search問合せ文字列パラメータを使用します。
?search=findme
(Ansible Tower 3.1.0で追加)関連フィールド全体を検索します。
?related__search=findme
リクエスト
- application/json
- page(オプション): 整数
ページ区切りが設定された結果セット内のページ番号。
- page_size(オプション): 整数
ページごとに返す結果の数。
- search(オプション): 文字列
検索条件。