機械翻訳について

移動先

• リクエスト
• レスポンス

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

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: (boolean)
• ask_skip_tags_on_launch: (boolean)
• ask_tags_on_launch: (boolean)
• 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

リクエスト

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

• 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/WorkflowJobTemplate"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

• Array of: object WorkflowJobTemplate

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

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

型: object

ソースを表示

• allow_simultaneous: boolean
  タイトル: Allow simultaneous
• ask_inventory_on_launch: boolean
  タイトル: Ask inventory on launch
• ask_labels_on_launch: boolean
  タイトル: Ask labels on launch
• ask_limit_on_launch: boolean
  タイトル: Ask limit on launch
• ask_scm_branch_on_launch: boolean
  タイトル: Ask scm branch on launch
• ask_skip_tags_on_launch: boolean
  タイトル: Ask skip tags on launch
• ask_tags_on_launch: boolean
  タイトル: Ask tags on launch
• ask_variables_on_launch: boolean
  タイトル: Ask variables on launch
• created: string
  タイトル: Created

  読取り専用: true
• description: string
  タイトル: Description
• extra_vars: string
  タイトル: Extra vars
• id: integer
  タイトル: ID

  読取り専用: true
• inventory: integer
  タイトル: Inventory

  ジョブ・テンプレートがインベントリを要求すると仮定して、プロンプトとして適用されたインベントリ
• job_tags: string
  タイトル: Job tags
• last_job_failed: boolean
  タイトル: Last job failed

  読取り専用: true
• last_job_run: string(date-time)
  タイトル: Last job run

  読取り専用: true
• limit: string
  タイトル: Limit
• modified: string
  タイトル: Modified

  読取り専用: true
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 512
• next_job_run: string(date-time)
  タイトル: Next job run

  読取り専用: true
• organization: integer
  タイトル: Organization

  このテンプレートへのアクセスを決定するために使用される組織。
• related: string
  タイトル: Related

  読取り専用: true
• scm_branch: string
  タイトル: Scm branch
• skip_tags: string
  タイトル: Skip tags
• status: string
  タイトル: Status

  読取り専用: true

  指定できる値: [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ]
• summary_fields: string
  タイトル: Summary fields

  読取り専用: true
• survey_enabled: boolean
  タイトル: Survey enabled
• type: string
  タイトル: Type

  読取り専用: true
• url: string
  タイトル: Url

  読取り専用: true
• webhook_credential: integer
  タイトル: Webhook credential

  サービスAPIにステータスを転記するための個人アクセス・トークン
• webhook_service: string
  タイトル: Webhook service

  指定できる値: [ "github", "gitlab", "bitbucket_dc" ]

  webフック・リクエストを受け入れるサービス

{
    "properties":{
        "allow_simultaneous":{
            "title":"Allow simultaneous",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_inventory_on_launch":{
            "title":"Ask inventory on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_labels_on_launch":{
            "title":"Ask labels on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_limit_on_launch":{
            "title":"Ask limit on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_scm_branch_on_launch":{
            "title":"Ask scm branch on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_skip_tags_on_launch":{
            "title":"Ask skip tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_tags_on_launch":{
            "title":"Ask tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_variables_on_launch":{
            "title":"Ask variables on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inventory":{
            "description":"Inventory applied as a prompt, assuming job template prompts for inventory",
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "last_job_failed":{
            "readOnly":true,
            "title":"Last job failed",
            "type":"boolean"
        },
        "last_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last job run",
            "type":"string",
            "x-nullable":true
        },
        "limit":{
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "next_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Next job run",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"The organization used to determine access to this template.",
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "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
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled",
                "never updated",
                "ok",
                "missing",
                "none",
                "updating"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "survey_enabled":{
            "title":"Survey enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "webhook_credential":{
            "description":"Personal Access Token for posting back the status to the service API",
            "title":"Webhook credential",
            "type":"integer",
            "x-nullable":true
        },
        "webhook_service":{
            "description":"Service that webhook requests will be accepted from",
            "enum":[
                "github",
                "gitlab",
                "bitbucket_dc"
            ],
            "title":"Webhook service",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

先頭に戻る