1. Oracle Linux Automation Manager CLIおよびAPIリファレンス・ガイド
  2. タスク
  3. ワークフロー・ジョブ・テンプレート

ワークフロー・ジョブ・テンプレートのリスト

get

/api/v2/workflow_job_templates/

このリソースに対して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: このワークフロー・ジョブ・テンプレートのオプションの説明。(文字列)
  • last_job_run: (日時)
  • last_job_failed: (ブール)
  • next_job_run: (日時)
  • status: (選択)
    • new: 新規
    • pending: 保留中
    • waiting: 待機中
    • running: 実行中
    • successful: 成功
    • failed: 失敗
    • error: エラー
    • canceled: 取消し済
    • never updated: 更新なし
    • ok: OK
    • missing: 不明
    • none: 外部ソースなし
    • updating: 更新中
  • extra_vars: (json)
  • organization: このテンプレートへのアクセス権を決定するために使用される組織。(id)
  • survey_enabled: (ブール)
  • allow_simultaneous: (ブール)
  • ask_variables_on_launch: (ブール)
  • inventory: プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリの指定を求めるプロンプトが表示されると仮定する) (id)
  • limit: (文字列)
  • scm_branch: (文字列)
  • ask_inventory_on_launch: (ブール)
  • ask_scm_branch_on_launch: (ブール)
  • ask_limit_on_launch: (ブール)
  • webhook_service: Webフック・リクエストを受け入れるサービス(選択)
    • "": ---------
    • github: GitHub
    • gitlab: GitLab
    • bitbucket_dc: BitBucket DataCenter
  • webhook_credential: サービスAPIにステータスをポスト・バックするための個人アクセス・トークン(id)
  • ask_labels_on_launch: (ブール)
  • ask_skip_tags_on_launch: (ブール)
  • ask_tags_on_launch: (ブール)
  • skip_tags: (文字列)
  • job_tags: (文字列)

ソート

ワークフロー・ジョブ・テンプレートが特定の順序で返されるように指定するには、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

リクエスト

サポートされているメディア・タイプ
問合せパラメータ
先頭に戻る

レスポンス

サポートされているメディア・タイプ

200レスポンス

本文()
ルート・スキーマ: schema
型: object
ソースを表示
ネストされたスキーマ : results
型: array
ソースを表示
ネストされたスキーマ : WorkflowJobTemplate
型: object
ソースを表示
先頭に戻る