Oracle Linux Automation Manager CLIおよびAPIリファレンス・ガイド

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

get

/api/v2/workflow_job_template_nodes/

このリソースに対して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デバッグ)
execution_environment: 実行に使用されるコンテナ・イメージ。(id)
forks: (整数)
job_slice_count: (integer)
timeout: (integer)
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: integer

ページ区切りが設定された結果セット内のページ番号。
page_size: integer

ページごとに返す結果の数。
search: string

検索条件。

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ : schema

型: object

ソースを表示

count(required): integer
next: string(uri)
previous: string(uri)
results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/WorkflowJobTemplateNode"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

ネストされたスキーマ: results

型: array

ソースを表示

Array of: object WorkflowJobTemplateNode

{
    "items":{
        "$ref":"#/definitions/WorkflowJobTemplateNode"
    },
    "type":"array"
}

ネストされたスキーマ : WorkflowJobTemplateNode

型: object

ソースを表示

all_parents_must_converge: boolean

タイトル: All parents must converge

有効にすると、すべての親ノードがこのノードに到達するための基準を満たしている場合にのみノードが実行されます
always_nodes: array always_nodes

読取り専用: true

一意のアイテムが必要: true
created: string

タイトル: Created

読取り専用: true
diff_mode: boolean

タイトル: Diff mode
execution_environment: integer

タイトル: Execution environment

実行に使用するコンテナ・イメージ。
extra_data: object Extra data

タイトル: Extra data
failure_nodes: array failure_nodes

読取り専用: true

一意のアイテムが必要: true
forks: integer

タイトル: Forks

最小値: 0
id: integer

タイトル: ID

読取り専用: true
identifier: string

タイトル: Identifier

最小長: 1

最大長: 512

デフォルト値: 00000000-0000-0000-0000-000000000000

ワークフロー内で一意のこのノードの識別子。このノードに対応するワークフロー・ジョブ・ノードにコピーされます。
inventory: integer

タイトル: Inventory

ジョブ・テンプレートがインベントリを要求すると仮定して、プロンプトとして適用されたインベントリ
job_slice_count: integer

タイトル: Job slice count

最小値: 0
job_tags: string

タイトル: Job tags
job_type: string

タイトル: Job type

指定できる値: [ "run", "check" ]
limit: string

タイトル: Limit
modified: string

タイトル: Modified

読取り専用: true
related: string

タイトル: Related

読取り専用: true
scm_branch: string

タイトル: Scm branch
skip_tags: string

タイトル: Skip tags
success_nodes: array success_nodes

読取り専用: true

一意のアイテムが必要: true
summary_fields: string

タイトル: Summary fields

読取り専用: true
timeout: integer

タイトル: Timeout
type: string

タイトル: Type

読取り専用: true
unified_job_template: integer

タイトル: Unified job template
url: string

タイトル: Url

読取り専用: true
verbosity: string

タイトル: Verbosity

指定できる値: [ "0", "1", "2", "3", "4", "5" ]
workflow_job_template(required): string

タイトル: Workflow job template

{
    "properties":{
        "all_parents_must_converge":{
            "description":"If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node",
            "title":"All parents must converge",
            "type":"boolean",
            "x-nullable":true
        },
        "always_nodes":{
            "items":{
                "type":"integer"
            },
            "readOnly":true,
            "type":"array",
            "uniqueItems":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "diff_mode":{
            "title":"Diff mode",
            "type":"boolean",
            "x-nullable":true
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "extra_data":{
            "title":"Extra data",
            "type":"object"
        },
        "failure_nodes":{
            "items":{
                "type":"integer"
            },
            "readOnly":true,
            "type":"array",
            "uniqueItems":true
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "identifier":{
            "default":"00000000-0000-0000-0000-000000000000",
            "description":"An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.",
            "maxLength":"512",
            "minLength":"1",
            "title":"Identifier",
            "type":"string",
            "x-nullable":true
        },
        "inventory":{
            "description":"Inventory applied as a prompt, assuming job template prompts for inventory",
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "job_slice_count":{
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer",
            "x-nullable":true
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "job_type":{
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "limit":{
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string",
            "x-nullable":true
        },
        "success_nodes":{
            "items":{
                "type":"integer"
            },
            "readOnly":true,
            "type":"array",
            "uniqueItems":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timeout":{
            "title":"Timeout",
            "type":"integer",
            "x-nullable":true
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "unified_job_template":{
            "title":"Unified job template",
            "type":"integer",
            "x-nullable":true
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"string",
            "x-nullable":true
        },
        "workflow_job_template":{
            "title":"Workflow job template",
            "type":"string"
        }
    },
    "required":[
        "workflow_job_template"
    ],
    "type":"object"
}

ネストされたスキーマ : always_nodes

型: array

読取り専用: true

一意のアイテムが必要: true

ソースを表示

配列: integer

{
    "items":{
        "type":"integer"
    },
    "readOnly":true,
    "type":"array",
    "uniqueItems":true
}

ネストされたスキーマ : 追加データ

型: object

タイトル: Extra data

ネストされたスキーマ : failure_nodes

型: array

読取り専用: true

一意のアイテムが必要: true

ソースを表示

配列: integer

{
    "items":{
        "type":"integer"
    },
    "readOnly":true,
    "type":"array",
    "uniqueItems":true
}

ネストされたスキーマ : success_nodes

型: array

読取り専用: true

一意のアイテムが必要: true

ソースを表示

配列: integer

{
    "items":{
        "type":"integer"
    },
    "readOnly":true,
    "type":"array",
    "uniqueItems":true
}

先頭に戻る