プロジェクトの取得
get
/api/v2/projects/{id}/
このリソースに対してGETリクエストを行って、次のフィールドを含む単一のプロジェクト・レコードを取得します。
id: このプロジェクトのデータベースID。(整数)type: このプロジェクトのデータ型。(選択)url: このプロジェクトのURL。(文字列)related: 関連リソースのURLを含むデータ構造。(オブジェクト)summary_fields: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)created: このプロジェクトが作成されたときのタイムスタンプ。(日時)modified: このプロジェクトが最後に変更されたときのタイムスタンプ。(日時)name: このプロジェクトの名前。(文字列)description: このプロジェクトのオプションの説明。(文字列)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: プロジェクト更新によってフェッチされた最後のリビジョン(文字列)last_job_run: (日時)last_job_failed: (ブール)next_job_run: (日時)status: (選択)new: 新規pending: 保留中waiting: 待機中running: 実行中successful: 成功failed: 失敗error: エラーcanceled: 取消し済never updated: 更新なしok: OKmissing: 不明
organization: このテンプレートへのアクセス権を決定するために使用される組織。(id)scm_update_on_launch: プロジェクトを使用するジョブが起動されたときにプロジェクトを更新します。(ブール)scm_update_cache_timeout: 最後のプロジェクト更新が実行された何秒後に、新しいプロジェクト更新がジョブの依存関係として起動されるか。(整数)allow_override: このプロジェクトを使用するジョブ・テンプレートでSCMブランチまたはリビジョンの変更を許可します。(ブール)custom_virtualenv: 使用するカスタムPython virtualenvを含むローカルの絶対ファイル・パス(文字列)default_environment: このプロジェクトを使用して実行されるジョブのデフォルト実行環境。(id)last_update_failed: (ブール)last_updated: (日時)
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
問合せパラメータ
- search(オプション): 文字列
検索条件。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
レスポンスの例(application/json)
{
"allow_override":false,
"created":"2018-02-01T08:00:00.000000Z",
"credential":null,
"custom_virtualenv":null,
"default_environment":null,
"description":"manual-proj-desc",
"id":1,
"last_job_failed":false,
"last_job_run":null,
"last_update_failed":false,
"last_updated":null,
"local_path":"_92__test_proj",
"modified":"2018-02-01T08:00:00.000000Z",
"name":"test-manual-proj",
"next_job_run":null,
"organization":1,
"related":{
"access_list":"/api/v2/projects/1/access_list/",
"activity_stream":"/api/v2/projects/1/activity_stream/",
"copy":"/api/v2/projects/1/copy/",
"inventory_files":"/api/v2/projects/1/inventories/",
"notification_templates_error":"/api/v2/projects/1/notification_templates_error/",
"notification_templates_started":"/api/v2/projects/1/notification_templates_started/",
"notification_templates_success":"/api/v2/projects/1/notification_templates_success/",
"object_roles":"/api/v2/projects/1/object_roles/",
"organization":"/api/v2/organizations/1/",
"playbooks":"/api/v2/projects/1/playbooks/",
"project_updates":"/api/v2/projects/1/project_updates/",
"schedules":"/api/v2/projects/1/schedules/",
"scm_inventory_sources":"/api/v2/projects/1/scm_inventory_sources/",
"teams":"/api/v2/projects/1/teams/",
"update":"/api/v2/projects/1/update/"
},
"scm_branch":"",
"scm_clean":false,
"scm_delete_on_update":false,
"scm_refspec":"",
"scm_revision":"",
"scm_track_submodules":false,
"scm_type":"",
"scm_update_cache_timeout":0,
"scm_update_on_launch":false,
"scm_url":"",
"status":"missing",
"summary_fields":{
"object_roles":{
"admin_role":{
"description":"Can manage all aspects of the project",
"id":16,
"name":"Admin"
},
"read_role":{
"description":"May view settings for the project",
"id":19,
"name":"Read"
},
"update_role":{
"description":"May update the project",
"id":18,
"name":"Update"
},
"use_role":{
"description":"Can use the project in a job template",
"id":17,
"name":"Use"
}
},
"organization":{
"description":"test-org-desc",
"id":1,
"name":"test-org"
},
"user_capabilities":{
"copy":false,
"delete":true,
"edit":true,
"schedule":false,
"start":false
}
},
"timeout":0,
"type":"project",
"url":"/api/v2/projects/1/"
}