ワークフロー・ジョブ・テンプレートのアクティビティ・ストリームのリスト
get
/api/v2/workflow_job_templates/{id}/activity_stream/
このリソースに対してGETリクエストを行って、選択したワークフロー・ジョブ・テンプレートに関連付けられたアクティビティ・ストリームのリストを取得します。
結果のデータ構造には次が含まれます。
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
count
フィールドは、対象となる問合せで見つかったアクティビティ・ストリームの合計数を示します。 next
フィールドとprevious
フィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。 results
リストには、0個以上のアクティビティ・ストリーム・レコードが含まれます。
結果
それぞれのアクティビティ・ストリーム・データ構造には次のフィールドが含まれます。
id
: このアクティビティ・ストリームのデータベースID。(整数)type
: このアクティビティ・ストリームのデータ型。(選択)url
: このアクティビティ・ストリームのURL。(文字列)related
: 関連リソースのURLを含むデータ構造。(オブジェクト)summary_fields
: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)timestamp
: (日時)operation
: 対象となるオブジェクトに対して実行されたアクション。(選択)create
: エンティティの作成update
: エンティティの更新delete
: エンティティの削除associate
: エンティティを別のエンティティに関連付けdisassociate
: エンティティと別のエンティティの関連付けを解除
changes
: オブジェクトが作成、更新または削除された場合の新しい値と変更された値のサマリー(json)object1
: create、updateおよびdeleteイベントの場合、これは影響を受けたオブジェクト・タイプです。 associateおよびdisassociateイベントの場合、これはobject2に関連付けられたオブジェクト・タイプか、関連付けが解除されたオブジェクト・タイプです。(文字列)object2
: create、updateおよびdeleteイベントの場合、移入されません。 associateおよびdisassociateイベントの場合、これはobject1が関連付けられるオブジェクト・タイプです。(文字列)object_association
: 存在する場合は、変更されたロールまたはリレーションシップのフィールド名が表示されます。(フィールド)action_node
: アクティビティが実行されたクラスタ・ノード。(文字列)object_type
: 存在する場合は、ロールまたはリレーションシップの定義の基礎となったモデルが表示されます。(フィールド)
ソート
アクティビティ・ストリームが特定の順序で返されるように指定するには、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(オプション): 整数
ページ区切りが設定された結果セット内のページ番号。
- page_size(オプション): 整数
ページごとに返す結果の数。
- search(オプション): 文字列
検索条件。