統合ジョブテンプレートリストの API エンドポイント
このリソースに GET リクエストを実行して、統合ジョブテンプレートリストを取得します。
GET /api/v2/unified_job_templates/
HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
X-API-Time: 0.055s
返されるデータ構造には以下のものが含まれます。
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
count フィールドはクエリーで見つかった統合ジョブテンプレートの合計数を示します。next および previous フィールドは、単一ページに収まらない結果がある場合に、それらの結果へのリンクを提供します。results には統合ジョブテンプレートレコードが一覧表示されますが、ゼロの場合もあります。
結果
各統合ジョブテンプレートのデータ構造には以下のフィールドが含まれます。
id: 統合ジョブテンプレートのデータベース ID (整数)
type: 統合ジョブテンプレートのデータタイプ (複数選択)
project: プロジェクトinventory_source: インベントリーソースjob_template: ジョブテンプレートsystem_job_template: システムジョブテンプレート
url: 統合ジョブテンプレートの URL (文字列)related: 関連リソースの URL のあるデータ構造 (オブジェクト)summary_fields: 関連リソースの名前/説明のあるデータ構造 (オブジェクト)created: 統合ジョブテンプレート作成時のタイムスタンプ (日時)modified: 統合ジョブテンプレートの最終更新時のタイムスタンプ (日時)name: (文字列)description: (文字列)last_job_run: (日時)last_job_failed: (ブール値)has_schedules: (ブール値)next_job_run: (日時)
status: (複数選択)
new: 新規pending: 保留中waiting: 待機中running: 実行中successful: 成功failed: 失敗error: エラーcanceled: キャンセル済みnever updated: 更新されていませんok: OKmissing: 不明none: 外部ソースがありませんupdating: 更新中
オプションエンドポイントの確認
オプションエンドポイント テーブルでは、このエンドポイントのオプションを確認できます。ブラウザー表示が可能な API でエンドポイントを表示している場合は、「オプション」ボタンをクリックすると以下の raw JSON が表示されます。
| name |
Unified Job Template List
|
| description |
# List Unified Job Templates: Make a GET request to this resource to retrieve the list of unified job templates.
|
| renders |
| 0 |
application/json
|
| 1 |
text/html
|
|
| parses |
|
| added_in_version |
1.4.8
|
| types |
| 0 |
project
|
| 1 |
inventory_source
|
| 2 |
job_template
|
| 3 |
system_job_template
|
|
| actions |
| GET |
| id |
| type |
integer
|
| label |
ID
|
| help_text |
Database ID for this unified job template.
|
|
| type |
| type |
multiple choice
|
| help_text |
Data type for this unified job template.
|
| choices |
| 0 |
|
| 1 |
| 0 |
inventory_source
|
| 1 |
Inventory Source
|
|
| 2 |
| 0 |
job_template
|
| 1 |
Job Template
|
|
| 3 |
| 0 |
system_job_template
|
| 1 |
System Job Template
|
|
|
|
| url |
| type |
string
|
| help_text |
URL for this unified job template.
|
|
| related |
| type |
object
|
| help_text |
Data structure with URLs of related resources.
|
|
| summary_fields |
| type |
object
|
| help_text |
Data structure with name/description for related resources.
|
|
| created |
| type |
datetime
|
| help_text |
Timestamp when this unified job template was created.
|
|
| modified |
| type |
datetime
|
| help_text |
Timestamp when this unified job template was last modified.
|
|
| name |
|
| description |
| type |
string
|
| label |
description
|
|
| last_job_run |
| type |
datetime
|
| label |
last job run
|
|
| last_job_failed |
| type |
boolean
|
| label |
last job failed
|
|
| has_schedules |
| type |
boolean
|
| label |
has schedules
|
|
| next_job_run |
| type |
datetime
|
| label |
next job run
|
|
| status |
| type |
multiple choice
|
| label |
status
|
| choices |
| 0 |
|
| 1 |
|
| 2 |
|
| 3 |
|
| 4 |
| 0 |
successful
|
| 1 |
Successful
|
|
| 5 |
|
| 6 |
|
| 7 |
|
| 8 |
| 0 |
never updated
|
| 1 |
Never Updated
|
|
| 9 |
|
| 10 |
|
| 11 |
| 0 |
none
|
| 1 |
No External Source
|
|
| 12 |
|
|
|
|
|
| search_fields |
|
