プロジェクト更新のリスト
get
/api/v2/project_updates/
このリソースに対して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: このプロジェクト更新のオプションの説明。(文字列)unified_job_template: (id)launch_type: (選択)manual: 手動relaunch: 再起動callback: コールバックscheduled: スケジュール済dependency: 依存性workflow: ワークフローwebhook: Webフックsync: 同期scm: SCM更新
status: (選択)new: 新規pending: 保留中waiting: 待機中running: 実行中successful: 成功failed: 失敗error: エラーcanceled: 取消し済
execution_environment: 実行に使用されるコンテナ・イメージ。(id)failed: (ブール)started: ジョブが開始のためにキューに入れられた日時。(日時)finished: ジョブの実行が終了した日時。(日時)canceled_on: 取消しリクエストが送信された日時。(日時)elapsed: ジョブが実行された経過時間(秒)。(10進)job_explanation: stdoutを実行および取得できなかった場合のジョブの状態を示すステータス・フィールド(文字列)execution_node: ジョブが実行されたノード。(文字列)launched_by: (フィールド)work_unit_id: このジョブに関連付けられた受信者作業ユニットID。(文字列)local_path: このプロジェクトのプレイブックおよび関連ファイルを含む(PROJECTS_ROOTに対して相対的な)ローカル・パス。(文字列)scm_type: プロジェクトを格納するために使用するソース・コントロール・システムを指定します。(選択)"": 手動git: Gitsvn: Subversioninsights: Red Hat Insightsarchive: リモート・アーカイブ
scm_url: プロジェクトが格納される場所。(文字列)scm_branch: チェックアウトする特定のブランチ、タグまたはコミット。(文字列)scm_refspec: gitプロジェクトについて、フェッチする追加のrefspec。(文字列)scm_clean: プロジェクトを同期化する前にローカルの変更を破棄します。(ブール)scm_track_submodules: 定義済ブランチでサブ・モジュールの最新コミットを追跡します。(ブール)scm_delete_on_update: 同期化する前にプロジェクトを削除します。(ブール)credential: (id)timeout: タスクが取り消されるまでの実行時間(秒)。(整数)scm_revision: 対象となるプロジェクトおよびブランチについてこの更新によって検出されたSCMリビジョン。(文字列)project: (id)job_type: (選択)run: 実行check: チェック
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
( 「Oracle Linux Automation Manaerに追加」)関連フィールド全体を検索します:
?related__search=findme
リクエスト
サポートされているメディア・タイプ
- application/json
問合せパラメータ
- page(オプション): 整数
ページ区切りが設定された結果セット内のページ番号。
- page_size(オプション): 整数
ページごとに返す結果の数。
- search(オプション): 文字列
検索条件。