ワークフロー・ジョブ・テンプレートのワークフロー・ジョブのリスト
get
/api/v2/workflow_job_templates/{id}/workflow_jobs/
このリソースに対して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
: このワークフロー・ジョブが最後に変更されたときのタイムスタンプ。(日時)name
: このワークフロー・ジョブの名前。(文字列)description
: このワークフロー・ジョブのオプションの説明。(文字列)unified_job_template
: (id)launch_type
: (選択)manual
: 手動relaunch
: 再起動callback
: コールバックscheduled
: スケジュール済dependency
: 依存性workflow
: ワークフローwebhook
: Webフックsync
: 同期scm
: SCM更新
status
: (選択)new
: 新規pending
: 保留中waiting
: 待機中running
: 実行中successful
: 成功failed
: 失敗error
: エラーcanceled
: 取消し済
failed
: (ブール)started
: ジョブが開始のためにキューに入れられた日時。(日時)finished
: ジョブの実行が終了した日時。(日時)canceled_on
: 取消しリクエストが送信された日時。(日時)elapsed
: ジョブが実行された経過時間(秒)。(10進)job_explanation
: stdoutを実行および取得できなかった場合のジョブの状態を示すステータス・フィールド(文字列)launched_by
: (フィールド)work_unit_id
: このジョブに関連付けられた受信者作業ユニットID。(文字列)workflow_job_template
: (id)extra_vars
: (json)allow_simultaneous
: (ブール)job_template
: スライスされたジョブの実行用に自動的に作成された場合、ワークフロー・ジョブの作成元となったジョブ・テンプレート。(id)is_sliced_job
: (ブール)inventory
: プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリの指定を求めるプロンプトが表示されると仮定する) (id)limit
: (文字列)scm_branch
: (文字列)webhook_service
: Webフック・リクエストを受け入れるサービス(選択)""
: ---------github
: GitHubgitlab
: GitLab
webhook_credential
: サービスAPIにステータスをポスト・バックするための個人アクセス・トークン(id)webhook_guid
: このWebフックをトリガーしたイベントの一意の識別子(文字列)
ソート
ワークフロー・ジョブが特定の順序で返されるように指定するには、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
( 「Oracle Linux Automation Manaerに追加」)関連フィールド全体を検索します:
?related__search=findme
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
問合せパラメータ
- page(オプション): 整数
ページ区切りが設定された結果セット内のページ番号。
- page_size(オプション): 整数
ページごとに返す結果の数。
- search(オプション): 文字列
検索条件。