プロジェクト更新のプロジェクト更新イベントのリスト
get
/api/v2/project_updates/{id}/events/
このリソースに対して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
: このプロジェクト更新イベントが最後に変更されたときのタイムスタンプ。(日時)event
: (選択)runner_on_failed
: ホスト失敗runner_on_start
: ホスト起動済runner_on_ok
: ホストOKrunner_on_error
: ホスト障害runner_on_skipped
: ホスト・スキップ済runner_on_unreachable
: ホスト到達不可runner_on_no_hosts
: 残りのホストなしrunner_on_async_poll
: ホスト・ポーリングrunner_on_async_ok
: ホスト非同期OKrunner_on_async_failed
: ホスト非同期失敗runner_item_on_ok
: アイテムOKrunner_item_on_failed
: アイテム失敗runner_item_on_skipped
: アイテム・スキップ済runner_retry
: ホスト再試行runner_on_file_diff
: ファイル差分playbook_on_start
: プレイブック起動済playbook_on_notify
: ハンドラの実行中playbook_on_include
: ファイルの組込みplaybook_on_no_hosts_matched
: 一致するホストなしplaybook_on_no_hosts_remaining
: 残りのホストなしplaybook_on_task_start
: タスク開始済playbook_on_vars_prompt
: 変数の要求playbook_on_setup
: ファクトの収集playbook_on_import_for_host
: 内部: ホストのインポート時playbook_on_not_import_for_host
: 内部: ホストのインポートなしplaybook_on_play_start
: 再生開始済playbook_on_stats
: プレイブック完了debug
: デバッグverbose
: 詳細deprecated
: 非推奨warning
: 警告system_warning
: システム警告error
: エラー
counter
: (整数)event_display
: (文字列)event_data
: (json)event_level
: (整数)failed
: (ブール)changed
: (ブール)uuid
: (文字列)host_name
: (フィールド)playbook
: (文字列)play
: (文字列)task
: (文字列)role
: (文字列)stdout
: (フィールド)start_line
: (整数)end_line
: (整数)verbosity
: (整数)project_update
: (id)
ソート
プロジェクト更新イベントが特定の順序で返されるように指定するには、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(オプション): 文字列
検索条件。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
レスポンスの例(application/json)
{
"results":[
{
"changed":false,
"counter":0,
"created":"2018-02-01T08:00:00.000000Z",
"end_line":0,
"event":"",
"event_data":{
},
"event_display":"",
"event_level":0,
"failed":false,
"host_name":"localhost",
"id":1,
"modified":"2018-02-01T08:00:00.000000Z",
"play":"",
"playbook":"",
"project_update":1,
"related":{
"project_update":"/api/v2/project_updates/1/"
},
"role":"",
"start_line":0,
"stdout":"",
"summary_fields":{
"project_update":{
"description":"test-proj-desc",
"failed":false,
"id":1,
"name":"test-proj",
"status":"new"
},
"role":{
}
},
"task":"",
"type":"project_update_event",
"url":"",
"uuid":"",
"verbosity":0
},
{
"changed":false,
"counter":0,
"created":"2018-02-01T08:00:00.000000Z",
"end_line":0,
"event":"",
"event_data":{
},
"event_display":"",
"event_level":0,
"failed":false,
"host_name":"localhost",
"id":2,
"modified":"2018-02-01T08:00:00.000000Z",
"play":"",
"playbook":"",
"project_update":1,
"related":{
"project_update":"/api/v2/project_updates/1/"
},
"role":"",
"start_line":0,
"stdout":"",
"summary_fields":{
"project_update":{
"description":"test-proj-desc",
"failed":false,
"id":1,
"name":"test-proj",
"status":"new"
},
"role":{
}
},
"task":"",
"type":"project_update_event",
"url":"",
"uuid":"",
"verbosity":0
},
{
"changed":false,
"counter":0,
"created":"2018-02-01T08:00:00.000000Z",
"end_line":0,
"event":"",
"event_data":{
},
"event_display":"",
"event_level":0,
"failed":false,
"host_name":"localhost",
"id":3,
"modified":"2018-02-01T08:00:00.000000Z",
"play":"",
"playbook":"",
"project_update":1,
"related":{
"project_update":"/api/v2/project_updates/1/"
},
"role":"",
"start_line":0,
"stdout":"",
"summary_fields":{
"project_update":{
"description":"test-proj-desc",
"failed":false,
"id":1,
"name":"test-proj",
"status":"new"
},
"role":{
}
},
"task":"",
"type":"project_update_event",
"url":"",
"uuid":"",
"verbosity":0
},
{
"changed":false,
"counter":0,
"created":"2018-02-01T08:00:00.000000Z",
"end_line":0,
"event":"",
"event_data":{
},
"event_display":"",
"event_level":0,
"failed":false,
"host_name":"localhost",
"id":4,
"modified":"2018-02-01T08:00:00.000000Z",
"play":"",
"playbook":"",
"project_update":1,
"related":{
"project_update":"/api/v2/project_updates/1/"
},
"role":"",
"start_line":0,
"stdout":"",
"summary_fields":{
"project_update":{
"description":"test-proj-desc",
"failed":false,
"id":1,
"name":"test-proj",
"status":"new"
},
"role":{
}
},
"task":"",
"type":"project_update_event",
"url":"",
"uuid":"",
"verbosity":0
},
{
"changed":false,
"counter":0,
"created":"2018-02-01T08:00:00.000000Z",
"end_line":0,
"event":"",
"event_data":{
},
"event_display":"",
"event_level":0,
"failed":false,
"host_name":"localhost",
"id":5,
"modified":"2018-02-01T08:00:00.000000Z",
"play":"",
"playbook":"",
"project_update":1,
"related":{
"project_update":"/api/v2/project_updates/1/"
},
"role":"",
"start_line":0,
"stdout":"",
"summary_fields":{
"project_update":{
"description":"test-proj-desc",
"failed":false,
"id":1,
"name":"test-proj",
"status":"new"
},
"role":{
}
},
"task":"",
"type":"project_update_event",
"url":"",
"uuid":"",
"verbosity":0
},
{
"changed":false,
"counter":0,
"created":"2018-02-01T08:00:00.000000Z",
"end_line":0,
"event":"",
"event_data":{
},
"event_display":"",
"event_level":0,
"failed":false,
"host_name":"localhost",
"id":6,
"modified":"2018-02-01T08:00:00.000000Z",
"play":"",
"playbook":"",
"project_update":1,
"related":{
"project_update":"/api/v2/project_updates/1/"
},
"role":"",
"start_line":0,
"stdout":"",
"summary_fields":{
"project_update":{
"description":"test-proj-desc",
"failed":false,
"id":1,
"name":"test-proj",
"status":"new"
},
"role":{
}
},
"task":"",
"type":"project_update_event",
"url":"",
"uuid":"",
"verbosity":0
},
{
"changed":false,
"counter":0,
"created":"2018-02-01T08:00:00.000000Z",
"end_line":0,
"event":"",
"event_data":{
},
"event_display":"",
"event_level":0,
"failed":false,
"host_name":"localhost",
"id":7,
"modified":"2018-02-01T08:00:00.000000Z",
"play":"",
"playbook":"",
"project_update":1,
"related":{
"project_update":"/api/v2/project_updates/1/"
},
"role":"",
"start_line":0,
"stdout":"",
"summary_fields":{
"project_update":{
"description":"test-proj-desc",
"failed":false,
"id":1,
"name":"test-proj",
"status":"new"
},
"role":{
}
},
"task":"",
"type":"project_update_event",
"url":"",
"uuid":"",
"verbosity":0
}
]
}